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

Implement ADR on toggle-life-expectancy #284

Open
8 tasks
Tracked by #283
robrap opened this issue Jun 29, 2023 · 3 comments
Open
8 tasks
Tracked by #283

Implement ADR on toggle-life-expectancy #284

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

Comments

@robrap
Copy link
Contributor

robrap commented Jun 29, 2023

This ticket is for implementing ADR 0005-toggle-life-expectancy.rst. Please review for details.

Implementation/rollout details:

  • Introduce toggle_life_expectancy annotation with values of "temporary" or "permanent" as optional.
  • Introduce toggle_permanent_justification as a free-form annotation as optional.
  • Legacy toggle_use_cases annotation should be made optional (until removed).
  • Update how-to document toggles as appropriate.
  • Update existing annotated toggles with these new annotations. See additional notes for details.
  • Make toggle_permanent_justification required for "permanent" toggles.
  • Make toggle_target_removal_date required for the new definition of "temporary" toggles, and no longer for the old definition.
  • Update OEP-17 as appropriate or create separate ticket. See additional notes.

Additional Notes:

  • This requires working in the code-annotations config, toggles code and docs, toggle linting, and other repos containing annotated toggles.
    • Could this help be moved to a toggle doc?
  • When adding the new annotations, there are a number of adjustments we may want to make at once.
    • We may need to relax linting rules first. When we do this, we may want to move faster on this part.
    • Use of None or 'n/a' should be avoided. For optional annotations, they should just be removed instead.
    • If marking a toggle as "temporary", we should note ensure there is a toggle_target_removal_date. If there is none, we could just add 3 months from the time of this PR, and note in the commit that we have filled these all in.
    • If marking a toggle as "permanent", but we are unsure, see ADR for language for toggle_permanent_justification. Could be something like: Tentatively marking as permanent. A DEPR could be used to confirm.
    • See https://openedx.atlassian.net/wiki/spaces/AC/pages/2554331530/Toggles+and+Settings+Documentation for other clean-up notes.
  • The how-to document toggles doc might need multiple updates, unless the initial update pretends like annotation requirements are complete.
    • Additionally, the ADR has other notes about how to help people fill in the new annotations.
  • Note that OEP-17 is outdated in other ways from these docs.
  • This would resolve a possible bug where required fields for temporary use case might be missed when multiple use cases are listed.
@robrap robrap added the help wanted Ready to be picked up by anyone in the community label Jul 3, 2023
@robrap
Copy link
Contributor Author

robrap commented Jul 3, 2023

Note: I'm happy to be a guide and reviewer if someone picks this up.

@Yagnesh1998
Copy link

assign me

@Yagnesh1998
Copy link

@robrap I will assign it myself and start working on it shortly after my one pending DEPR ticket will be completed is that makes sense.

@Yagnesh1998 Yagnesh1998 removed their assignment Sep 15, 2023
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: Accepted
Development

No branches or pull requests

2 participants