Commit 4d2c46e5 authored by Mike Lewis's avatar Mike Lewis

Merge branch 'eread/refactor-docs-labels' into 'master'

Introduce Tech Writing Team label to process

See merge request gitlab-org/gitlab!17201
parents b4bca7c1 7068030a
...@@ -11,6 +11,6 @@ Please describe the proposal and add a link to the source (for example, http://w ...@@ -11,6 +11,6 @@ Please describe the proposal and add a link to the source (for example, http://w
/label ~"development guidelines" /label ~"development guidelines"
/label ~"Style decision" /label ~"Style decision"
/label ~Documentation /label ~documentation
/cc @gitlab-org/maintainers/rails-backend /cc @gitlab-org/maintainers/rails-backend
...@@ -8,13 +8,13 @@ ...@@ -8,13 +8,13 @@
## References ## References
Merged MR that introduced documentation requiring review: Merged MR that introduced documentation requiring review:
Related issue(s): Related issue(s):
## Further Details ## Further Details
<!-- Any additional context, questions, or notes for the technical writer. --> <!-- Any additional context, questions, or notes for the technical writer. -->
/label ~Documentation ~docs-review /label ~documentation ~"Technical Writing"
...@@ -2,23 +2,13 @@ ...@@ -2,23 +2,13 @@
* Use this issue template for suggesting new docs or updates to existing docs. * Use this issue template for suggesting new docs or updates to existing docs.
Note: Doc work as part of feature development is covered in the Feature Request template. Note: Doc work as part of feature development is covered in the Feature Request template.
* For issues related to features of the docs.gitlab.com site, see * For issues related to features of the docs.gitlab.com site, see
https://gitlab.com/gitlab-org/gitlab-docs/issues/ https://gitlab.com/gitlab-org/gitlab-docs/issues/
* For information about documentation content and process, see * For information about documentation content and process, see
https://docs.gitlab.com/ee/development/documentation/ --> https://docs.gitlab.com/ee/development/documentation/ -->
<!-- Type of issue -->
<!-- Un-comment the line for the applicable doc issue type to add its label.
Note that all text on that line is deleted upon issue creation. -->
<!-- /label ~"docs:fix" - Correction or clarification needed. -->
<!-- /label ~"docs:new" - New doc needed to cover a new topic or use case. -->
<!-- /label ~"docs:improvement" - Improving an existing doc; e.g. adding a diagram, adding or rewording text, resolving redundancies, cross-linking, etc. -->
<!-- /label ~"docs:revamp" - Review a page or group of pages in order to plan and implement major improvements/rewrites. -->
<!-- /label ~"docs:other" - Anything else. -->
### Problem to solve ### Problem to solve
<!-- Include the following detail as necessary: <!-- Include the following detail as necessary:
...@@ -50,4 +40,4 @@ ...@@ -50,4 +40,4 @@
<!-- E.g. related GitLab issues/MRs --> <!-- E.g. related GitLab issues/MRs -->
/label ~Documentation /label ~documentation
...@@ -10,12 +10,12 @@ ...@@ -10,12 +10,12 @@
<!-- Mention the issue(s) this MR closes or is related to --> <!-- Mention the issue(s) this MR closes or is related to -->
Closes Closes
## Moving docs to a new location? ## Moving docs to a new location?
Read the guidelines: Read the guidelines:
https://docs.gitlab.com/ce/development/documentation/index.html#changing-document-location https://docs.gitlab.com/ee/development/documentation/index.html#changing-document-location
- [ ] Make sure the old link is not removed and has its contents replaced with - [ ] Make sure the old link is not removed and has its contents replaced with
a link to the new location. a link to the new location.
...@@ -29,4 +29,4 @@ https://docs.gitlab.com/ce/development/documentation/index.html#changing-documen ...@@ -29,4 +29,4 @@ https://docs.gitlab.com/ce/development/documentation/index.html#changing-documen
with the changes as well (https://docs.gitlab.com/ce/development/documentation/index.html#cherry-picking-from-ce-to-ee). with the changes as well (https://docs.gitlab.com/ce/development/documentation/index.html#cherry-picking-from-ce-to-ee).
- [ ] Ping one of the technical writers for review. - [ ] Ping one of the technical writers for review.
/label ~Documentation /label ~documentation
<!-- Follow the documentation workflow https://docs.gitlab.com/ee/development/documentation/workflow.html --> <!-- 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/ --> <!-- Additional information is located at https://docs.gitlab.com/ee/development/documentation/ -->
<!-- Mention "documentation" or "docs" in the MR title --> <!-- Mention "documentation" or "docs" in the MR title -->
<!-- For changing documentation location use the "Change documentation location" template --> <!-- For changing documentation location use the "Change documentation location" template -->
...@@ -26,7 +26,7 @@ All reviewers can help ensure accuracy, clarity, completeness, and adherence to ...@@ -26,7 +26,7 @@ All reviewers can help ensure accuracy, clarity, completeness, and adherence to
**1. Primary Reviewer** **1. Primary Reviewer**
* [ ] Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes. * [ ] Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.
**2. Technical Writer** **2. Technical Writer**
* [ ] Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable [DevOps stage](https://about.gitlab.com/handbook/product/categories/#devops-stages). * [ ] Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable [DevOps stage](https://about.gitlab.com/handbook/product/categories/#devops-stages).
...@@ -37,4 +37,4 @@ All reviewers can help ensure accuracy, clarity, completeness, and adherence to ...@@ -37,4 +37,4 @@ All reviewers can help ensure accuracy, clarity, completeness, and adherence to
1. [ ] Ensure a release milestone is set and that you merge the equivalent EE MR before the CE MR if both exist. 1. [ ] Ensure a release milestone is set and that you merge the equivalent EE MR before the CE MR if both exist.
1. [ ] If there has not been a technical writer review, [create an issue for one using the Doc Review template](https://gitlab.com/gitlab-org/gitlab-ce/issues/new?issuable_template=Doc%20Review). 1. [ ] If there has not been a technical writer review, [create an issue for one using the Doc Review template](https://gitlab.com/gitlab-org/gitlab-ce/issues/new?issuable_template=Doc%20Review).
/label ~Documentation /label ~documentation
...@@ -20,8 +20,8 @@ unless docs_paths_to_review.empty? ...@@ -20,8 +20,8 @@ unless docs_paths_to_review.empty?
- [Documentation workflows](https://docs.gitlab.com/ee/development/documentation/workflow.html) for information on when to assign a merge request for review. - [Documentation workflows](https://docs.gitlab.com/ee/development/documentation/workflow.html) for information on when to assign a merge request for review.
MARKDOWN MARKDOWN
unless gitlab.mr_labels.include?('Documentation') unless gitlab.mr_labels.include?('documentation')
warn 'This merge request is missing the ~Documentation label.' warn 'This merge request is missing the ~documentation label.'
end end
end end
end end
...@@ -45,8 +45,8 @@ Most issues will have labels for at least one of the following: ...@@ -45,8 +45,8 @@ Most issues will have labels for at least one of the following:
- Category: ~"Category:Code Analytics", ~"Category:DevOps Score", ~"Category:Templates", etc. - Category: ~"Category:Code Analytics", ~"Category:DevOps Score", ~"Category:Templates", etc.
- Feature: ~wiki, ~ldap, ~api, ~issues, ~"merge requests", etc. - Feature: ~wiki, ~ldap, ~api, ~issues, ~"merge requests", etc.
- Department: ~UX, ~Quality - Department: ~UX, ~Quality
- Team: ~Documentation, ~Delivery - Team: ~"Technical Writing", ~Delivery
- Specialization: ~frontend, ~backend - Specialization: ~frontend, ~backend, ~documentation
- Release Scoping: ~Deliverable, ~Stretch, ~"Next Patch Release" - Release Scoping: ~Deliverable, ~Stretch, ~"Next Patch Release"
- Priority: ~P1, ~P2, ~P3, ~P4 - Priority: ~P1, ~P2, ~P3, ~P4
- Severity: ~S1, ~S2, ~S3, ~S4 - Severity: ~S1, ~S2, ~S3, ~S4
...@@ -228,7 +228,7 @@ people. ...@@ -228,7 +228,7 @@ people.
The current team labels are: The current team labels are:
- ~Delivery - ~Delivery
- ~Documentation - ~"Technical Writing"
#### Naming and color convention #### Naming and color convention
...@@ -241,6 +241,7 @@ These labels narrow the [specialization](https://about.gitlab.com/company/team/s ...@@ -241,6 +241,7 @@ These labels narrow the [specialization](https://about.gitlab.com/company/team/s
- ~frontend - ~frontend
- ~backend - ~backend
- ~documentation
### Release scoping labels ### Release scoping labels
......
...@@ -77,7 +77,7 @@ and default merge request template will assist you with following this process. ...@@ -77,7 +77,7 @@ and default merge request template will assist you with following this process.
For issues requiring any new or updated documentation, the Product Manager (PM) For issues requiring any new or updated documentation, the Product Manager (PM)
must: must:
- Add the `Documentation` label. - Add the ~documentation label.
- Confirm or add the [documentation requirements](#documentation-requirements-in-feature-issues). - Confirm or add the [documentation requirements](#documentation-requirements-in-feature-issues).
- Ensure the issue contains any new or updated feature name, overview/description, - Ensure the issue contains any new or updated feature name, overview/description,
and use cases, as required per the [documentation structure and template](structure.md), when applicable. and use cases, as required per the [documentation structure and template](structure.md), when applicable.
...@@ -92,7 +92,7 @@ do the following: ...@@ -92,7 +92,7 @@ do the following:
#### Authoring #### Authoring
As a developer, if a ~feature issue also contains the ~Documentation label, you must ship the new or updated documentation with the code of the feature. The documentation is an essential part of the product. As a developer, if a ~feature issue also contains the ~documentation label, you must ship the new or updated documentation with the code of the feature. The documentation is an essential part of the product.
Technical writers are happy to help, as requested and planned on an issue-by-issue basis. Technical writers are happy to help, as requested and planned on an issue-by-issue basis.
For feature issues requiring documentation, follow the process below unless otherwise agreed with the product manager and technical writer for a given issue: For feature issues requiring documentation, follow the process below unless otherwise agreed with the product manager and technical writer for a given issue:
......
...@@ -89,7 +89,7 @@ module Gitlab ...@@ -89,7 +89,7 @@ module Gitlab
end end
CATEGORY_LABELS = { CATEGORY_LABELS = {
docs: "~Documentation", # Docs are reviewed along DevOps stages, so don't need roulette for now. docs: "~documentation", # Docs are reviewed along DevOps stages, so don't need roulette for now.
none: "", none: "",
qa: "~QA", qa: "~QA",
test: "~test for `spec/features/*`", test: "~test for `spec/features/*`",
......
...@@ -273,7 +273,7 @@ describe Gitlab::Danger::Helper do ...@@ -273,7 +273,7 @@ describe Gitlab::Danger::Helper do
where(:category, :expected_label) do where(:category, :expected_label) do
:backend | '~backend' :backend | '~backend'
:database | '~database' :database | '~database'
:docs | '~Documentation' :docs | '~documentation'
:foo | '~foo' :foo | '~foo'
:frontend | '~frontend' :frontend | '~frontend'
:none | '' :none | ''
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment