Commit 5e100760 authored by Craig Norris's avatar Craig Norris

Merge branch 'docs-style-guide-version' into 'master'

Update Style Guide for Version handling

See merge request gitlab-org/gitlab!48191
parents 5adab7b4 3c202475
...@@ -30,7 +30,7 @@ See how to document them below, according to the state of the flag: ...@@ -30,7 +30,7 @@ See how to document them below, according to the state of the flag:
- [Features that can be enabled or disabled for a single project](#features-enabled-by-project). - [Features that can be enabled or disabled for a single project](#features-enabled-by-project).
- [Features with the feature flag removed](#features-with-flag-removed). - [Features with the feature flag removed](#features-with-flag-removed).
The [`**(CORE ONLY)**`](styleguide/index.md#product-badges) badge or equivalent for The [`**(CORE ONLY)**`](styleguide/index.md#product-tier-badges) badge or equivalent for
the feature's tier should be added to the line and heading that refers to the feature's tier should be added to the line and heading that refers to
enabling/disabling feature flags as Admin access is required to do so, enabling/disabling feature flags as Admin access is required to do so,
therefore, it indicates that it cannot be done by regular users of GitLab.com. therefore, it indicates that it cannot be done by regular users of GitLab.com.
......
...@@ -154,8 +154,8 @@ Remember: ...@@ -154,8 +154,8 @@ 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-badges) are applied. - That [product badges](styleguide/index.md#product-tier-badges) are applied.
- That the GitLab [version](styleguide/index.md#text-for-documentation-requiring-version-text) that - That the GitLab [version](styleguide/index.md#gitlab-versions) that
introduced the feature has been included. introduced the feature has been included.
- That changes to headings don't affect in-app hyperlinks. - That 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.
......
...@@ -9,7 +9,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -9,7 +9,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
- **Write the code and the tests.**: As with any code, EE features should have - **Write the code and the tests.**: As with any code, EE features should have
good test coverage to prevent regressions. good test coverage to prevent regressions.
- **Write documentation.**: Add documentation to the `doc/` directory. Describe - **Write documentation.**: Add documentation to the `doc/` directory. Describe
the feature and include screenshots, if applicable. Indicate [what editions](documentation/styleguide/index.md#product-badges) the feature and include screenshots, if applicable. Indicate [what editions](documentation/styleguide/index.md#product-tier-badges)
the feature applies to. the feature applies to.
- **Submit a MR to the `www-gitlab-com` project.**: Add the new feature to the - **Submit a MR to the `www-gitlab-com` project.**: Add the new feature to the
[EE features list](https://about.gitlab.com/features/). [EE features list](https://about.gitlab.com/features/).
......
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