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

Add toggle_removal_ticket annotation #324

Open
Tracked by #283
robrap opened this issue Nov 16, 2023 · 3 comments
Open
Tracked by #283

Add toggle_removal_ticket annotation #324

robrap opened this issue Nov 16, 2023 · 3 comments
Assignees
Labels
help wanted Ready to be picked up by anyone in the community

Comments

@robrap
Copy link
Contributor

robrap commented Nov 16, 2023

Add annotation for toggle_removal_ticket to make it simpler to know if a toggle has an associated DEPR or removal ticket.

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 #283, which listed a number of potential improvements.

@robrap robrap converted this from a draft issue Nov 16, 2023
@robrap robrap added the help wanted Ready to be picked up by anyone in the community label Nov 16, 2023
@rgraber rgraber removed this from Arch-BOM Nov 20, 2023
@Yagnesh1998
Copy link

assign me

@robrap
Copy link
Contributor Author

robrap commented Jan 2, 2024

@Yagnesh1998: Here are the steps I imagine for this ticket:

  • Add the new annotation definition for the annotation toggle_removal_ticket to feature_toggle_annotations.yaml.
    • This is mostly just adding: - ".. toggle_removal_ticket:": optional: true (using same formatting of other annotation definitions).
  • Update how-to documentation with instructions on how to use the annotation toggle_removal_ticket.
    • See description for documentation notes.
  • Lastly, we need to start using this new annotation in the annotation documentation for existing toggles:
    • We could search for toggles with toggle_tickets annotation and toggle_use_cases: temporary?
      • If the toggle_tickets includes a removal ticket on github (e.g. a DEPR ticket), we could remove the link from toggle_tickets and add it to toggle_removal_ticket. If toggle_tickets is now empty, we would delete it because it is optional.
      • If the toggle does not have a toggle_removal_ticket, but needs one, we could add toggle_removal_ticket: TODO.
    • We could go through each DEPR on github and search the code for the DEPR's github issue URL.

robrap pushed a commit to openedx/code-annotations that referenced this issue Jan 30, 2024
Add new toggle annotation for toggle_removal_ticket.

See openedx/edx-toggles#324
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Ready to be picked up by anyone in the community
Projects
Status: Proposed
Development

No branches or pull requests

2 participants