diff options
| author | Evan Read <eread@gitlab.com> | 2019-09-12 14:24:51 +1000 |
|---|---|---|
| committer | Evan Read <eread@gitlab.com> | 2019-09-13 16:51:51 +1000 |
| commit | 468d2667cf9c12ac43bf7f12a67053d0ed9344f3 (patch) | |
| tree | 027b95b7aaf12f36df88f55baeb6d0908ac8c0b0 | |
| parent | 25cb337cf12438169f1b14bc5dace8a06a7356e3 (diff) | |
| download | gitlab-ce-docs/refactor-docs-labels.tar.gz | |
Introduce Tech Writing Team label to processdocs/refactor-docs-labels
| -rw-r--r-- | doc/development/contributing/issue_workflow.md | 7 | ||||
| -rw-r--r-- | doc/development/documentation/feature-change-workflow.md | 4 |
2 files changed, 6 insertions, 5 deletions
diff --git a/doc/development/contributing/issue_workflow.md b/doc/development/contributing/issue_workflow.md index 8b5d380ad9e..8d2ed394237 100644 --- a/doc/development/contributing/issue_workflow.md +++ b/doc/development/contributing/issue_workflow.md @@ -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. - Feature: ~wiki, ~ldap, ~api, ~issues, ~"merge requests", etc. - Department: ~UX, ~Quality -- Team: ~Documentation, ~Delivery -- Specialization: ~frontend, ~backend +- Team: ~"Technical Writing", ~Delivery +- Specialization: ~frontend, ~backend, ~documentation - Release Scoping: ~Deliverable, ~Stretch, ~"Next Patch Release" - Priority: ~P1, ~P2, ~P3, ~P4 - Severity: ~S1, ~S2, ~S3, ~S4 @@ -228,7 +228,7 @@ people. The current team labels are: - ~Delivery -- ~Documentation +- ~"Technical Writing" #### Naming and color convention @@ -241,6 +241,7 @@ These labels narrow the [specialization](https://about.gitlab.com/company/team/s - ~frontend - ~backend +- ~documentation ### Release scoping labels diff --git a/doc/development/documentation/feature-change-workflow.md b/doc/development/documentation/feature-change-workflow.md index 38ccae41df4..29d66689e92 100644 --- a/doc/development/documentation/feature-change-workflow.md +++ b/doc/development/documentation/feature-change-workflow.md @@ -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) must: -- Add the `Documentation` label. +- Add the ~documentation label. - Confirm or add the [documentation requirements](#documentation-requirements-in-feature-issues). - 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. @@ -92,7 +92,7 @@ do the following: #### 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. For feature issues requiring documentation, follow the process below unless otherwise agreed with the product manager and technical writer for a given issue: |