summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEvan Read <eread@gitlab.com>2019-09-05 11:06:19 +1000
committerEvan Read <eread@gitlab.com>2019-09-05 11:06:19 +1000
commit42218bc66a2645490448208b4ab9015f05279a63 (patch)
tree9c69103e165a7fd8cebf104d631165e8d0b76253
parent8c1f92782a5a40b0cf18b28f7cfc552be0a3cb98 (diff)
downloadgitlab-ce-docs/add-global-nav-principles.tar.gz
Review feedback implementeddocs/add-global-nav-principles
-rw-r--r--doc/development/documentation/site_architecture/global_nav.md4
-rw-r--r--doc/development/documentation/site_architecture/index.md4
2 files changed, 4 insertions, 4 deletions
diff --git a/doc/development/documentation/site_architecture/global_nav.md b/doc/development/documentation/site_architecture/global_nav.md
index da2e1c1b7bd..cb5d759d369 100644
--- a/doc/development/documentation/site_architecture/global_nav.md
+++ b/doc/development/documentation/site_architecture/global_nav.md
@@ -36,7 +36,7 @@ Documentation pages can be said to belong in the following groups:
- GitLab administrators. This tends to be documentation for self-managed instances that requires
access to the underlying infrastructure hosting GitLab.
- Other documentation. This includes documentation for customers outside their day-to-day use of
- GitLab and for contributors. Documentation that doesn't fit in the other groups belong here.
+ GitLab and for contributors. Documentation that doesn't fit in the other groups belongs here.
With these groups in mind, the following are general rules for where new items should be added.
@@ -47,7 +47,7 @@ With these groups in mind, the following are general rules for where new items s
the top-level, but care must be taken not to overwhelm that top-level space. If possible, such
features could be grouped in some way.
- Outside the above, most other miscellaneous user documentation belongs under **User**.
-- Administration documentation belongs under **Administrators**.
+- Administration documentation belongs under **Administrator**.
- Other documentation belongs at the top-level, but care must be taken to not create an enormously
long top-level navigation, which defeats the purpose of it.
diff --git a/doc/development/documentation/site_architecture/index.md b/doc/development/documentation/site_architecture/index.md
index 3c48a700817..bb598906967 100644
--- a/doc/development/documentation/site_architecture/index.md
+++ b/doc/development/documentation/site_architecture/index.md
@@ -68,9 +68,9 @@ the GitLab Documentation website.
## Global navigation
-Read through the global navigation](global_nav.md) documentation to understand how:
+Read through the global navigation](global_nav.md) documentation to understand:
-- The global navigation is built.
+- How the global navigation is built.
- How to add new navigation items.
## Deployment