Commit bfeec256 authored by Mike Lewis's avatar Mike Lewis

Merge branch 'docs-update-tier-badge' into 'master'

Add tier badge requirement to h1s

See merge request gitlab-org/gitlab!38210
parents 901f24fe 7980bf5b
...@@ -1524,43 +1524,43 @@ GitLab Community Edition), don't split the product or feature name across lines. ...@@ -1524,43 +1524,43 @@ GitLab Community Edition), don't split the product or feature name across lines.
### Product badges ### Product badges
When a feature is available in EE-only tiers, add the corresponding tier according to the When a feature is available in paid tiers, add the corresponding tier to the
feature availability: header or other page element according to the feature's availability:
- For GitLab Core and GitLab.com Free: `**(CORE)**`. | Tier in which feature is available | Tier markup |
- For GitLab Starter and GitLab.com Bronze: `**(STARTER)**`. |:-----------------------------------------------------------------------|:----------------------|
- For GitLab Premium and GitLab.com Silver: `**(PREMIUM)**`. | GitLab Core and GitLab.com Free, and their higher tiers | `**(CORE)**` |
- For GitLab Ultimate and GitLab.com Gold: `**(ULTIMATE)**`. | GitLab Starter and GitLab.com Bronze, and their higher tiers | `**(STARTER)**` |
| GitLab Premium and GitLab.com Silver, and their higher tiers | `**(PREMIUM)**` |
To exclude GitLab.com tiers (when the feature is not available in GitLab.com), add the | GitLab Ultimate and GitLab.com Gold | `**(ULTIMATE)**` |
keyword "only": | *Only* GitLab Core and higher tiers (no GitLab.com-based tiers) | `**(CORE ONLY)**` |
| *Only* GitLab Starter and higher tiers (no GitLab.com-based tiers) | `**(STARTER ONLY)**` |
- For GitLab Core: `**(CORE ONLY)**`. | *Only* GitLab Premium and higher tiers (no GitLab.com-based tiers) | `**(PREMIUM ONLY)**` |
- For GitLab Starter: `**(STARTER ONLY)**`. | *Only* GitLab Ultimate (no GitLab.com-based tiers) | `**(ULTIMATE ONLY)**` |
- For GitLab Premium: `**(PREMIUM ONLY)**`. | *Only* GitLab.com Free and higher tiers (no self-managed instances) | `**(FREE ONLY)**` |
- For GitLab Ultimate: `**(ULTIMATE ONLY)**`. | *Only* GitLab.com Bronze and higher tiers (no self-managed instances) | `**(BRONZE ONLY)**` |
| *Only* GitLab.com Silver and higher tiers (no self-managed instances) | `**(SILVER ONLY)**` |
For GitLab.com only tiers (when the feature is not available for self-managed instances): | *Only* GitLab.com Gold (no self-managed instances) | `**(GOLD ONLY)**` |
- For GitLab Free and higher tiers: `**(FREE ONLY)**`. For clarity, all page title headers (H1s) must be have a tier markup for
- For GitLab Bronze and higher tiers: `**(BRONZE ONLY)**`. the lowest tier that has information on the documentation page.
- For GitLab Silver and higher tiers: `**(SILVER ONLY)**`.
- For GitLab Gold: `**(GOLD ONLY)**`. If sections of a page apply to higher tier levels, they can be separately
labeled with their own tier markup.
The tier should be ideally added to headers, so that the full badge will be displayed.
However, it can be also mentioned from paragraphs, list items, and table cells. For these cases, #### Product badge display behavior
the tier mention will be represented by an orange info icon **(information)** that will show the tiers on hover.
When using the tier markup with headers, the documentation page will
Use the lowest tier at the page level, even if higher-level tiers exist on the page. For example, you might have a page that is marked as Starter but a section badged as Premium. display the full tier badge with the header line.
For example: You can also use the tier markup with paragraphs, list items,
and table cells. For these cases, the tier mention will be represented by an
- `**(STARTER)**` renders as **(STARTER)** orange info icon **{information}** that will display the tiers when visitors
- `**(STARTER ONLY)**` renders as **(STARTER ONLY)** point to the icon. For example:
- `**(SILVER ONLY)**` renders as **(SILVER ONLY)**
- `**(STARTER)**` displays as **(STARTER)**
The absence of tiers' mentions mean that the feature is available in GitLab Core, - `**(STARTER ONLY)**` displays as **(STARTER ONLY)**
GitLab.com Free, and all higher tiers. - `**(SILVER ONLY)**` displays as **(SILVER ONLY)**
#### How it works #### How it works
......
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