diff options
Diffstat (limited to 'doc/development/documentation/structure.md')
| -rw-r--r-- | doc/development/documentation/structure.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/development/documentation/structure.md b/doc/development/documentation/structure.md index 3cc7f49f05e..fd0c29f0fc1 100644 --- a/doc/development/documentation/structure.md +++ b/doc/development/documentation/structure.md @@ -1,7 +1,7 @@ --- 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/engineering/ux/technical-writing/#designated-technical-writers +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments description: What to include in GitLab documentation pages. --- @@ -9,7 +9,7 @@ description: What to include in GitLab documentation pages. Use these standards to contribute content to the GitLab documentation. -Before getting started, familiarize yourself with [GitLab's Documentation guidelines](index.md) +Before getting started, familiarize yourself with [Documentation guidelines for GitLab](index.md) and the [Documentation Style Guide](styleguide/index.md). ## Components of a documentation page @@ -39,7 +39,7 @@ pre-deployment and post-deployment tasks. ## Template for new docs -Follow the [folder structure and file name guidelines](styleguide/index.md#folder-structure-overview) +Follow the [folder structure and filename guidelines](styleguide/index.md#folder-structure-overview) and create a new topic by using this template: ```markdown @@ -53,7 +53,7 @@ in Google Search snippets. It may help to write the page intro first, and then r stage: Add the stage name here group: Add the group name here info: To determine the technical writer assigned to the Stage/Group associated with this page, -see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers +see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- # Feature or Use Case Name **[TIER]** (1) |