diff options
| author | Marcia Ramos <virtua.creative@gmail.com> | 2018-04-17 13:35:42 -0300 |
|---|---|---|
| committer | Marcia Ramos <virtua.creative@gmail.com> | 2018-04-17 13:35:42 -0300 |
| commit | d8cd3f4bf11920e5dc9ec721383cb0e733b47ef2 (patch) | |
| tree | 6fbb94d5dac1966650074a427b529fd5d5b00eee /doc | |
| parent | dc22d13a42a06bf04b92a3d0a088d6008ac0940e (diff) | |
| download | gitlab-ce-d8cd3f4bf11920e5dc9ec721383cb0e733b47ef2.tar.gz | |
update badges guidelines
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/development/doc_styleguide.md | 26 |
1 files changed, 12 insertions, 14 deletions
diff --git a/doc/development/doc_styleguide.md b/doc/development/doc_styleguide.md index d07468f460e..0550ea527cb 100644 --- a/doc/development/doc_styleguide.md +++ b/doc/development/doc_styleguide.md @@ -162,35 +162,33 @@ below. When a feature is available in EE-only tiers, add the corresponding tier according to the feature availability: -- For GitLab Starter and GitLab.com Bronze: `** [STARTER] **` -- For GitLab Premium and GitLab.com Silver: `** [PREMIUM] **` -- For GitLab Ultimate and GitLab.com Gold: `** [ULTIMATE] **` -- 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]**` +- For GitLab Core and GitLab.com Free: `**[CORE]**` To exclude GitLab.com tiers (when the feature is not available in GitLab.com), add the keyword "only": -- For GitLab Starter: `** [STARTER ONLY] **` -- For GitLab Premium: `** [PREMIUM ONLY] **` -- For GitLab Ultimate: `** [ULTIMATE ONLY] **` -- For GitLab Core: `** [CORE ONLY] **` +- For GitLab Starter: `**[STARTER ONLY]**` +- For GitLab Premium: `**[PREMIUM ONLY]**` +- For GitLab Ultimate: `**[ULTIMATE ONLY]**` +- For GitLab Core: `**[CORE ONLY]**` The tier should be ideally added to headers, so that the full badge will be displayed. But it can be also mentioned from paragraphs, list items, and table cells. For these cases, the tier mention will be represented by an orange question mark. -E.g. `** [STARTER] **` renders **[STARTER]**. +E.g., `**[STARTER]**` renders **[STARTER]**, `**[STARTER ONLY]**` renders **[STARTER ONLY]**. The absence of tiers' mentions mean that the feature is available in GitLab Core, GitLab.com Free, and higher tiers. -Note that spaces between `*` and `[]` were added for escaping the special markup. - #### How it works Introduced by [!244](https://gitlab.com/gitlab-com/gitlab-docs/merge_requests/244), -the special markup `** [STARTER] **` will generate a `span` element to trigger the -badges and tooltips (`**[STARTER]**`). When the keyword "only" is added, the -corresponding GitLab.com badge will not be displayed. +the special markup `**[STARTER]**` will generate a `span` element to trigger the +badges and tooltips (`<span class="badge-trigger starter">`). When the keyword +"only" is added, the corresponding GitLab.com badge will not be displayed. ### GitLab Restart |