/
Arch Lunch May 11 2017

Arch Lunch May 11 2017

May 11, 2017

  • 3 different types of documents

    • User-facing docs

    • Developer docs

    • Operator docs

  • Developer doc objectives

    • Lightweight - so not extra barriers to writing

    • Discoverable

  • Doc team can help with providing a common template

  • Overall Index

    • We currently have 3+ different high-level indices in Confluence and Read-the-Docs

  • Decisions to make:

    • Format: RST files or Confluence

    • Location: Co-located within Repo or together with other docs

    • Overall Index; Site location

    • Channels?

  • Ideas:

    • Local docs directories with links to elsewhere or native RST files

    • Sphinx already supports publishing of comments/etc.

    • (Google docs) → Wiki → OEP (in RST)

  • What can we rule out?

    • Google docs 

      • just for internal and as a scratchpad going forward

      • for open edx contributors, request them to create wiki pages

    • Github wiki

      • need to disable this