diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-12-12 00:12:34 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-12-12 00:12:34 +0300 |
commit | 6d08f67e10d01b6198daaad31b402e54bfe068e8 (patch) | |
tree | 25c1ac824c12a13b9cbc34f0cb01b2c6834efbcb /doc/development/documentation/styleguide | |
parent | 7eeb03ce0e64c30df91665524e543fe4e611c410 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/documentation/styleguide')
-rw-r--r-- | doc/development/documentation/styleguide/word_list.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/development/documentation/styleguide/word_list.md b/doc/development/documentation/styleguide/word_list.md index f4fdab99307..913683c936d 100644 --- a/doc/development/documentation/styleguide/word_list.md +++ b/doc/development/documentation/styleguide/word_list.md @@ -1436,6 +1436,17 @@ Do not use **Reporter permissions**. A user who is assigned the Reporter role ha Use title case for **Repository Mirroring**. +## resolution, resolve + +Use **resolution** when the troubleshooting solution fixes the issue permanently. +A resolution usually involves file and code changes to correct the problem. +For example: + +- To resolve this issue, update the `.gitlab-ci.yml` file. +- One resolution is to update the `.gitlab-ci.yml` file. + +See also [workaround](#workaround). + ## requirements When documenting the tasks that must be completed or the conditions that must be met before a user can complete the steps: @@ -1911,6 +1922,16 @@ Instead of: ([Vale](../testing.md#vale) rule: [`SubstitutionSuggestions.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/SubstitutionSuggestions.yml)) +## workaround + +Use **workaround** when the troubleshooting solution is a temporary fix. +A workaround is usually an immediate fix and might have ongoing issues. +For example: + +- The workaround is to temporarily pin your template to the deprecated version. + +See also [resolution](#resolution-resolve). + ## while Use **while** to refer only to something occurring in time. For example, |