diff options
Diffstat (limited to 'doc/development/documentation/topic_types')
7 files changed, 11 insertions, 11 deletions
diff --git a/doc/development/documentation/topic_types/concept.md b/doc/development/documentation/topic_types/concept.md index c9aedf940a2..50220b9bebe 100644 --- a/doc/development/documentation/topic_types/concept.md +++ b/doc/development/documentation/topic_types/concept.md @@ -1,6 +1,6 @@ --- stage: none -group: Style Guide +group: Documentation Guidelines 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 --- diff --git a/doc/development/documentation/topic_types/glossary.md b/doc/development/documentation/topic_types/glossary.md index 4985101a391..f6137953cb0 100644 --- a/doc/development/documentation/topic_types/glossary.md +++ b/doc/development/documentation/topic_types/glossary.md @@ -1,6 +1,6 @@ --- stage: none -group: Style Guide +group: Documentation Guidelines 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 --- diff --git a/doc/development/documentation/topic_types/index.md b/doc/development/documentation/topic_types/index.md index 40039ca5b1a..10e7e3d2014 100644 --- a/doc/development/documentation/topic_types/index.md +++ b/doc/development/documentation/topic_types/index.md @@ -1,6 +1,6 @@ --- stage: none -group: Style Guide +group: Documentation Guidelines 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 --- diff --git a/doc/development/documentation/topic_types/reference.md b/doc/development/documentation/topic_types/reference.md index 8bb89f4c210..ef2ca2f791d 100644 --- a/doc/development/documentation/topic_types/reference.md +++ b/doc/development/documentation/topic_types/reference.md @@ -1,6 +1,6 @@ --- stage: none -group: Style Guide +group: Documentation Guidelines 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 --- diff --git a/doc/development/documentation/topic_types/task.md b/doc/development/documentation/topic_types/task.md index 7fb4201ac40..a6e4c01505d 100644 --- a/doc/development/documentation/topic_types/task.md +++ b/doc/development/documentation/topic_types/task.md @@ -1,6 +1,6 @@ --- stage: none -group: Style Guide +group: Documentation Guidelines 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 --- diff --git a/doc/development/documentation/topic_types/troubleshooting.md b/doc/development/documentation/topic_types/troubleshooting.md index 4b23117acdb..a2fe6f8ca2d 100644 --- a/doc/development/documentation/topic_types/troubleshooting.md +++ b/doc/development/documentation/topic_types/troubleshooting.md @@ -1,6 +1,6 @@ --- stage: none -group: Style Guide +group: Documentation Guidelines 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 --- diff --git a/doc/development/documentation/topic_types/tutorial.md b/doc/development/documentation/topic_types/tutorial.md index 2d57029b786..50976149cf8 100644 --- a/doc/development/documentation/topic_types/tutorial.md +++ b/doc/development/documentation/topic_types/tutorial.md @@ -1,6 +1,6 @@ --- stage: none -group: Style Guide +group: Documentation Guidelines 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 --- @@ -25,7 +25,7 @@ In general, you might consider using a tutorial when: ideal to duplicate content that is available elsewhere, it's worse to force the reader to leave the page to find what they need. -## Tutorial file name and location +## Tutorial filename and location For tutorial Markdown files, you can either: @@ -50,9 +50,9 @@ To create a website: 1. [Do the first task](#do-the-first-task) 1. [Do the second task](#do-the-second-task) -## Prerequisites +## Before you begin -This topic is optional. +This section is optional. - Thing 1 - Thing 2 @@ -85,7 +85,7 @@ An example of a tutorial that follows this format is Start the page title with `Tutorial:` followed by an active verb, like `Tutorial: Create a website`. In the left nav, use the full page title. Do not abbreviate it. -Put the text in quotes so the pipeline will pass. For example, +Put the text in quotes so the pipeline succeeds. For example, `"Tutorial: Make your first Git commit"`. On [the **Learn GitLab with tutorials** page](../../../tutorials/index.md), |