Skip to content

Restructure FE documentation navigation

Frédéric Caplette requested to merge fc-restructure-frontend-nav into main

What does this MR do and why?

In context of the FE Vision Working group, we want to make our documentation easier to navigate and read through. We currently have as many as 33 entry points and it makes every section feel as important or had to know what they are about. We are now regrouping a few of them by creating 3 new categories:

  • Architecture (How to build stuff and how to use existing code)
  • Guides (How to do X)
  • Tech Stack (Guides around Vue, Vuex, Graphql, etc)

Screenshots, screen recordings, or links to review app

Before After
Screenshot_2023-09-01_at_2.11.47_PM Screenshot_2023-09-01_at_2.03.01_PM

How to set up and validate locally

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

  1. Configure a local GitLab Docs environment: https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/doc/setup.md.
  2. Navigate to /ee/development/fe_guide/
  3. Notice the new Navigation!

Merge request acceptance checklist

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

Merge request reports