diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-12-13 21:16:51 +0300 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-12-13 21:16:51 +0300 |
| commit | 46e1fdb8bbdaf149371334f1a1757ba4d68fe020 (patch) | |
| tree | c2a0bd6da129d9d41cef38e7a6c0efd2c79de893 /doc/development/documentation/topic_types | |
| parent | 57ed4c594d37326f1d27752df575b581c522ab05 (diff) | |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/documentation/topic_types')
| -rw-r--r-- | doc/development/documentation/topic_types/troubleshooting.md | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/development/documentation/topic_types/troubleshooting.md b/doc/development/documentation/topic_types/troubleshooting.md index 842ef913fc3..aee5bd1377c 100644 --- a/doc/development/documentation/topic_types/troubleshooting.md +++ b/doc/development/documentation/topic_types/troubleshooting.md @@ -49,7 +49,7 @@ For example, "Run debug tools" or "Verify syntax." ### Troubleshooting reference -This topic includes the error message. For example: +This topic includes the error message. To be consistent, use **workaround** for temporary solutions and **resolution** and **resolve** for permanent solutions. For example: ```markdown ### The error message or a description of it @@ -61,9 +61,11 @@ This issue occurs when... The workaround is... ``` -If multiple causes or workarounds exist, consider putting them into a table format. +If multiple causes or solutions exist, consider putting them into a table format. If you use the exact error message, surround it in backticks so it's styled as code. +For more guidance on solution types, see [workaround](../../documentation/styleguide/word_list.md#workaround) and [resolution, resolve](../../documentation/styleguide/word_list.md#resolution-resolve). + ## Troubleshooting topic titles For the title of a **Troubleshooting reference** topic: |