Commit bf87d31b authored by Craig Norris's avatar Craig Norris

Update tier badge section

parent 62848d57
......@@ -1468,43 +1468,43 @@ GitLab Community Edition), don't split the product or feature name across lines.
### Product badges
When a feature is available in EE-only tiers, add the corresponding tier according to the
feature availability:
- For GitLab Core and GitLab.com Free: `**(CORE)**`.
- For GitLab Starter and GitLab.com Bronze: `**(STARTER)**`.
- For GitLab Premium and GitLab.com Silver: `**(PREMIUM)**`.
- For GitLab Ultimate and GitLab.com Gold: `**(ULTIMATE)**`.
To exclude GitLab.com tiers (when the feature is not available in GitLab.com), add the
keyword "only":
- For GitLab Core: `**(CORE ONLY)**`.
- For GitLab Starter: `**(STARTER ONLY)**`.
- For GitLab Premium: `**(PREMIUM ONLY)**`.
- For GitLab Ultimate: `**(ULTIMATE ONLY)**`.
For GitLab.com only tiers (when the feature is not available for self-managed instances):
- For GitLab Free and higher tiers: `**(FREE ONLY)**`.
- For GitLab Bronze and higher tiers: `**(BRONZE ONLY)**`.
- For GitLab Silver and higher tiers: `**(SILVER ONLY)**`.
- For GitLab Gold: `**(GOLD ONLY)**`.
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,
the tier mention will be represented by an orange info icon **(information)** that will show the tiers on hover.
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.
For example:
- `**(STARTER)**` renders as **(STARTER)**
- `**(STARTER ONLY)**` renders as **(STARTER ONLY)**
- `**(SILVER ONLY)**` renders as **(SILVER ONLY)**
The absence of tiers' mentions mean that the feature is available in GitLab Core,
GitLab.com Free, and all higher tiers.
When a feature is available in EE-only tiers, add the corresponding tier to the
header or other page element according to the feature's availability:
| Tier | Markdown code |
|:-------------------------------------------------------------|:----------------------|
| GitLab Core and GitLab.com Free, and their higher tiers | `**(CORE)**` |
| GitLab Starter and GitLab.com Bronze, and their higher tiers | `**(STARTER)**` |
| GitLab Premium and GitLab.com Silver, and their higher tiers | `**(PREMIUM)**` |
| GitLab Ultimate and GitLab.com Gold | `**(ULTIMATE)**` |
| *Only* GitLab Core, and higher tiers | `**(CORE ONLY)**` |
| *Only* GitLab Starter, and higher tiers | `**(STARTER ONLY)**` |
| *Only* GitLab Premium, and higher tiers | `**(PREMIUM ONLY)**` |
| *Only* GitLab Ultimate | `**(ULTIMATE ONLY)**` |
| *Only* GitLab.com Free, and higher tiers | `**(FREE ONLY)**` |
| *Only* GitLab.com Bronze, and higher tiers | `**(BRONZE ONLY)**` |
| *Only* GitLab.com Silver, and higher tiers | `**(SILVER ONLY)**` |
| *Only* GitLab.com Gold | `**(GOLD ONLY)**` |
For clarity, all page title headers (H1s) must be have a tier markdown code for
the lowest tier that has information on the documentation page.
If sections of a page apply to higher tier levels, they can be separately
labeled with their own tier markdown code.
#### Product badge display behavior
When using the tier markdown code with headers, the documentation page will
display the full tier badge with the header line.
You can also use the tier markdown code with paragraphs, list items,
and table cells. For these cases, the tier mention will be represented by an
orange info icon **(information)** that will display the tiers when visitors
point to the icon. For example:
- `**(STARTER)**` displays as **(STARTER)**
- `**(STARTER ONLY)**` displays as **(STARTER ONLY)**
- `**(SILVER ONLY)**` displays as **(SILVER ONLY)**
#### 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