Skip to content

Moving feature flag process docs to handbook

Ricky Wiens requested to merge rw/move-ff-docs-to-handbook into master

Why is this change being made?

As part of the WorkingGroupFeatureFlagUsage we discussed consolidating and deciding on a location for the feature flag documentation. We think that it might be best to keep all implementation/technical documentation in the docs site (controls.md, development.md), and move the process related documentation (index.md, process.md) into the handbook, cross linking the two. That way the SSoT for the "process" becomes the handbook, and the docs site becomes more of the implementation details.

The plan is:

gitlab-org/gitlab#249129 (comment 523228764)

Merge the cut/paste movement of the docs, then rapidly follow up with some "red pen" and trim those docs down substantially.

MRs:

  1. Docs site MR gitlab-org/gitlab!55891 (merged)
    1. process.md content moved to handbook, and becomes a redirect to the lifecycle handbook page
    2. index.md contents moved to handbook, and content replaced by development.md content
  2. Handbook MR number 1 !76630 (merged)
    1. process.md content copy/pasted to handbook page, all links fixed
    2. index.md content copy/pasted to handbook page, all links fixed
  3. gitlab-docs MR gitlab-org/gitlab-docs!1582 (merged)
    1. To remove the links in the sidebar of the docs site

Author Checklist

  • Provided a concise title for the MR
  • Added a description to this MR explaining the reasons for the proposed change, per say-why-not-just-what
  • Assign this change to the correct DRI
    • If the DRI for the page/s being updated isn’t immediately clear, then assign it to one of the people listed in the "Maintained by" section in on the page being edited.
    • If your manager does not have merge rights, please ask someone to merge it AFTER it has been approved by your manager in #mr-buddies.
    • If the changes relate to any part of the project other than updates to content and/or data files please make sure to ping @gl-static-site-editor in a comment for a review and merge. For example changes to .gitlab-ci.yml, JavaScript/CSS/Ruby code or the layout files. (this requirement has been removed pending identification of a new DRI for the handbook)

/cc @darbyfrey

Edited by Ricky Wiens

Merge request reports