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-11-14 18:09:52 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2023-11-14 18:09:52 +0300
commit15c1cc886c5785d49f2a6dae064a1e8290f59f46 (patch)
treeda963cc8eef2a57f70ca325430b59f91191804ba /doc/development/documentation/topic_types
parent3a19c55d3a1dda9e0ea041d910bf31d1ddda7acd (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.md2
-rw-r--r--doc/development/documentation/topic_types/get_started.md92
-rw-r--r--doc/development/documentation/topic_types/index.md2
-rw-r--r--doc/development/documentation/topic_types/reference.md4
-rw-r--r--doc/development/documentation/topic_types/task.md2
-rw-r--r--doc/development/documentation/topic_types/troubleshooting.md2
6 files changed, 102 insertions, 2 deletions
diff --git a/doc/development/documentation/topic_types/concept.md b/doc/development/documentation/topic_types/concept.md
index 50220b9bebe..3c83922af38 100644
--- a/doc/development/documentation/topic_types/concept.md
+++ b/doc/development/documentation/topic_types/concept.md
@@ -19,6 +19,8 @@ Don't tell them **how** to do this thing. Tell them **what it is**.
If you start describing another concept, start a new concept and link to it.
+## Format
+
Concepts should be in this format:
```markdown
diff --git a/doc/development/documentation/topic_types/get_started.md b/doc/development/documentation/topic_types/get_started.md
new file mode 100644
index 00000000000..e34ddb9fede
--- /dev/null
+++ b/doc/development/documentation/topic_types/get_started.md
@@ -0,0 +1,92 @@
+---
+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
+---
+
+# Get started page type
+
+A **Get started** page is meant to introduce high-level concepts for a broad feature area.
+While a specific feature might be defined in the feature documentation,
+a **Get started** page is meant to give an introduction to a set of concepts.
+When you group the concepts together, you help the user see how they fit together.
+
+A **Get started** page should familiarize the reader with terms and then quickly
+point them to actions they can take to get started. Hopefully the actions are
+task-based, but the next step can also be to learn more.
+
+## When to use a Get started page
+
+A **Get started** page should be used only for a larger concept,
+like CI/CD or security. In general, we describe features in concept topics.
+However, if you find you want to explain how multiple concepts fit together,
+then a **Get started** page might be what you need.
+
+To determine if a **Get started** page makes sense, make a list
+of the common terms you expect to include. If you have more than four or five,
+then this page type might make sense.
+
+A **Get started** page is different from a tutorial. It's conceptual, while
+a tutorial helps the user achieve a task. A **Get started** page should point
+to tutorials, however, because tutorials are a great way for a user to get started.
+
+## Format
+
+Get started pages should be in this format:
+
+```markdown
+# Get started with abc
+
+Abc is a thing you use to do xyz. You might use it when you need to blah,
+and it can be helpful for etc.
+
+## Common terms
+
+If you're new to abc, start by reviewing some of the most commonly used terms.
+
+### First term
+
+This thing is this. Describe what it is, not how to do it.
+
+**Get started:**
+
+- [Create your first abc](LINK).
+- [Learn more about abc](LINK).
+
+### Second term
+
+This thing is this. Describe what it is, not how to do it.
+
+**Get started:**
+
+- [Create your first abc](LINK).
+- [Learn more about abc](LINK).
+
+## Videos
+
+- [Video 1](LINK).
+- [Video 2](LINK).
+
+## Related topics
+
+- [Link 1](LINK).
+- [Link 2](LINK).
+```
+
+- Follow [the video guidance](../styleguide/index.md#link-to-video)
+ for the links in the Video topic.
+- Do not use links inline with content (as part of sentences).
+ Use them where links are specified only.
+- The terms described on this page can exist elsewhere in the docs.
+ However, the term descriptions on this page should be relatively brief.
+
+## Get started page titles
+
+For the title, use `Get started with topic_name`.
+
+For the left nav, use `Getting started`.
+
+## Example
+
+For an example of the Get started page type,
+see [Get started with GitLab CI/CD](../../../ci/index.md).
diff --git a/doc/development/documentation/topic_types/index.md b/doc/development/documentation/topic_types/index.md
index 10e7e3d2014..d7a12c053e6 100644
--- a/doc/development/documentation/topic_types/index.md
+++ b/doc/development/documentation/topic_types/index.md
@@ -24,6 +24,7 @@ The acronym refers to the first letter of each topic type.
In addition to the four primary topic types, you can use the following:
- Page type: [Tutorials](tutorial.md)
+- Page type: [Get started](get_started.md)
- Topic type: [Related topics](#related-topics)
- Page or topic type: [Glossaries](glossary.md)
@@ -36,7 +37,6 @@ You should avoid:
- Topics that have one or two sentences only. In these cases:
- Incorporate the information in another topic.
- If the sentence links to another page, use a [Related topics](#related-topics) link instead.
-- Get started topics. To document a procedure for a single feature, use a [task](task.md). For a set of steps, use a [tutorial](tutorial.md).
## Topic title guidelines
diff --git a/doc/development/documentation/topic_types/reference.md b/doc/development/documentation/topic_types/reference.md
index ef2ca2f791d..0b3e59eb08c 100644
--- a/doc/development/documentation/topic_types/reference.md
+++ b/doc/development/documentation/topic_types/reference.md
@@ -9,6 +9,10 @@ info: To determine the technical writer assigned to the Stage/Group associated w
Reference information should be in an easily-scannable format,
like a table or list. It's similar to a dictionary or encyclopedia entry.
+## Format
+
+Reference topics should be in this format:
+
```markdown
# Title (a noun, like "Pipeline settings" or "Administrator options")
diff --git a/doc/development/documentation/topic_types/task.md b/doc/development/documentation/topic_types/task.md
index a6e4c01505d..1a4b472aeda 100644
--- a/doc/development/documentation/topic_types/task.md
+++ b/doc/development/documentation/topic_types/task.md
@@ -8,6 +8,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w
A task gives instructions for how to complete a procedure.
+## Format
+
Tasks should be in this format:
```markdown
diff --git a/doc/development/documentation/topic_types/troubleshooting.md b/doc/development/documentation/topic_types/troubleshooting.md
index a2fe6f8ca2d..f853a0bf34e 100644
--- a/doc/development/documentation/topic_types/troubleshooting.md
+++ b/doc/development/documentation/topic_types/troubleshooting.md
@@ -25,7 +25,7 @@ If you think you have an exception to this rule, contact the Technical Writing t
GitLab Support maintains their own
[troubleshooting content](../../../administration/troubleshooting/index.md).
-## Troubleshooting topic types
+## Format
Troubleshooting can be one of three types: introductory, task, or reference.