docs: document ENABLE_HIDE_FROM_TOC_UI feature toggle #34377
Conversation
openedx-webhooks
added
the
open-source-contribution
|
Thanks for the pull request, @mariajgrimaldi! Please note that it may take us up to several weeks or months to complete a review and merge your PR. Feel free to add as much of the following information to the ticket as you can:
All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here. Please let us know once your PR is ready for our review and all tests are green. |
mariajgrimaldi
force-pushed
the
MJG/hide-from-toc-toggle-docs
branch
from
e953a3b
to
91c2900
Compare
cms/envs/common.py
Outdated
| # .. toggle_implementation: DjangoSetting | ||
| # .. toggle_default: False | ||
| # .. toggle_description: When enabled, exposes hide_from_toc xblock attribute so course authors can configure it as | ||
| # a section visibility option in Studio. |
There was a problem hiding this comment.
This may need 1 more space at the beginning to parse correctly.
cms/envs/common.py
Outdated
| # a section visibility option in Studio. | ||
| # .. toggle_use_cases: open_edx | ||
| # .. toggle_creation_date: 2024-02-29 | ||
| # .. toggle_target_removal_date: None |
There was a problem hiding this comment.
This is optional.
| # .. toggle_target_removal_date: None |
| @@ -551,6 +551,17 @@ | |||
| # https://github.com/openedx/openedx-events/issues/265 | |||
| # .. toggle_tickets: https://github.com/edx/edx-arch-experiments/issues/381 | |||
| 'ENABLE_SEND_XBLOCK_LIFECYCLE_EVENTS_OVER_BUS': False, | |||
|
|
|||
| # .. toggle_name: FEATURES['ENABLE_HIDE_FROM_TOC_UI'] | |||
There was a problem hiding this comment.
Note: There is an open issue that claims an intent to deprecate the features dict in favor of top-level settings. Each time I see a new one, I’m reminded that we haven’t actually made a decision around that. This PR doesn’t necessarily need to change. FYI: @kdmccormick
There was a problem hiding this comment.
Thank you for the heads up. In the meantime, should we avoid adding new feature entries? If so, could add a message somewhere with this suggestion?
There was a problem hiding this comment.
@mariajgrimaldi: See #33026 for more details. It also discusses a potential change in naming convention as well. You are welcome to participate in that discussion. And, I do not think this PR needs to change at this time. Hopefully someday we'll have more clarity on this front.
mariajgrimaldi
force-pushed
the
MJG/hide-from-toc-toggle-docs
branch
from
f6448b1
to
efc63de
Compare
There was a problem hiding this comment.
👍 Thanks for documenting this flag @mariajgrimaldi !
-
I tested thisN/A -- docs change only. - I read through the change, and ensured it covers all the required toggle documentation fields.
-
I checked for accessibility issuesN/A - Includes documentation
-
User-facing strings are extracted for translationN/A
|
@mariajgrimaldi 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future. |
|
2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production. |
|
2U Release Notice: This PR has been deployed to the edX production environment. |
Description
This PR adds documentation for the
ENABLE_HIDE_FROM_TOC_UIfeature toggle so it can be extracted by the feature toggle sphinx plugin.