kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity

Updates to doc improvements workflow

Browse source
This commit is contained in:
Mike Lewis 2018-12-27 21:59:22 +00:00
parent 01d23dfe2a
commit fb55ba5b91
1 changed files with 13 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
doc/development/documentation/improvement-workflow.md
View file

@ -17,6 +17,10 @@ when you find errors or other room for improvement, or have an idea for all-new
documentation that would help a GitLab user or admin achieve or optimize their documentation that would help a GitLab user or admin achieve or optimize their
DevOps workflows. DevOps workflows.
## How to update the docs
Follow GitLab's [Merge Request Guidelines](../contributing/merge_request_workflow.md#merge-request-guidelines).
## Content: what belongs in the docs ## Content: what belongs in the docs
In docs, we share any and all helpful info/processes/tips with customers, but In docs, we share any and all helpful info/processes/tips with customers, but
@ -25,6 +29,10 @@ actions. There is no reason to withhold 'risky' steps and store them in another
location; simply include them along with the rest of the docs, with all necessary location; simply include them along with the rest of the docs, with all necessary
detail including specific warnings and caveats. detail including specific warnings and caveats.
Any content that is relevant to users or admins may be included. You can freely
include presentations, videos, etc.; no matter who it was originally written for,
if it is helpful to any of our audiences, we can include it.
A `Troubleshooting` section in doc pages is part of the default [template](structure.md) A `Troubleshooting` section in doc pages is part of the default [template](structure.md)
for a new page, and can freely be added to any page. for a new page, and can freely be added to any page.
@ -41,6 +49,11 @@ that it meets the [Documentation Guidelines](index.md) and [Style Guide](stylegu
If the author or reviewer has any questions, or would like a techncial writer's review If the author or reviewer has any questions, or would like a techncial writer's review
before merging, mention the writer who is assigned to the relevant [DevOps stage](https://about.gitlab.com/handbook/product/categories/#devops-stages). before merging, mention the writer who is assigned to the relevant [DevOps stage](https://about.gitlab.com/handbook/product/categories/#devops-stages).
## Technical Writer Review
The technical writing team reviews changes after they are merged, unless one of
the technical writers already reviewed prior to the merge.
## Other ways to help ## Other ways to help
If you have ideas for further documentation resources that would be best If you have ideas for further documentation resources that would be best