Skip to content
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

Merged
merged 4 commits into from
Jan 30, 2024

Conversation

Yagnesh1998
Copy link
Contributor

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.

@openedx-webhooks
Copy link

openedx-webhooks commented Jan 17, 2024

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:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jan 17, 2024
@Yagnesh1998 Yagnesh1998 marked this pull request as draft January 17, 2024 13:02
@mphilbrick211 mphilbrick211 added the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Jan 17, 2024
Copy link
Contributor

@robrap robrap left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great. Thanks.

  1. You also need to update the version to 1.6.0 and add a note to the CHANGELOG.
  2. We may hold on merging until we get the how-to docs updated as well.

@mphilbrick211 mphilbrick211 removed the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Jan 18, 2024
CHANGELOG.rst Show resolved Hide resolved
Copy link
Contributor

@robrap robrap left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @Yagnesh1998.

@robrap robrap marked this pull request as ready for review January 30, 2024 20:38
@robrap robrap merged commit 786da8c into openedx:master Jan 30, 2024
9 checks passed
@openedx-webhooks
Copy link

@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.

@Yagnesh1998 Yagnesh1998 deleted the edx-depr324 branch January 30, 2024 20:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants