diff options
| author | Seth Berger <4310743-sethgitlab@users.noreply.gitlab.com> | 2019-08-26 15:50:30 +0000 |
|---|---|---|
| committer | Seth Berger <4310743-sethgitlab@users.noreply.gitlab.com> | 2019-08-26 15:50:30 +0000 |
| commit | cf6d467de5cbb8d2c88944b82d7dae28d58cb519 (patch) | |
| tree | 2cfce8b95dea06e9bf8adcbcc9fe9cb6fe9bf9c2 | |
| parent | 336ef2a98cf74b0a49474816031657efbe14f3b2 (diff) | |
| download | gitlab-ce-docs-sethgitlab-documentationwf.tar.gz | |
Update documentation requirementsdocs-sethgitlab-documentationwf
Changed wording to allow features, upon approval to
ship without documentation.
| -rw-r--r-- | doc/development/documentation/feature-change-workflow.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/development/documentation/feature-change-workflow.md b/doc/development/documentation/feature-change-workflow.md index 00c76fe0f1b..3dae4ca2518 100644 --- a/doc/development/documentation/feature-change-workflow.md +++ b/doc/development/documentation/feature-change-workflow.md @@ -92,7 +92,7 @@ do the following: #### Authoring -As a developer, you must ship the documentation with the code of the feature that +As a developer, you should ship the documentation with the code of the feature that 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. @@ -111,8 +111,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 +- The docs should be merged with the code **by the feature freeze date**, otherwise + the feature should not be included with the release. The PM can decide if a feature can ship without documentation. 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 |