...
Choosing a setting or toggle in the LMS Sign-up for Toggle and Settings Doc-a-thon spreadsheet:
First, prioritize documenting Toggles over Settings.
All unassigned Toggles have a yellow background on the sheet and have a value of “Toggle” in the “Toggle or Setting” column.
Only if you don’t see a Toggle that’s available for you, then sign up for a “Setting”.
Why: We have 200 Toggles and 530 Settings. We want to complete Toggles first since they:
provide an on-ramp to our deprecation/removal (DEPR) pipeline and allow Open edX operators discoverability into the various features they can turn on and off.
Next, choose a setting or toggle that matches the complexity-level you are looking for:
Most complex:
If the sign-up column
Bonus Refactorcolumn is True, there is a somewhat more complicated refactor requested (see below). If you don’t want this challenge, please choose a different toggle.
Somewhat complex:
If the sign-up column
classstarts with “Legacy”, there is some minor refactoring requested (see below). If you don’t want to do the extra refactoring, please choose a different toggle.
Optionally complex:
If you choose a
toggle setting, there is an optional refactor described below.
Easiest:
If the
modulecolumn has a value, and none of the above cases match, you should be able to quickly locate the toggle or setting.
Next, add your github username to the row to claim it as yours.
Choose any that interests you, whether you are an expert or not. If you need help from experts, just ask for help.
...