@@ -111,7 +111,7 @@ The process involves the following:
...
@@ -111,7 +111,7 @@ The process involves the following:
- Ensure the appropriate labels are applied, including any required to pick a merge request into
- Ensure the appropriate labels are applied, including any required to pick a merge request into
a release.
a release.
- Ensure that, if there has not been a Technical Writer review completed or scheduled, they
- Ensure that, if there has not been a Technical Writer review completed or scheduled, they
[create the required issue](https://gitlab.com/gitlab-org/gitlab/-/issues/new?issuable_template=Doc%20Review), assign to the Technical Writer of the given stage group,
[create the required issue](https://gitlab.com/gitlab-org/gitlab/-/issues/new?issuable_template=Doc%20Review), assign it to the Technical Writer of the given stage group,
and link it from the merge request.
and link it from the merge request.
The process is reflected in the **Documentation**
The process is reflected in the **Documentation**
...
@@ -130,10 +130,10 @@ immediately after merge by the developer or maintainer. For this,
...
@@ -130,10 +130,10 @@ immediately after merge by the developer or maintainer. For this,
create an issue using the [Doc Review description template](https://gitlab.com/gitlab-org/gitlab/-/issues/new?issuable_template=Doc%20Review)
create an issue using the [Doc Review description template](https://gitlab.com/gitlab-org/gitlab/-/issues/new?issuable_template=Doc%20Review)
and link to it from the merged merge request that introduced the documentation change.
and link to it from the merged merge request that introduced the documentation change.
Circumstances where a regular pre-merge Technical Writer review might be skipped include:
Circumstances, where a regular pre-merge Technical Writer review might be skipped, include:
- There is a short amount of time left before the milestone release. If there are less than three days
- There is a short amount of time left before the milestone release. If less than three
remaining, seek a post-merge review and ping the writer via Slack to ensure the review is
days are remaining, seek a post-merge review and ping the writer via Slack to ensure the review is
completed as soon as possible.
completed as soon as possible.
- The size of the change is small and you have a high degree of confidence
- The size of the change is small and you have a high degree of confidence
that early users of the feature (for example, GitLab.com users) can easily
that early users of the feature (for example, GitLab.com users) can easily
...
@@ -156,15 +156,15 @@ Remember:
...
@@ -156,15 +156,15 @@ Remember:
Ensure the following if skipping an initial Technical Writer review:
Ensure the following if skipping an initial Technical Writer review:
-That [product badges](styleguide/index.md#product-tier-badges) are applied.
-[Product badges](styleguide/index.md#product-tier-badges) are applied.
- That the GitLab [version](styleguide/index.md#gitlab-versions) that
- The GitLab [version](styleguide/index.md#gitlab-versions) that
introduced the feature has been included.
introduced the feature is included.
-That changes to headings don't affect in-app hyperlinks.
-Changes to headings don't affect in-app hyperlinks.
- Specific [user permissions](../../user/permissions.md) are documented.
- Specific [user permissions](../../user/permissions.md) are documented.
-That new documents are linked from higher-level indexes, for discoverability.
-New documents are linked from higher-level indexes, for discoverability.
-Style guide is followed:
-The style guide is followed:
- For [directories and files](styleguide/index.md#work-with-directories-and-files).
- For [directories and files](styleguide/index.md#work-with-directories-and-files).
- For [images](styleguide/index.md#images).
- For [images](styleguide/index.md#images).
Merge requests that change the location of documentation must always be reviewed by a Technical
Merge requests that change the location of documentation must always be reviewed by a Technical