blob: 70475eb0ccf10220d48b6e76938ad0f2298850a5 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
|
---
stage: none
group: Style Guide
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
---
# Troubleshooting topic type
Troubleshooting topics should be the final topics on a page.
If a page has more than five troubleshooting topics, put the content on a separate page that has troubleshooting information exclusively. Name the page `Troubleshooting <feature>`
and in the left nav, use the word `Troubleshooting` only.
Troubleshooting can be one of three types.
## An introductory topic
This topic introduces the troubleshooting section of a page.
For example:
```markdown
## Troubleshooting
When working with <x feature>, you might encounter the following issues.
```
## Troubleshooting task
The title should be similar to a [standard task](task.md).
For example, "Run debug tools" or "Verify syntax."
## Troubleshooting reference
This topic includes the error message. For example:
```markdown
### The error message or a description of it
You might get an error that states <error message>.
This issue occurs when...
The workaround is...
```
If multiple causes or workarounds 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.
## Troubleshooting topic titles
For the title of a **Troubleshooting reference** topic:
- Consider including at least a partial error message.
- Use fewer than 70 characters.
- Do not use links in the title.
If you do not put the full error in the title, include it in the body text.
## Rails console write functions
If the troubleshooting suggestion includes a function that changes data on the GitLab instance,
add the following warning:
```markdown
WARNING:
Commands that change data can cause damage if not run correctly or under the right conditions. Always run commands in a test environment first and have a backup instance ready to restore.
```
|
