diff options
author | Marcia Ramos <virtua.creative@gmail.com> | 2018-04-16 14:33:52 -0300 |
---|---|---|
committer | Marcia Ramos <virtua.creative@gmail.com> | 2018-04-16 14:33:52 -0300 |
commit | 2654905ad5da4bb7cbcb0052fffd266d6c6cc36d (patch) | |
tree | 99b9c37d39a83d784dbee76be1fec0b1728f4302 /doc/development/doc_styleguide.md | |
parent | 3ab3bf8ae5f0a01f246d109544a6b1cecd147874 (diff) | |
download | gitlab-ce-2654905ad5da4bb7cbcb0052fffd266d6c6cc36d.tar.gz |
document how badges work
Diffstat (limited to 'doc/development/doc_styleguide.md')
-rw-r--r-- | doc/development/doc_styleguide.md | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/doc/development/doc_styleguide.md b/doc/development/doc_styleguide.md index 41e3412c7ff..d07468f460e 100644 --- a/doc/development/doc_styleguide.md +++ b/doc/development/doc_styleguide.md @@ -157,6 +157,41 @@ below. Otherwise, leave this mention out. +### Product badges + +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] **` + +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] **` + +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]**. + +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. + ### GitLab Restart There are many cases that a restart/reconfigure of GitLab is required. To |