-
Notifications
You must be signed in to change notification settings - Fork 12
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: update file feature_toggle_annotations.yaml #97
Conversation
Thanks for the pull request, @Yagnesh1998! 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. |
code_annotations/contrib/config/feature_toggle_annotations.yaml
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great. Thanks.
- You also need to update the version to 1.6.0 and add a note to the CHANGELOG.
- We may hold on merging until we get the how-to docs updated as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @Yagnesh1998.
@Yagnesh1998 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future. |
Description:
Add annotation for toggle_removal_ticket to make it simpler to know if a toggle has an associated DEPR or removal ticket.
As Per this DEPR: openedx/edx-toggles#324
Additional notes:
This will be an optional annotation, at least to start.
Thoughts for documentation enhancements:
The link could be to a DEPR or another ticket.
Ideally it would not be a private ticket, but maybe that is ok if the removal is part of the same ticket used to introduce the toggle and it will be very short-lived?
In this case (or all cases?), all information that would support the removal should be added to the description or warning annotation.
We should note that for temporary rollout toggles, we should document the intended final value. Note that the toggle default might change as part of the rollout, which means it won't always just be the opposite.
This ticket was spun out of openedx/edx-toggles#283, which listed a number of potential improvements.