# HG changeset patch # User Suzanne Selhorn <sselhorn@gitlab.com> # Date 1629749491 0 # Mon Aug 23 20:11:31 2021 +0000 # Node ID 257d57b1b3b50f619037f0a6454a4bf18fc00ee9 # Parent 069c8507b04ca99b41579c2b84b74ae5e688cc9a Updated documentation template to match main gitlab repo diff --git a/.gitlab/merge_request_templates/Documentation update.md b/.gitlab/merge_request_templates/Documentation update.md --- a/.gitlab/merge_request_templates/Documentation update.md +++ b/.gitlab/merge_request_templates/Documentation update.md @@ -1,25 +1,32 @@ -<!-- 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" template --> - ## What does this MR do? <!-- Briefly describe what this MR is about. --> ## Related issues -<!-- Link related issues below. Insert the issue link or reference after the word "Closes" if merging this should automatically close it. --> +<!-- Link related issues below. --> ## Author's checklist -- [ ] Follow the [Documentation Guidelines](https://docs.gitlab.com/ee/development/documentation/) and [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 doc's `h1`. -- [ ] [Request a review](https://docs.gitlab.com/ee/development/code_review.html#dogfooding-the-reviewers-feature) based on the documentation page's metadata and [associated Technical Writer](https://about.gitlab.com/handbook/product/categories/#devops-stages). +- [ ] Consider taking [the GitLab Technical Writing Fundamentals course](https://gitlab.edcast.com/pathways/ECL-02528ee2-c334-4e16-abf3-e9d8b8260de4) +- [ ] Follow the: + - [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 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). -To avoid having this MR be added to code verification QA issues, don't add these labels: ~"feature", ~"frontend", ~"backend", ~"bug", or ~"database" +If you are only adding documentation, do not add any of the following labels: + +- `~"feature"` +- `~"frontend"` +- `~"backend"` +- `~"bug"` +- `~"database"` + +These labels cause the MR to be added to code verification QA issues. ## Review checklist @@ -33,6 +40,7 @@ - [ ] The headings should be something you'd do a Google search for. Instead of `Default behavior`, say something like `Default behavior when you close an issue`. - [ ] The headings (other than the page title) should be active. Instead of `Configuring GDK`, say something like `Configure GDK`. - [ ] Any task steps should be written as a numbered list. + - If the content still needs to be edited for topic types, you can create a follow-up issue with the ~"docs-technical-debt" label. - [ ] Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review. - [ ] Ensure a release milestone is set.