Commit 08963142 authored by Mike Lewis's avatar Mike Lewis

Merge branch 'mjang-doc-add-tldr-global-nav' into 'master'

Add a TL:DR to the Global Nav page

See merge request gitlab-org/gitlab!36343
parents 6216703b 0e62ecb6
...@@ -16,6 +16,22 @@ Global navigation (the left-most pane in our three pane documentation) provides: ...@@ -16,6 +16,22 @@ Global navigation (the left-most pane in our three pane documentation) provides:
- The ability to refine landing pages, so they don't have to do all the work of surfacing - The ability to refine landing pages, so they don't have to do all the work of surfacing
every page contained within the documentation. every page contained within the documentation.
## Quick start
To add a topic to the global nav, go to the directory that contains
[navigation files](https://gitlab.com/gitlab-org/gitlab-docs/blob/master/content/_data/)
and edit the `yaml` file for your product area. You can copy an existing nav entry and
edit it to point to your topic.
The files are:
| File | Document | Location |
|-----------------------|--------------------------------------------------------------------|-------------------------------------------------------|
| `charts-nav.yaml` | GitLab cloud native Helm Chart | `https://docs.gitlab.com/charts/` |
| `default-nav.yaml` | GitLab Docs | `https://docs.gitlab.com/ee/` |
| `omnibus-nav.yaml` | Omnibus GitLab Docs | `https://docs.gitlab.com/omnibus/` |
| `runner-nav.yaml` | GitLab Runner Docs | `https://docs.gitlab.com/runner/` |
## Adding new items ## Adding new items
All new pages need a new navigation item. Without a navigation, the page becomes "orphaned". That All new pages need a new navigation item. Without a navigation, the page becomes "orphaned". That
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment