diff options
Diffstat (limited to 'doc/development/documentation/workflow.md')
| -rw-r--r-- | doc/development/documentation/workflow.md | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/doc/development/documentation/workflow.md b/doc/development/documentation/workflow.md index 9bc80116d25..e809ca84707 100644 --- a/doc/development/documentation/workflow.md +++ b/doc/development/documentation/workflow.md @@ -1,13 +1,13 @@ --- stage: none group: unassigned -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- # Documentation process The process for creating and maintaining GitLab product documentation allows -anyone to contribute a merge request or create an issue for GitLab's +anyone to contribute a merge request or create an issue for GitLab documentation. Documentation updates relating to new features or feature enhancements must @@ -60,9 +60,9 @@ To update GitLab documentation: - The [Structure and template](structure.md) page. - The [Style Guide](styleguide/index.md). - The [Markdown Guide](https://about.gitlab.com/handbook/markdown-guide/). -1. Follow GitLab's [Merge Request Guidelines](../contributing/merge_request_workflow.md#merge-request-guidelines). +1. Follow the [Merge Request Guidelines](../contributing/merge_request_workflow.md#merge-request-guidelines). -TIP: **Tip:** +NOTE: Work in a fork if you do not have Developer access to the GitLab project. Request help from the Technical Writing team if you: @@ -79,7 +79,7 @@ To request help: - If urgent help is required, directly assign the Technical Writer in the issue or in the merge request. - If non-urgent help is required, ping the Technical Writer in the issue or merge request. -If you are a member of GitLab's Slack workspace, you can request help in `#docs`. +If you are a member of the GitLab Slack workspace, you can request help in `#docs`. ### Reviewing and merging @@ -146,7 +146,7 @@ Remember: advance of a milestone release and for larger documentation changes. - You can request a post-merge Technical Writer review of documentation if it's important to get the code with which it ships merged as soon as possible. In this case, the author of the original MR - will address the feedback provided by the Technical Writer in a follow-up MR. + can address the feedback provided by the Technical Writer in a follow-up MR. - The Technical Writer can also help decide that documentation can be merged without Technical writer review, with the review to occur soon after merge. @@ -154,8 +154,8 @@ Remember: Ensure the following if skipping an initial Technical Writer review: -- That [product badges](styleguide/index.md#product-badges) are applied. -- That the GitLab [version](styleguide/index.md#text-for-documentation-requiring-version-text) that +- That [product badges](styleguide/index.md#product-tier-badges) are applied. +- That the GitLab [version](styleguide/index.md#gitlab-versions) that introduced the feature has been included. - That changes to headings don't affect in-app hyperlinks. - Specific [user permissions](../../user/permissions.md) are documented. |