Skip to content

Add Removals page to Docs

Brian Rhea requested to merge add-removals-page-to-docs into master

What does this MR do and why?

This MR adds a "Removals by milestone" page to the Docs.

The removals content is populated by yml files that previously only existed in the www-gitlab-com project. Those yml files have been copied over and revised to match the structure of Deprecations which have been displayed on Docs for the past several releases.

Our intention in displaying both Deprecations by milestone and Removals by milestone on Docs is to make these announcements easier for users to find compared to visiting each individual release posts and scrolling to the Deprecations or Removals section.

Why is this MR so big?

This MR contains file additions that are also present in !77191 (closed). The yml files that have been added to the data/removals directory are necessary in this MR to demonstrate the proposed changes.

If !77191 (closed) is accepted, this MR can be rebased against master and the number of new changes in this MR will be reduced.

Screenshots or screen recordings

Preview app

The preview app does not have the "Removals" link in the sidebar because that navigation menu is generated by a separate repo.

Proposed navigation links would be:

  • Deprecations by milestone
  • Removals by milestone

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

  1. Start a local version of gitlab-docs
  2. Run bundle exec rake gitlab:docs:compile_removals in this project
  3. Visit http://localhost:3000/ee/update/removals.html

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Follow-up Tasks if Approved

  • Update the steps on Removals Section of Release Post page to reflect the change to committing Removals to the gitlab project. (Same as deprecations.)
  • Update the navigation menu in gitlab-docs to include a "Removals by milestone" link

Related

Edited by Brian Rhea

Merge request reports