Skip to content

Add a TL:DR to the Global Nav page

Mike Jang requested to merge mjang-doc-add-tldr-global-nav into master

What does this MR do?

Assumption: When creating a new entry in our doc ToCs, most readers don't need all of the information in https://docs.gitlab.com/ee/development/documentation/site_architecture/global_nav.html

So I've added a "Short version" section to the noted page, which I'm guessing will be sufficient for a majority of our reader contributors.

Related issues

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Mike Jang

Merge request reports

Loading