Skip to content

Clarify sample text for feature flags

Mike Jang requested to merge mjang-update-feature-flag-section into master

What does this MR do?

Clarify the doc style template associated with feature flags. Two elements:

  • Per Developing with feature flags, they're supposed to be disabled by default, so we should include doc guidance on how to enable them.
  • The phrase "while configuration is migrated" is confusing and should be removed.

Related issues

Author's checklist

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.

Merge request reports