Skip to content

GitLab Next

Project 'gitlab-com/gitlab-docs' was moved to 'gitlab-org/gitlab-docs'. Please update any links and bookmarks that may still have the old path.
Merged
Created by Marcia Ramos@marcia👋Contributor8 of 8 tasks completed8/8 tasks

Add badges to docs

How it works

For every place we want to add the badge, we use a magic Markdown syntax: **[BADGE_TYPE]**

  • Core: **[CORE]**
  • Starter: **[STARTER]**
  • Premium: **[PREMIUM]**
  • Ultimate: **[ULTIMATE]**

Each one imply on the gitlab-dot-com equivalent, as well, so by setting core you also get free.

If you want to restrict only for on-premise, you need to specify a modifier ONLY:

**[CORE ONLY]**
**[STARTER ONLY]**
**[PREMIUM ONLY]**
**[ULTIMATE ONLY]**

On hover, it shows the availability.

How it renders on the docs site:

Review apps:

Screen_Shot_2018-04-13_at_17.42.17

How it renders in GitLab markdown:

Preview: https://gitlab.com/gitlab-org/gitlab-ee/blob/a929fdcf352047f26c738503519df1c593216727/doc/test.md

markdown-fallback

How noisy the markdown file gets:

Preview: https://gitlab.com/gitlab-org/gitlab-ee/blob/a929fdcf352047f26c738503519df1c593216727/doc/test.md

### Lorem ipsum dolor sit h3 **[PREMIUM]**

Lorem ipsum dolor sit amet, consectetur adipisicing elit. **[PREMIUM]**

- **[PREMIUM]** Lorem ipsum dolor sit amet, consectetur adipisicing elit. Omnis, nulla. 1
- **[ULTIMATE ONLY]** Lorem ipsum dolor sit amet, consectetur adipisicing elit. Omnis, nulla. 3

Todos

Edited by Marcia Ramos