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>2023-01-06 00:10:21 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2023-01-06 00:10:21 +0300
commitfa138c9c2443f5e703ba017ff4104569871cc410 (patch)
tree810475960a536eaafc9c3b303efce401081c3fce /doc/development/documentation/topic_types
parentd66704a6c6edbfaf3f8652c934c8ad2356c7d07b (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/concept.md15
1 files changed, 9 insertions, 6 deletions
diff --git a/doc/development/documentation/topic_types/concept.md b/doc/development/documentation/topic_types/concept.md
index e01b06c2c07..66af8780b9b 100644
--- a/doc/development/documentation/topic_types/concept.md
+++ b/doc/development/documentation/topic_types/concept.md
@@ -10,8 +10,8 @@ A concept introduces a single feature or concept.
A concept should answer the questions:
-- What is this?
-- Why would you use it?
+- **What** is this?
+- **Why** would you use it?
Think of everything someone might want to know if they've never heard of this concept before.
@@ -24,12 +24,15 @@ Concepts should be in this format:
```markdown
# Title (a noun, like "Widgets")
-A paragraph that explains what this thing is.
+A paragraph or two that explains what this thing is and why you would use it.
-Another paragraph that explains what this thing is.
+If you start to describe another concept, stop yourself.
+Each concept should be about **one concept only**.
-Remember, if you start to describe about another concept, stop yourself.
-Each concept should be about one concept only.
+If you start to describe **how to use the thing**, stop yourself.
+Task topics explain how to use something, not concept topics.
+
+Do not include links to related tasks. The navigation provides links to tasks.
```
## Concept topic titles