diff options
| author | Mike Lewis <mlewis@gitlab.com> | 2019-09-12 03:57:08 +0300 |
|---|---|---|
| committer | Mike Lewis <mlewis@gitlab.com> | 2019-09-12 03:57:08 +0300 |
| commit | 9dc6df4feb29081eda070e5bd58b2b8fa1b802e6 (patch) | |
| tree | 6b023cc0b040f0f58b199ca02571f11e86bb7683 | |
| parent | a3d836c9f7814f3a3c3fb149d54239475eb9c027 (diff) | |
| parent | 47a26caff2f1cf0d78e342023d4f5073888bbae9 (diff) | |
Merge branch 'docs-sethgitlab-documentationwf' into 'master'
Update documentation requirements
See merge request gitlab-org/gitlab-ce!32222
| -rw-r--r-- | doc/development/documentation/feature-change-workflow.md | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/doc/development/documentation/feature-change-workflow.md b/doc/development/documentation/feature-change-workflow.md index 00c76fe0f1b..38ccae41df4 100644 --- a/doc/development/documentation/feature-change-workflow.md +++ b/doc/development/documentation/feature-change-workflow.md @@ -92,11 +92,10 @@ do the following: #### Authoring -As a developer, you must ship the documentation with the code of the feature that -you are creating or updating. 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. -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: - Include any new and edited docs in the MR introducing the code. - Use the Documentation requirements confirmed by the Product Manager in the @@ -111,8 +110,8 @@ Follow the process below unless otherwise agreed with the product manager and te idea or outline, or request any other help, ping the Technical Writer for the relevant [DevOps stage](https://about.gitlab.com/handbook/product/categories/#devops-stages) in your issue or MR, or write within `#docs` on the GitLab Slack. -- The docs must be merged with the code **by the feature freeze date**, otherwise - the feature cannot be included with the release. A policy for documenting feature-flagged +- If you are working on documentation in a separate MR, ensure that if the code is merged by the 17th, the docs are as well, per the [Engineering Workflow](https://about.gitlab.com/handbook/engineering/workflow/). If the docs are not ready, the PM can approve merging the code if the engineer and tech writer commit to get documentation merged by the 21st. Otherwise the feature is not considered complete, and should not be merged. +- A policy for documenting feature-flagged issues is forthcoming and you are welcome to join the [discussion](https://gitlab.com/gitlab-org/gitlab-ce/issues/56813). #### Reviews and merging |