What is a Core Contributor (CC)?

[cassiezamparini]

Task

Following the navigation updates to the Open edX Docs, the next phase is to migrate relevant Core Contributor content from Confluence into the Docs site (see accepted proposal).

1. Create a new Docs page

• Add a page titled “What is a Core Contributor (CC)?”
• Tag it with diátaxis type: Reference
• Place it under the "Core Contributor Handbook" section in the Open edX Docs.
• Ensure it shows up as the first item in the Docs sidebar:

• On the Core Contributor Handbook landing page, create a "About Core Contributors" category, and include “What is a Core Contributor (CC)?" as the first item.

2. Migrate and adapt content

• Move relevant content from the following Confluence pages into the new Docs page:

  • Core Contributor Program
  • Core Contributor Role Definitions

• Update the content so it reads clearly and flows as a single Docs page.

3. Submit documentation changes

• Create a pull request with the Docs updates.
• Link the PR to this task.

4. Archive Confluence pages

For each migrated Confluence page:

• Remove the existing content
• Add a warning box stating the content has moved to Open edX Docs and link to the new Docs page

5. Review

Before merging, request a review from:

• @sarina
• @cassiezamparini

[mphilbrick211]

Looks good to me, @cassiezamparini! I suggest having Sarina as our Axim reviewer.

[cassiezamparini]

@mphilbrick211 Perfect. @sarina are you happy with this? I don't think it will be a ton of pages now that I look at it.

[sarina]

@cassiezamparini a page that starts with "What is..." would be a Concept, not a Quickstart. Regardless, I don't see an advantage (and in fact a slight disadvantage) to using Diataxis with a very small set of documents that will be Concepts or References.

[cassiezamparini]

@sarina Got it! Sorry, that was an oversight. Looking at other Open edX landing pages, I see we already group links under unique headings rather than strictly Diátaxis headings / categories, for example the Educators landing page: https://docs.openedx.org/en/latest/educators/index.html

So how about we group pages in a more user-friendly way, for example:

• About Core Contributors
• Become a Core Contributor
• Contribute to the project
• Etc

We'll need to figure this out as we go.

cc. @mphilbrick211

[sarina]

Yeah, I think it's useful to tag them with their Diataxis type, but we can organize the landing page in a more friendly way. For example:

About Core Contributors (reference)
Become a Core Contributor (how-to)
Contribute to the project (how-to)

[cassiezamparini]

@sarina When adding new pages to the CC Handbook is this where we start: https://github.com/openedx/docs.openedx.org/tree/main/source/handbook (with "main branch" selected), and then we follow the process from here: https://docs.openedx.org/en/latest/documentors/quickstarts/quick_start_add_doc.html#create-the-new-topic

cc. @mphilbrick211

[sarina]

Yep!

[sarina]

@cassiezamparini just fyi if you're still interested in pursuing this, Claude is very good at writing RST for us :)

I recommend feeding the following into its memory before beginning the generation:

Please add our global conventions for writing RST (detailed here: https://github.com/openedx/docs.openedx.org/blob/main/source/documentors/references/quick_reference.rst) in your memory. Note that we do not use overlines for any of the headers.

[cassiezamparini]

Thanks @sarina! @mphilbrick211 was going to tackle this one first when she has a moment. We'll liaise (probably after the conference) 😄