Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
3910f81f
Commit
3910f81f
authored
Apr 16, 2018
by
Marcia Ramos
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
document how badges work
parent
b3d4ff90
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
35 additions
and
0 deletions
+35
-0
doc/development/doc_styleguide.md
doc/development/doc_styleguide.md
+35
-0
No files found.
doc/development/doc_styleguide.md
View file @
3910f81f
...
...
@@ -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
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment