openedx / openedx/edx-toggles

Complete transition from Confluence to GitHub issues

Open
#296 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
6
Forks
16
PR merge metrics
No merged PRs in 30d

Description

There are many issues noted in https://openedx.atlassian.net/wiki/spaces/AC/pages/2554331530/Toggles+and+Settings+Documentation. The higher priority issues have already been migrated to GitHub.

Additional Notes:

  • Ideally the page could be archived once this is complete.
  • As of 2023-06-24, the issues are not yet on a Project, so the priorities in the doc (for the already migrated tasks) are not yet in represented in GitHub. It would be great if that information could be handled somehow.
  • The notes that haven't yet been migrated to GitHub may be lower priority, and should either be ice-boxed (deleted/archived?) or moved to GitHub. They will need to be reviewed bullet by bullet.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked Confluence page and compare its remaining bullets with the existing GitHub issues. Review each note, migrate or archive it as appropriate, preserve the stated priorities in GitHub, and archive the Confluence page when no actionable notes remain.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.