Skip to content

Proposing new process for documenting flags

Suzanne Selhorn requested to merge sselhorn-master-patch-55172 into master

What does this MR do?

This MR proposes new rules for documenting features behind feature flags. The reasons:

  • Often our feature flag information is incorrect or out-of-date.
  • More features are being developed behind flags and being released when the flag is removed, making the interim step of documenting the flag unnecessary.

The pros of this approach:

  • Fewer incorrect flag statements
  • Less work for writers/developers
  • Less confusing for customers
  • The flags are all auto-documented anyway

The cons:

  • We won't be letting people know about features they might want to know about.

Related issues

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's 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 you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • 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.
    • Ensure a release milestone is set.
    • 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 reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Suzanne Selhorn

Merge request reports