kotovalexarian-likes-gitlab
/
gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity
gitlab-org--gitlab-foss/doc/development/documentation/improvement-workflow.md

43 lines
1.8 KiB
Markdown
Raw Normal View History

Updates per reviews; split workflow.md into 2 pages Split workflow.md into a new feature workflow page vs other improvement workflow page because the original page was too long and using 4 heading levels. Left it in place as an index so we have a single workflow landing page.
2018-12-21 23:56:21 +00:00
---
description: How to improve GitLab's documentation.
---
# Other documentation updates
Anyone can contribute a merge request or create an issue for GitLab's documentation.
Add line breaks to improvement workflow
2018-12-22 03:56:10 +00:00
This page covers the process for general contributions to GitLab's docs (other
than those which arise from release-related feature updates) can be found on the
documentation guidelines page under [other documentation contributions](index.md#other-documentation-contributions).
Updates per reviews; split workflow.md into 2 pages Split workflow.md into a new feature workflow page vs other improvement workflow page because the original page was too long and using 4 heading levels. Left it in place as an index so we have a single workflow landing page.
2018-12-21 23:56:21 +00:00
Update improvement-workflow, remove Support-specific items
2018-12-27 20:18:26 +00:00
## Who updates the docs
Updates per reviews; split workflow.md into 2 pages Split workflow.md into a new feature workflow page vs other improvement workflow page because the original page was too long and using 4 heading levels. Left it in place as an index so we have a single workflow landing page.
2018-12-21 23:56:21 +00:00
Update improvement-workflow, remove Support-specific items
2018-12-27 20:18:26 +00:00
Anyone can contribute! You can create a merge request with documentation
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
DevOps workflows.
Updates per reviews; split workflow.md into 2 pages Split workflow.md into a new feature workflow page vs other improvement workflow page because the original page was too long and using 4 heading levels. Left it in place as an index so we have a single workflow landing page.
2018-12-21 23:56:21 +00:00
Updates to doc improvements workflow
2018-12-27 21:59:22 +00:00
## How to update the docs
Follow GitLab's [Merge Request Guidelines](../contributing/merge_request_workflow.md#merge-request-guidelines).
Update improvement-workflow, remove Support-specific items
2018-12-27 20:18:26 +00:00
## Merging
Updates per reviews; split workflow.md into 2 pages Split workflow.md into a new feature workflow page vs other improvement workflow page because the original page was too long and using 4 heading levels. Left it in place as an index so we have a single workflow landing page.
2018-12-21 23:56:21 +00:00
Update improvement-workflow, remove Support-specific items
2018-12-27 20:18:26 +00:00
Anyone with master access to the affected GitLab project can merge documentation changes.
This person must make a good-faith effort to ensure that the content is clear
(sufficiently easy for the intended audience to navigate and understand) and
that it meets the [Documentation Guidelines](index.md) and [Style Guide](styleguide.md).
Updates per reviews; split workflow.md into 2 pages Split workflow.md into a new feature workflow page vs other improvement workflow page because the original page was too long and using 4 heading levels. Left it in place as an index so we have a single workflow landing page.
2018-12-21 23:56:21 +00:00
Update improvement-workflow, remove Support-specific items
2018-12-27 20:18:26 +00:00
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).
Updates per reviews; split workflow.md into 2 pages Split workflow.md into a new feature workflow page vs other improvement workflow page because the original page was too long and using 4 heading levels. Left it in place as an index so we have a single workflow landing page.
2018-12-21 23:56:21 +00:00
Updates to doc improvements workflow
2018-12-27 21:59:22 +00:00
## 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.
Update improvement-workflow, remove Support-specific items
2018-12-27 20:18:26 +00:00
## Other ways to help
Updates per reviews; split workflow.md into 2 pages Split workflow.md into a new feature workflow page vs other improvement workflow page because the original page was too long and using 4 heading levels. Left it in place as an index so we have a single workflow landing page.
2018-12-21 23:56:21 +00:00
Add line breaks to improvement workflow
2018-12-22 03:56:10 +00:00
If you have ideas for further documentation resources that would be best
considered/handled by technical writers, devs, and other SMEs, please create an issue.