diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-08-30 03:09:43 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-08-30 03:09:43 +0300 |
commit | f2cc58f3b006ac745d5f68883ddf7ba6a1e9c6a0 (patch) | |
tree | 247a1881cada0a22bfca7d404d7a434daabffe82 /doc/development/documentation/styleguide | |
parent | 165985ad8de01d88952de1207c4124f428263357 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/documentation/styleguide')
-rw-r--r-- | doc/development/documentation/styleguide/index.md | 14 |
1 files changed, 12 insertions, 2 deletions
diff --git a/doc/development/documentation/styleguide/index.md b/doc/development/documentation/styleguide/index.md index aecbc90210c..de9569e1e6b 100644 --- a/doc/development/documentation/styleguide/index.md +++ b/doc/development/documentation/styleguide/index.md @@ -1641,7 +1641,7 @@ The H1 tier badge should be the badge that applies to the lowest tier for the fe #### Available product tier badges -Tier badges must include two components, in this order: a subscription tier and an offering. +Tier badges should include two components, in this order: a subscription tier and an offering. These components are surrounded by bold and parentheses, for example `**(ULTIMATE SAAS)**`. Subscription tiers: @@ -1661,10 +1661,14 @@ You can also add a third component for the feature's status: - `EXPERIMENT` - `BETA` +For example, `**(FREE ALL EXPERIMENT)**`. + +A tier or status can stand alone. An offering should always have a tier. + #### Add a tier badge To add a tier badge to a topic title, add the two relevant components -after the title text. You must include the subscription tier first, and then the offering. +after the title text. You should include the subscription tier first, and then the offering. For example: ```markdown @@ -1677,6 +1681,12 @@ Optionally, you can add the feature status as the last part of the badge: # Topic title **(FREE ALL EXPERIMENT)** ``` +Or add the status by itself: + +```markdown +# Topic title **(EXPERIMENT)** +``` + ##### Inline tier badges Do not add tier badges inline with other text, except for [API attributes](../restful_api_styleguide.md). |