Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2022-10-22 00:10:20 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2022-10-22 00:10:20 +0300
commit798e0b592009fc6613117d7e127092fc650ee48b (patch)
treedaec30772706a1ffb47fadf01db9b6fed1486d3f /doc/development/documentation/topic_types
parentc742109766862e8a7e105c3101c50d73c46e27b1 (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.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/doc/development/documentation/topic_types/troubleshooting.md b/doc/development/documentation/topic_types/troubleshooting.md
index 3a6329e0adc..0fb36554995 100644
--- a/doc/development/documentation/topic_types/troubleshooting.md
+++ b/doc/development/documentation/topic_types/troubleshooting.md
@@ -6,7 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
# Troubleshooting topic type
-Troubleshooting topics should be the last topics on a page.
+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.
@@ -54,3 +54,13 @@ For the heading of a **Troubleshooting reference** topic:
- Use fewer than 70 characters.
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.
+```