Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


  • Docs in Confluence are generally scoped and provide access rights based on the space. Spaces are either Internal (private resources to edX e.g. IT, HR, Brand) or External (open to the Open edX community e.g.) and should be clear about their audience. Additionally, we think of spaces in 2 broad categories.

    • Centralized Spaces are of broad interest across/outside the org so should be written to be understood by that broader audience. This includes spaces like:

    • Localized Spaces are for organizing focused projects/teams so are not meant to be shared/understand by those outside of the group the space is meant to serve. These include spaces like:

      • Team / squad / personal spaces

    • See Proposal: Confluence Organization for more details on how we propose organizing spaces.

  • Highest level pages in a space should help self-document the resources in the space. See Creating Index Pages for a template.

  • Every space should have an owner in charge of keeping the space clean, organized, and useful (including archiving of old pages if not granted to other editors).

  • Duplication of information should be avoided, cross link when possible. You can also /include one confluence page into another if you want the info to be seen together.

  • Archive more. Anyone stumbling across an out-of-date page should be empowered to update or archive it. Alternatively, for spaces with more restrictive archiving rights, they may request update/archive using tags proposed in Tags & Signaling.