Skip to content

Replace NOTE with FLAG in doc guide

Craig Norris requested to merge docs-feature-flag-no-note into master

What does this MR do?

This MR makes several updates to the feature flag style docs, including:

  • (Primary change) Replaces NOTE with FLAG, based on gitlab-docs!2007 (merged).
  • Changes the metadata to indicate that this is a Style Guide-related page.
  • Updates the spacing in the tables for readability.

Related to gitlab-docs#1064 (closed)

Related MRs

Author's checklist

To avoid having this MR be added to code verification QA issues, don't add these labels: feature, frontend, backend, ~"bug", or database

Review checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.
Edited by Craig Norris

Merge request reports

Loading