diff options
Diffstat (limited to 'doc/development/documentation/site_architecture/global_nav.md')
| -rw-r--r-- | doc/development/documentation/site_architecture/global_nav.md | 22 |
1 files changed, 19 insertions, 3 deletions
diff --git a/doc/development/documentation/site_architecture/global_nav.md b/doc/development/documentation/site_architecture/global_nav.md index 71020e6054e..2625fbe0415 100644 --- a/doc/development/documentation/site_architecture/global_nav.md +++ b/doc/development/documentation/site_architecture/global_nav.md @@ -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 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 All new pages need a new navigation item. Without a navigation, the page becomes "orphaned". That @@ -98,7 +114,7 @@ for clarity. To see the improvements planned, check the [global nav epic](https://gitlab.com/groups/gitlab-com/-/epics/21). -CAUTION: **Attention!** +NOTE: **Note:** **Do not** [add items](#adding-new-items) to the global nav without the consent of one of the technical writers. @@ -275,7 +291,7 @@ and the following syntax rules. an "information" icon on the nav to make the user aware that the feature is EE-only. -DANGER: **Important!** +CAUTION: **Caution:** All links present on the data file must end in `.html`, not `.md`. Do not start any relative link with a forward slash `/`. @@ -290,7 +306,7 @@ Examples: docs: - doc_title: Service Desk doc_url: 'user/project/service_desk.html' - ee_only: true + ee_only: false # note that the URL above ends in html and, as the # document is EE-only, the attribute ee_only is set to true. ``` |