Skip to content

Clarify feature flag docs

Marcel Amirault requested to merge docs-feature-flag-update into master

What does this MR do?

I had some trouble understanding the feature flag docs, and felt that some small changes might make these a little easier to understand. The content should be mostly unchanged, but with additional details and clarifications.

Some of the changes:

  • Change some sub-sections for the creation instructions to be bulleted, because they do not have to be done in order.
  • Reorder the sections a bit, change the nesting.
  • Split the enable/disable instructions to their own section, that can then be removed later when the feature flag is gone (and it doesn't intrude on the explanations from the feature as much anymore)
  • Call the old rollout strategy "legacy" (this might not be popular, but it makes it clear it's the old style).
  • Make the Feature Flags Strategies details much clearer, by explaining how to add/change strategies, list the available strategies, make it clear which sections are specifically strategy-related, and generally expand the details.

Related issues

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by 🤖 GitLab Bot 🤖

Merge request reports

Loading