Skip to content

Docs: refactor FF dev docs

Marcia Ramos requested to merge docs-ff-dev-refactor into master

What does this MR do?

Improves the documentation for describing features behind flags:

  • Add warning saying that features behind flags can be unavailable
  • Don't say anything about per-project FF, unless they can be in fact enabled per project
  • Add user (brief) doc explaining what is a feature behind a flag
  • Add stage metadata to FF docs

Related issues

Closes #233368 (closed), #229265 (closed), #227806 (closed), #225491 (closed)

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

  • 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