diff options
Diffstat (limited to '.gitlab/merge_request_templates/Documentation.md')
| -rw-r--r-- | .gitlab/merge_request_templates/Documentation.md | 16 |
1 files changed, 4 insertions, 12 deletions
diff --git a/.gitlab/merge_request_templates/Documentation.md b/.gitlab/merge_request_templates/Documentation.md index e97ae9a0c43..66c1eff412b 100644 --- a/.gitlab/merge_request_templates/Documentation.md +++ b/.gitlab/merge_request_templates/Documentation.md @@ -1,13 +1,3 @@ -<!-- - Follow the documentation workflow https://docs.gitlab.com/ee/development/documentation/workflow.html - Additional information is located at https://docs.gitlab.com/ee/development/documentation/ - To find the designated Tech Writer for the stage/group, see - https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers - - Mention "documentation" or "docs" in the MR title - For changing documentation location use the Change Documentation Location.md template ---> - ## What does this MR do? <!-- Briefly describe what this MR is about. --> @@ -18,11 +8,13 @@ ## Author's checklist +- [ ] Consider taking [the GitLab Technical Writing Fundamentals course](https://gitlab.edcast.com/pathways/ECL-02528ee2-c334-4e16-abf3-e9d8b8260de4) - [ ] Follow the: - - [Documentation Guidelines](https://docs.gitlab.com/ee/development/documentation/). + - [Documentation process](https://docs.gitlab.com/ee/development/documentation/workflow.html). + - [Documentation guidelines](https://docs.gitlab.com/ee/development/documentation/). - [Style Guide](https://docs.gitlab.com/ee/development/documentation/styleguide/). - [ ] Ensure that the [product tier badge](https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#product-tier-badges) is added to topic's `h1`. -- [ ] [Request a review](https://docs.gitlab.com/ee/development/code_review.html#dogfooding-the-reviewers-feature) based on the: +- [ ] [Request a review](https://docs.gitlab.com/ee/development/code_review.html#dogfooding-the-reviewers-feature) based on: - The documentation page's [metadata](https://docs.gitlab.com/ee/development/documentation/#metadata). - The [associated Technical Writer](https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments). |