summaryrefslogtreecommitdiff
path: root/doc/development/documentation/styleguide
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2023-03-09 15:08:13 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2023-03-09 15:08:13 +0000
commit0a353a9fa386ad60374daa9bad56f41bb5491c33 (patch)
tree7e51c83535577744e3daccdcd4017069a5d6bb7a /doc/development/documentation/styleguide
parent0c1344a7c19635e387e6f7af20591ad73f46ddff (diff)
downloadgitlab-ce-0a353a9fa386ad60374daa9bad56f41bb5491c33.tar.gz
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/documentation/styleguide')
-rw-r--r--doc/development/documentation/styleguide/index.md12
-rw-r--r--doc/development/documentation/styleguide/word_list.md11
2 files changed, 19 insertions, 4 deletions
diff --git a/doc/development/documentation/styleguide/index.md b/doc/development/documentation/styleguide/index.md
index 74437ea46c9..7f69a1f0d54 100644
--- a/doc/development/documentation/styleguide/index.md
+++ b/doc/development/documentation/styleguide/index.md
@@ -779,14 +779,18 @@ As much as possible, use text that follows one of these patterns:
For example:
-- `For more information, see [merge requests](../../../user/project/merge_requests/index.md).`
-- `To create a review app, see [review apps](../../../ci/review_apps/index.md).`
+- `For more information, see [merge requests](LINK).`
+- `To create a review app, see [review apps](LINK).`
You can expand on this text by using phrases like
`For more information about this feature, see...`
-Do not to use alternate phrases, like `Learn more about...` or
-`To read more...`.
+Do not to use the following constructions:
+
+- `Learn more about...`
+- `To read more...`.
+- `For more information, see the [Merge requests](LINK) page.`
+- `For more information, see the [Merge requests](LINK) documentation.`
#### Descriptive text rather than `here`
diff --git a/doc/development/documentation/styleguide/word_list.md b/doc/development/documentation/styleguide/word_list.md
index 6d75c4059d9..b74c97d0eba 100644
--- a/doc/development/documentation/styleguide/word_list.md
+++ b/doc/development/documentation/styleguide/word_list.md
@@ -944,6 +944,17 @@ An Owner is the highest role a user can have.
Use title case for the GitLab Package Registry.
+## page
+
+If you write a phrase like, "On the **Issues** page," ensure steps for how to get to the page are nearby. Otherwise, people might not know what the **Issues** page is.
+
+The page name should be visible in the UI at the top of the page.
+If it is not, you should be able to get the name from the breadcrumb.
+
+The docs should match the case in the UI, and the page name should be bold. For example:
+
+- On the **Test cases** page, ...
+
## permissions
Do not use [**roles**](#roles) and **permissions** interchangeably. Each user is assigned a role. Each role includes a set of permissions.