openedx / openedx/docs.openedx.org
edX Developer Guide Transfer
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 35
- Forks
- 95
- Avg merge
- 5d 15h
- Merged PRs (30d)
- 3
Description
-
#271
-
Convert https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/architecture.html to a developer reference doc on docs.openedx.org
-
Take any useful info out of https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/process/overview.html and delete this page, linking to https://openedx.atlassian.net/wiki/spaces/COMM/pages/941457737/How+to+start+contributing+to+the+Open+edX+code+base instead.
-
Review https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/process/code-considerations.html and figure out if this is still useful and if it is, how it might live in an updated format.
-
Review https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/extending_platform/index.html and figure out how much of it is still relevant. This should probably turn into some How-Tos as well as one or more reference documents.
-
https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/testing/index.html is fully out of date, review it and see if there is any equivalent information that we still need to retain, since everything is now GitHub actions, we may not need this section at all.
-
Work with Data WG to figure out how much of https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/analytics.html is still accurate and how we should update/transfer it to either OARS or docs.openedx.org
-
https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/deploy-new-service.html is not relevant, any concerns here should be integrated into the cookiecutter templates. I think this is already the case but we should verify that.
-
https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/conventions/index.html, https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/style_guides/index.html, https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/preventing_xss/index.html, https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/process/code-considerations.html and https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/internationalization/index.html need to probably be combined into a new coding best practices section of docs.openedx.org that can be referenced by all development teams.
-
Move https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/glossary.html to the new docs site and review the terms to see if they are still relevant.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the linked edX Developer Guide pages, beginning with architecture.html, and compare them with the current docs.openedx.org structure. Identify which material should be transferred, rewritten as how-to or reference content, removed, or redirected, including the testing content now covered by GitHub Actions. Done means each checklist item has a documented disposition and any required destination or stakeholder review is recorded.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100