| Note |
|---|
This page |
...
is slowly being moved to |
...
github issues |
...
Overview
The following toggles and settings tooling potential tasks around toggles and settings tooling, was generated while working on [BD-21] Toggles/Settings Documentation, Toggles and Settings Doc-a-thon 2021, and earlier work from the Arch-BOM team.
Next Steps
...
Write announcement for value created by BD-21.
...
Cost of Delay / Prioritization of future work, when we decide to continue.
...
Potential for surveys or interviews as input to prioritization.
...
.
|
Potential Tasks
See https://docs.google.com/spreadsheets/d/1PUq0DkNJLp0SuY1Jt38n_USy1IExlACI2yZt0ZmhD8g/edit#gid=0 for initial prioritization.
Linting
...
(HIGH) DEPR improvement ideas:
Add deprecation ticket to a separate annotation for convenient filtering out during future reviews
Check
toggle_implementationannotation matches actual implementation class used when possible.No linting exists to ensure settings are annotated.
Needs brainstorming if we think this would be important.
No linting exists to ensure ConfigModels with booleans are annotated.
...
Include more annotated settings in RTD documentation.
Context:
For settings toggles we currently only capture annotations if they are in
lms/envs/common.pyorcms/envs/common.pyWe have settings annotations where the default and annotation live outside of those two files within edx-platform. See an example annotation.
We will have annotations where the default live in an external library (edx-when, or other edx owned libraries)
See some discussion and disagreements in Slack in #external-openedx-toggles-and-settings.
Potential Tickets
Discovery: How can we capture settings toggles not documented in
lms/envs/common.pyorcms/envs/common.pybut are still in the edx-platform repoAC:
Either a POC that captures settings in other places or an ADR to guide us on where these docs should live.
Discovery: How do we collect annotations from libraries installed in edx-platform?
Allow for formatting in annotations, rather than having everything be plain-text.
Consider allowing arbitrary formatted rST.
Remove pylint disable pragmas from annotation output.
All, or just
line-too-long?
RTD developer documentation single book for
edx-platformThe edx-platform toggles and settings documentation was published as a separate book as a starting point, because the rest of the edx-platform docs weren’t published.
Would be nice to fix before too many references to docs that might be moving.
CI testing for docs
edx-platform doesn’t test
make technical-docs(current toggles and settings docs)Spotty support for testingmake docsfor other repos.
Reporting on suspicious toggle state data
Examples:
Bad data like waffle names with leading or trailing spaces in the database.
Potentially orphaned data (data with no annotation and no toggle definition)
Toggle State Report may be simplest location, using a new column
...
Replace or improve
ExperimentWaffleFlag
History
The following toggles and settings tooling potential tasks around toggles and settings tooling, was generated while working on [BD-21] Toggles/Settings Documentation, Toggles and Settings Doc-a-thon 2021, and earlier work from the Arch-BOM team.