Commit cf8c2eeb authored by Marcia Ramos's avatar Marcia Ramos

Merge branch 'docs-development-documentation-edits' into 'master'

Minor fixes to development/documentation docs, mostly aligning all link text to relevant page names

See merge request gitlab-org/gitlab-ce!25471
parents 093f519b a2a8d91d
...@@ -2,14 +2,14 @@ ...@@ -2,14 +2,14 @@
description: How to improve GitLab's documentation. description: How to improve GitLab's documentation.
--- ---
# Documentation Improvement Workflow # Documentation improvement workflow
Anyone can contribute a merge request or create an issue for GitLab's documentation. Anyone can contribute a merge request or create an issue for GitLab's documentation.
This page covers the process for any contributions to GitLab's docs that are This page covers the process for any contributions to GitLab's docs that are
not part of feature development. If you are looking for information on updating not part of feature development. If you are looking for information on updating
GitLab's docs as is required with the development and release of a new feature GitLab's docs as is required with the development and release of a new feature
or feature enhancement, see the [feature-change documentation workflow](feature-change-workflow.md). or feature enhancement, see the [documentation process for feature changes](feature-change-workflow.md).
## Who updates the docs ## Who updates the docs
......
...@@ -10,8 +10,8 @@ In addition to this page, the following resources to help craft and contribute d ...@@ -10,8 +10,8 @@ In addition to this page, the following resources to help craft and contribute d
- [Style Guide](styleguide.md) - What belongs in the docs, language guidelines, and more. - [Style Guide](styleguide.md) - What belongs in the docs, language guidelines, and more.
- [Structure and template](structure.md) - Learn the typical parts of a doc page and how to write each one. - [Structure and template](structure.md) - Learn the typical parts of a doc page and how to write each one.
- [Workflow](workflow.md) - A landing page for our key workflows: - [Workflows](workflow.md) - A landing page for our key workflows:
- [Feature-change documentation workflow](feature-change-workflow.md) - Adding required documentation when developing a GitLab feature. - [Documentation process for feature changes](feature-change-workflow.md) - Adding required documentation when developing a GitLab feature.
- [Documentation improvement workflow](improvement-workflow.md) - New content not associated with a new feature. - [Documentation improvement workflow](improvement-workflow.md) - New content not associated with a new feature.
- [Markdown Guide](https://about.gitlab.com/handbook/product/technical-writing/markdown-guide/) - A reference for the markdown implementation used by GitLab's documentation site and about.gitlab.com. - [Markdown Guide](https://about.gitlab.com/handbook/product/technical-writing/markdown-guide/) - A reference for the markdown implementation used by GitLab's documentation site and about.gitlab.com.
- [Site architecture](site_architecture/index.md) - How docs.gitlab.com is built. - [Site architecture](site_architecture/index.md) - How docs.gitlab.com is built.
......
...@@ -2,9 +2,9 @@ ...@@ -2,9 +2,9 @@
description: Learn the processes for contributing to GitLab's documentation. description: Learn the processes for contributing to GitLab's documentation.
--- ---
# Documentation workflows at GitLab # Documentation workflows
Documentation workflows at GitLab differ depending on the reason for the change. The two types of documentation changes are: Documentation workflows at GitLab differ depending on the reason for the change:
- [Feature-change documentation workflow](feature-change-workflow.md) - The documentation is being created or updated as part of the development and release of a new or enhanced feature. This process involves the developer of the feature (who includes new/updated documentation files as part of the same merge request containing the feature's code) and also involves the product manager and technical writer who are listed for the feature's [DevOps stage](https://about.gitlab.com/handbook/product/categories/#devops-stages). - [Documentation process for feature changes](feature-change-workflow.md) - The documentation is being created or updated as part of the development and release of a new or enhanced feature. This process involves the developer of the feature (who includes new/updated documentation files as part of the same merge request containing the feature's code) and also involves the product manager and technical writer who are listed for the feature's [DevOps stage](https://about.gitlab.com/handbook/product/categories/#devops-stages).
- [Documentation improvement workflow](improvement-workflow.md) - All documentation additions not associated with a feature release. Documentation is being created or updated to improve accuracy, completeness, ease of use, or any reason other than a feature change. Anyone (and everyone) can contribute a merge request for this type of change at any time. - [Documentation improvement workflow](improvement-workflow.md) - All documentation additions not associated with a feature release. Documentation is being created or updated to improve accuracy, completeness, ease of use, or any reason other than a feature change. Anyone (and everyone) can contribute a merge request for this type of change at any time.
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