Commit 9dc6df4f authored by Mike Lewis's avatar Mike Lewis

Merge branch 'docs-sethgitlab-documentationwf' into 'master'

Update documentation requirements

See merge request gitlab-org/gitlab-ce!32222
parents a3d836c9 47a26caf
...@@ -92,11 +92,10 @@ do the following: ...@@ -92,11 +92,10 @@ do the following:
#### Authoring #### Authoring
As a developer, you must ship the documentation with the code of the feature that 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.
you are creating or updating. 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.
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. - Include any new and edited docs in the MR introducing the code.
- Use the Documentation requirements confirmed by the Product Manager in the - 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 ...@@ -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 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) [DevOps stage](https://about.gitlab.com/handbook/product/categories/#devops-stages)
in your issue or MR, or write within `#docs` on the GitLab Slack. 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 - 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.
the feature cannot be included with the release. A policy for documenting feature-flagged - 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). issues is forthcoming and you are welcome to join the [discussion](https://gitlab.com/gitlab-org/gitlab-ce/issues/56813).
#### Reviews and merging #### Reviews and merging
......
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