index.md 77.2 KB
Newer Older
1
---
2
info: For assistance with this Style Guide page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments-to-other-projects-and-subjects.
Amy Qualls's avatar
Amy Qualls committed
3 4
stage: none
group: unassigned
5 6 7 8 9
description: 'Writing styles, markup, formatting, and other standards for GitLab Documentation.'
---

# Documentation Style Guide

Suzanne Selhorn's avatar
Suzanne Selhorn committed
10
This document defines the standards for GitLab documentation, including grammar, formatting, word use, and more.
11

Suzanne Selhorn's avatar
Suzanne Selhorn committed
12 13
For style questions, mention `@tw-style` in an issue or merge request. If you have access to the GitLab Slack workspace,
use the `#docs-processes` channel.
14

Suzanne Selhorn's avatar
Suzanne Selhorn committed
15
In addition to this page, the following resources can help you craft and contribute to documentation:
16

Suzanne Selhorn's avatar
Suzanne Selhorn committed
17
- [Doc contribution guidelines](../index.md)
18
- [Recommended word list](word_list.md)
Suzanne Selhorn's avatar
Suzanne Selhorn committed
19 20 21 22 23
- [Doc style and consistency testing](../testing.md)
- [UI text guidelines](https://design.gitlab.com/content/error-messages/)
- [GitLab Handbook style guidelines](https://about.gitlab.com/handbook/communication/#writing-style-guidelines)
- [Microsoft Style Guide](https://docs.microsoft.com/en-us/style-guide/welcome/)
- [Google Developer Documentation Style Guide](https://developers.google.com/style)
24
- [Recent updates to this guide](https://gitlab.com/dashboard/merge_requests?scope=all&state=merged&label_name[]=tw-style&not[label_name][]=docs%3A%3Afix)
25 26 27

## Documentation is the single source of truth (SSOT)

Suzanne Selhorn's avatar
Suzanne Selhorn committed
28 29
The GitLab documentation is the SSOT for all
information related to GitLab implementation, usage, and troubleshooting. It evolves
30 31 32 33 34 35 36 37 38
continuously, in keeping with new products and features, and with improvements
for clarity, accuracy, and completeness.

This policy prevents information silos, making it easier to find information
about GitLab products.

It also informs decisions about the kinds of content we include in our
documentation.

Suzanne Selhorn's avatar
Suzanne Selhorn committed
39
### The documentation includes all information
40 41

Include problem-solving actions that may address rare cases or be considered
42
risky, but provide proper context through fully detailed
43 44 45 46 47
warnings and caveats. This kind of content should be included as it could be
helpful to others and, when properly explained, its benefits outweigh the risks.
If you think you have found an exception to this rule, contact the
Technical Writing team.

Suzanne Selhorn's avatar
Suzanne Selhorn committed
48
GitLab adds all troubleshooting information to the documentation, no matter how
Suzanne Selhorn's avatar
Suzanne Selhorn committed
49
unlikely a user is to encounter a situation.
50

Suzanne Selhorn's avatar
Suzanne Selhorn committed
51 52 53 54 55
GitLab Support maintains their own
[troubleshooting content](../../../administration/index.md#support-team-docs)
in the GitLab documentation.

### The documentation includes all media types
56 57

Include any media types/sources if the content is relevant to readers. You can
58
freely include or link presentations, diagrams, and videos. No matter who
59 60 61 62
it was originally composed for, if it is helpful to any of our audiences, we can
include it.

- If you use an image that has a separate source file (for example, a vector or
63
  diagram format), link the image to the source file so that anyone can update or reuse it.
64 65 66 67
- Do not copy and paste content from other sources unless it is a limited
  quotation with the source cited. Typically it is better to either rephrase
  relevant information in your own words or link out to the other source.

Suzanne Selhorn's avatar
Suzanne Selhorn committed
68
### Topic types
69 70

In the software industry, it is a best practice to organize documentation in
Suzanne Selhorn's avatar
Suzanne Selhorn committed
71
different types. For example:
72

Suzanne Selhorn's avatar
Suzanne Selhorn committed
73 74 75 76
- Concepts
- Tasks
- Reference
- Troubleshooting
77

Suzanne Selhorn's avatar
Suzanne Selhorn committed
78 79
At GitLab, we have not traditionally used topic types. However, we are starting to
move in this direction, so we can address these issues:
80

Suzanne Selhorn's avatar
Suzanne Selhorn committed
81 82 83 84 85 86 87
- **Content is hard to find.** Our docs are comprehensive and include a large amount of
  useful information. Topic types create repeatable patterns that make our content easier
  to scan and parse.
- **Content is often written from the contributor's point of view.**  Our docs
  are written by contributors. Topic types (tasks specifically) help put
  information into a format that is geared toward helping others, rather than
  documenting how a feature was implemented.
88

Suzanne Selhorn's avatar
Suzanne Selhorn committed
89
GitLab uses these [topic type templates](../structure.md).
90

Suzanne Selhorn's avatar
Suzanne Selhorn committed
91
### Link instead of repeating text
92

Suzanne Selhorn's avatar
Suzanne Selhorn committed
93 94
Rather than repeating information from another topic, link to the single source
of truth and explain why it is important.
95 96 97

### Docs-first methodology

98
We employ a documentation-first methodology. This method ensures the documentation
99
remains a complete and trusted resource, and makes communicating about the use
100 101 102 103
of GitLab more efficient.

- If the answer to a question exists in documentation, share the link to the
  documentation instead of rephrasing the information.
104
- When you encounter new information not available in GitLab documentation (for
105 106 107 108
  example, when working on a support case or testing a feature), your first step
  should be to create a merge request (MR) to add this information to the
  documentation. You can then share the MR to communicate this information.

Suzanne Selhorn's avatar
Suzanne Selhorn committed
109 110
New information that would be useful toward the future usage or troubleshooting
of GitLab should not be written directly in a forum or other messaging system,
Marcel Amirault's avatar
Marcel Amirault committed
111
but added to a documentation MR and then referenced, as described above.
112

113 114
The more we reflexively add information to the documentation, the more
the documentation helps others efficiently accomplish tasks and solve problems.
115 116

If you have questions when considering, authoring, or editing documentation, ask
117 118 119
the Technical Writing team. They're available on Slack in `#docs` or in GitLab by
mentioning [the writer for](https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments)
the applicable [DevOps stage or group](https://about.gitlab.com/handbook/product/categories/#devops-stages).
120 121 122 123
Otherwise, forge ahead with your best effort. It does not need to be perfect;
the team is happy to review and improve upon your content. Review the
[Documentation guidelines](index.md) before you begin your first documentation MR.

124
Maintaining a knowledge base separate from the documentation would
125 126 127 128 129 130 131
be against the documentation-first methodology, because the content would overlap with
the documentation.

## Markdown

All GitLab documentation is written using [Markdown](https://en.wikipedia.org/wiki/Markdown).

132 133 134 135
The [documentation website](https://docs.gitlab.com) uses [GitLab Kramdown](https://gitlab.com/gitlab-org/gitlab_kramdown),
a "flavored" Kramdown engine to render pages from Markdown to HTML. The use of Kramdown's
features is limited by our linters, so, use regular Markdown and follow the rules in the
linked style guide. You can't use Kramdown-specific markup (for example, `{:.class}`).
136 137 138

### HTML in Markdown

139
Hard-coded HTML is valid, although it's discouraged from being used. HTML is permitted if:
140 141 142 143 144 145 146 147 148 149 150 151

- There's no equivalent markup in Markdown.
- Advanced tables are necessary.
- Special styling is required.
- Reviewed and approved by a technical writer.

### Markdown Rules

GitLab ensures that the Markdown used across all documentation is consistent, as
well as easy to review and maintain, by [testing documentation changes](../testing.md)
with [markdownlint](../testing.md#markdownlint). This lint test fails when any
document has an issue with Markdown formatting that may cause the page to render
152
incorrectly in GitLab. It also fails when a document has
153 154 155 156 157 158 159
non-standard Markdown (which may render correctly, but is not the current
standard for GitLab documentation).

#### Markdown rule `MD044/proper-names` (capitalization)

A rule that could cause confusion is `MD044/proper-names`, as it might not be
immediately clear what caused markdownlint to fail, or how to correct the
160
failure. This rule checks a list of known words, listed in the `.markdownlint.yml`
161
file in each project, to verify proper use of capitalization and backticks.
Suzanne Selhorn's avatar
Suzanne Selhorn committed
162
Words in backticks are ignored by markdownlint.
163 164

In general, product names should follow the exact capitalization of the official
165
names of the products, protocols, and so on.
166 167 168 169 170 171 172 173 174 175

Some examples fail if incorrect capitalization is used:

- MinIO (needs capital `IO`)
- NGINX (needs all capitals)
- runit (needs lowercase `r`)

Additionally, commands, parameters, values, filenames, and so on must be
included in backticks. For example:

176 177 178
- "Change the `needs` keyword in your `.gitlab-ci.yml`..."
  - `needs` is a parameter, and `.gitlab-ci.yml` is a file, so both need backticks.
    Additionally, `.gitlab-ci.yml` without backticks fails markdownlint because it
179 180 181 182 183 184 185
    does not have capital G or L.
- "Run `git clone` to clone a Git repository..."
  - `git clone` is a command, so it must be lowercase, while Git is the product,
    so it must have a capital G.

## Structure

Suzanne Selhorn's avatar
Suzanne Selhorn committed
186 187
We include concept and task topic types in the same larger topic.

188
In general, we have one topic that's a landing page.
Suzanne Selhorn's avatar
Suzanne Selhorn committed
189 190
Below that topic in the left nav are individual topics. Each of these include a concept
and multiple related tasks, reference, and troubleshooting topics.
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210

### Folder structure overview

The documentation is separated by top-level audience folders [`user`](https://gitlab.com/gitlab-org/gitlab-foss/tree/master/doc/user),
[`administration`](https://gitlab.com/gitlab-org/gitlab-foss/tree/master/doc/administration),
and [`development`](https://gitlab.com/gitlab-org/gitlab-foss/tree/master/doc/development)
(contributing) folders.

Beyond that, we primarily follow the structure of the GitLab user interface or
API.

Our goal is to have a clear hierarchical structure with meaningful URLs like
`docs.gitlab.com/user/project/merge_requests/`. With this pattern, you can
immediately tell that you are navigating to user-related documentation about
Project features; specifically about Merge Requests. Our site's paths match
those of our repository, so the clear structure also makes documentation easier
to update.

Put files for a specific product area into the related folder:

211
| Directory             | Contents |
Suzanne Selhorn's avatar
Suzanne Selhorn committed
212
|:----------------------|:------------------|
213
| `doc/user/`           | Documentation for users. Anything that can be done in the GitLab user interface goes here, including usage of the `/admin` interface. |
Suzanne Selhorn's avatar
Suzanne Selhorn committed
214
| `doc/administration/` | Documentation that requires the user to have access to the server where GitLab is installed. Administrator settings in the GitLab user interface are under `doc/user/admin_area/`. |
215
| `doc/api/`            | Documentation for the API. |
216
| `doc/development/`    | Documentation related to the development of GitLab, whether contributing code or documentation. Related process and style guides should go here. |
Suzanne Selhorn's avatar
Suzanne Selhorn committed
217
| `doc/legal/`          | Legal documents about contributing to GitLab. |
218 219
| `doc/install/`        | Instructions for installing GitLab. |
| `doc/update/`         | Instructions for updating GitLab. |
Suzanne Selhorn's avatar
Suzanne Selhorn committed
220
| `doc/topics/`         | Indexes per topic (`doc/topics/topic_name/index.md`): all resources for that topic. |
221 222 223

### Work with directories and files

224
When working with directories and files:
225 226

1. When you create a new directory, always start with an `index.md` file.
227 228
   Don't use another filename and do not create `README.md` files.
1. Do not use special characters and spaces, or capital letters in file
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
   names, directory names, branch names, and anything that generates a path.
1. When creating or renaming a file or directory and it has more than one word
   in its name, use underscores (`_`) instead of spaces or dashes. For example,
   proper naming would be `import_project/import_from_github.md`. This applies
   to both image files and Markdown files.
1. For image files, do not exceed 100KB.
1. Do not upload video files to the product repositories.
   [Link or embed videos](#videos) instead.
1. There are four main directories: `user`, `administration`, `api`, and
   `development`.
1. The `doc/user/` directory has five main subdirectories: `project/`, `group/`,
   `profile/`, `dashboard/` and `admin_area/`.
   - `doc/user/project/` should contain all project related documentation.
   - `doc/user/group/` should contain all group related documentation.
   - `doc/user/profile/` should contain all profile related documentation.
     Every page you would navigate under `/profile` should have its own document,
     for example, `account.md`, `applications.md`, or `emails.md`.
   - `doc/user/dashboard/` should contain all dashboard related documentation.
Suzanne Selhorn's avatar
Suzanne Selhorn committed
247 248 249 250
   - `doc/user/admin_area/` should contain all administrator-related
     documentation describing what can be achieved by accessing the GitLab
     administrator interface (not to be confused with `doc/administration` where
     server access is required).
251 252 253 254 255 256
     - Every category under `/admin/application_settings/` should have its
      own document located at `doc/user/admin_area/settings/`. For example,
      the **Visibility and Access Controls** category should have a document
      located at `doc/user/admin_area/settings/visibility_and_access_controls.md`.
1. The `doc/topics/` directory holds topic-related technical content. Create
   `doc/topics/topic_name/subtopic_name/index.md` when subtopics become necessary.
Suzanne Selhorn's avatar
Suzanne Selhorn committed
257
   General user and administrator documentation should be placed accordingly.
258 259 260 261 262
1. The `/university/` directory is *deprecated* and the majority of its documentation
   has been moved.

If you're unsure where to place a document or a content addition, this shouldn't
stop you from authoring and contributing. Use your best judgment, and then ask
263
the reviewer of your MR to confirm your decision. You can also ask a technical writer at
Suzanne Selhorn's avatar
Suzanne Selhorn committed
264
any stage in the process. The technical writing team reviews all
265 266 267 268 269 270
documentation changes, regardless, and can move content if there is a better
place for it.

### Avoid duplication

Do not include the same information in multiple places.
Suzanne Selhorn's avatar
Suzanne Selhorn committed
271
[Link to a single source of truth instead.](#link-instead-of-repeating-text)
272 273 274

### References across documents

275 276 277
- Give each folder an `index.md` page that introduces the topic, and both introduces
  and links to the child pages, including to the index pages of
  any next-level sub-paths.
278 279 280 281 282 283 284
- To ensure discoverability, ensure each new or renamed doc is linked from its
  higher-level index page and other related pages.
- When making reference to other GitLab products and features, link to their
  respective documentation, at least on first mention.
- When making reference to third-party products or technologies, link out to
  their external sites, documentation, and resources.

285
### Structure in documents
286 287 288 289 290 291 292 293 294

- Include any and all applicable subsections as described on the
  [structure and template](../structure.md) page.
- Structure content in alphabetical order in tables, lists, and so on, unless
  there's a logical reason not to (for example, when mirroring the user
  interface or an otherwise ordered sequence).

## Language

295
GitLab documentation should be clear and easy to understand.
296

297
- Avoid unnecessary words.
Susan Tacker's avatar
Susan Tacker committed
298
- Be clear, concise, and stick to the goal of the topic.
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
- Write in US English with US grammar. (Tested in [`British.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/British.yml).)

### Capitalization

#### Headings

Use sentence case. For example:

- `# Use variables to configure pipelines`
- `## Use the To-Do List`

#### UI text

When referring to specific user interface text, like a button label or menu
item, use the same capitalization that's displayed in the user interface.
Standards for this content are listed in the [Pajamas Design System Content section](https://design.gitlab.com/content/punctuation/)
315
and typically match what's mentioned in this Documentation Style Guide.
316

317
If you think the user interface text contains style mistakes,
318 319 320 321
create an issue or an MR to propose a change to the user interface text.

#### Feature names

322 323
- Feature names are typically lowercase.
- Some features are capitalized, typically nouns that name GitLab-specific
324
  capabilities or tools.
325

326 327 328
See the [word list](word_list.md) for details.

If the term is not in the word list, ask a GitLab Technical Writer for advice.
329 330 331 332 333 334 335 336 337 338

Do not match the capitalization of terms or phrases on the [Features page](https://about.gitlab.com/features/)
or [features.yml](https://gitlab.com/gitlab-com/www-gitlab-com/blob/master/data/features.yml)
by default.

#### Other terms

Capitalize names of:

- GitLab [product tiers](https://about.gitlab.com/pricing/). For example,
Craig Norris's avatar
Craig Norris committed
339
  GitLab Free and GitLab Ultimate. (Tested in [`BadgeCapitalization.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/BadgeCapitalization.yml).)
340 341 342
- Third-party organizations, software, and products. For example, Prometheus,
  Kubernetes, Git, and The Linux Foundation.
- Methods or methodologies. For example, Continuous Integration,
343
  Continuous Deployment, Scrum, and Agile.
344

345
Follow the capitalization style listed at the authoritative source
346 347 348 349 350 351
for the entity, which may use non-standard case styles. For example: GitLab and
npm.

### Fake user information

You may need to include user information in entries such as a REST call or user profile.
352 353
Do not use real user information or email addresses in GitLab documentation. For email
addresses and names, use:
354

355 356
- Email addresses: Use an email address ending in `example.com`.
- Names: Use strings like `example_username`. Alternatively, use diverse or
357 358 359 360 361 362 363 364
  non-gendered names with common surnames, such as `Sidney Jones`, `Zhang Wei`,
  or `Alex Garcia`.

### Fake URLs

When including sample URLs in the documentation, use:

- `example.com` when the domain name is generic.
365 366
- `gitlab.example.com` when referring only to self-managed GitLab instances.
  Use `gitlab.com` for GitLab SaaS instances.
367 368 369 370 371 372 373

### Fake tokens

There may be times where a token is needed to demonstrate an API call using
cURL or a variable used in CI. It is strongly advised not to use real tokens in
documentation even if the probability of a token being exploited is low.

374
You can use these fake tokens as examples:
375 376 377

| Token type            | Token value                                                        |
|:----------------------|:-------------------------------------------------------------------|
378
| Personal access token | `<your_access_token>`                                             |
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
| Application ID        | `2fcb195768c39e9a94cec2c2e32c59c0aad7a3365c10892e8116b5d83d4096b6` |
| Application secret    | `04f294d1eaca42b8692017b426d53bbc8fe75f827734f0260710b83a556082df` |
| CI/CD variable        | `Li8j-mLUVA3eZYjPfd_H`                                             |
| Specific runner token | `yrnZW46BrtBFqM7xDzE7dddd`                                         |
| Shared runner token   | `6Vk7ZsosqQyfreAxXTZr`                                             |
| Trigger token         | `be20d8dcc028677c931e04f3871a9b`                                   |
| Webhook secret token  | `6XhDroRcYPM5by_h-HLY`                                             |
| Health check token    | `Tu7BgjR9qeZTEyRzGG2P`                                             |
| Request profile token | `7VgpS4Ax5utVD2esNstz`                                             |

### Contractions

Contractions are encouraged, and can create a friendly and informal tone,
especially in tutorials, instructional documentation, and
[user interfaces](https://design.gitlab.com/content/punctuation/#contractions).

Some contractions, however, should be avoided:

397
<!-- vale gitlab.Possessive = NO -->
398

399 400 401 402 403 404
| Do not use a contraction      | Example                                          | Use instead                                                      |
|-------------------------------|--------------------------------------------------|------------------------------------------------------------------|
| With a proper noun and a verb | The **Container Registry's** a powerful feature. | The **Container Registry** is a powerful feature.                |
| To emphasize a negative       | **Don't** install X with Y.                      | **Do not** install X with Y.                                     |
| In reference documentation    | **Don't** set a limit.                           | **Do not** set a limit.                                          |
| In error messages             | Requests to localhost **aren't** allowed.        | Requests to localhost **are not** allowed.                        |
405

406
<!-- vale gitlab.Possessive = YES -->
407

408 409 410 411 412
### Acronyms

If you use an acronym, spell it out on first use on a page. You do not need to spell it out more than once on a page.
When possible, try to avoid acronyms in headings.

413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
## Text

- [Write in Markdown](#markdown).
- Splitting long lines (preferably up to 100 characters) can make it easier to
  provide feedback on small chunks of text.
- Insert an empty line for new paragraphs.
- Insert an empty line between different markups (for example, after every
  paragraph, header, list, and so on). Example:

  ```markdown
  ## Header

  Paragraph.

  - List item 1
  - List item 2
  ```

431 432 433 434 435 436 437 438 439
### Comments

To embed comments within Markdown, use standard HTML comments that are not rendered
when published. Example:

```html
<!-- This is a comment that is not rendered -->
```

440 441
### Emphasis

442 443 444 445
Use **bold** rather than italic to provide emphasis. GitLab uses a sans-serif font and italic text does not stand out as much as it would in a serif font. For details, see [Butterick's Practical Typography guide on bold or italic](https://practicaltypography.com/bold-or-italic.html).

You can use italics when you are introducing a term for the first time. Otherwise, use bold.

446 447 448 449 450 451 452 453 454 455 456 457
- Use double asterisks (`**`) to mark a word or text in bold (`**bold**`).
- Use underscore (`_`) for text in italics (`_italic_`).
- Use greater than (`>`) for blockquotes.

### Punctuation

Follow these guidelines for punctuation:

<!-- vale gitlab.Repetition = NO -->

| Rule                                                             | Example                                                |
|------------------------------------------------------------------|--------------------------------------------------------|
458 459 460
| Avoid semicolons. Use two sentences instead.                     | That's the way that the world goes 'round. You're up one day and the next you're down.
| Always end full sentences with a period.                         | For a complete overview, read through this document. |
| Always add a space after a period when beginning a new sentence. | For a complete overview, check this doc. For other references, check out this guide. |
461 462
| Do not use double spaces. (Tested in [`SentenceSpacing.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/SentenceSpacing.yml).) | --- |
| Do not use tabs for indentation. Use spaces instead. You can configure your code editor to output spaces instead of tabs when pressing the tab key. | --- |
463 464 465
| Use serial commas (Oxford commas) before the final **and** or **or** in a list of three or more items. (Tested in [`OxfordComma.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/OxfordComma.yml).) | You can create new issues, merge requests, and milestones. |
| Always add a space before and after dashes when using it in a sentence (for replacing a comma, for example). | You should try this - or not. |
| When a colon is part of a sentence, always use lowercase after the colon. | Linked issues: a way to create a relationship between issues. |
466
| Do not use typographer's quotes. Use straight quotes instead. (Tested in [`NonStandardQuotes.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/NonStandardQuotes.yml).) | "It's the questions we can't answer that teach us the most"---Patrick Rothfuss |
467 468 469 470 471

<!-- vale gitlab.Repetition = YES -->

### Placeholder text

Suzanne Selhorn's avatar
Suzanne Selhorn committed
472 473
You might want to provide a command or configuration that
uses specific values.
474 475 476 477 478 479 480 481 482 483 484 485 486 487 488

In these cases, use [`<` and `>`](https://en.wikipedia.org/wiki/Usage_message#Pattern)
to call out where a reader must replace text with their own value.

For example:

```shell
cp <your_source_directory> <your_destination_directory>
```

### Keyboard commands

Use the HTML `<kbd>` tag when referring to keystroke presses. For example:

```plaintext
489
To stop the command, press <kbd>Control</kbd>+<kbd>C</kbd>.
490 491 492 493
```

When the docs are generated, the output is:

494
To stop the command, press <kbd>Control</kbd>+<kbd>C</kbd>.
495

496 497 498 499 500 501 502 503
### Text entered in the UI

If you want the user to type something in the UI, use backticks. For example:

```plaintext
In the **Commit message** box, type `This is my merge request`.
```

504 505 506 507 508 509
Backticks are more precise than quotes. For example, in this string:

- In the **Commit message** box, type "This is my merge request."

It's not clear whether the user should include the period in the string.

510 511 512 513 514 515 516 517 518 519 520
### Spaces between words

Use only standard spaces between words. The search engine for the documentation
website doesn't split words separated with
[non-breaking spaces](https://en.wikipedia.org/wiki/Non-breaking_space) when
indexing, and fails to create expected individual search terms. Tests that search
for certain words separated by regular spaces can't find words separated by
non-breaking spaces.

Tested in [`lint-doc.sh`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/scripts/lint-doc.sh).

521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
## Lists

- Always start list items with a capital letter, unless they're parameters or
  commands that are in backticks, or similar.
- Always leave a blank line before and after a list.
- Begin a line with spaces (not tabs) to denote a [nested sub-item](#nesting-inside-a-list-item).

### Ordered vs. unordered lists

Only use ordered lists when their items describe a sequence of steps to follow.

Do:

```markdown
These are the steps to do something:

1. First, do the first step.
1. Then, do the next step.
1. Finally, do the last step.
```

Don't:

```markdown
This is a list of available features:

1. Feature 1
1. Feature 2
1. Feature 3
```

### Markup

- Use dashes (`-`) for unordered lists instead of asterisks (`*`).
- Prefix `1.` to every item in an ordered list. When rendered, the list items
556
  display with sequential numbering.
557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628

### Punctuation

- Don't add commas (`,`) or semicolons (`;`) to the ends of list items.
- Only add periods to the end of a list item if the item consists of a complete
  sentence (with a subject and a verb).
- Be consistent throughout the list: if the majority of the items do not end in
  a period, do not end any of the items in a period, even if they consist of a
  complete sentence. The opposite is also valid: if the majority of the items
  end with a period, end all with a period.
- Separate list items from explanatory text with a colon (`:`). For example:

  ```markdown
  The list is as follows:

  - First item: this explains the first item.
  - Second item: this explains the second item.
  ```

**Examples:**

Do:

- First list item
- Second list item
- Third list item

Don't:

- First list item
- Second list item
- Third list item.

Do:

- Let's say this is a complete sentence.
- Let's say this is also a complete sentence.
- Not a complete sentence.

Don't (vary use of periods; majority rules):

- Let's say this is a complete sentence.
- Let's say this is also a complete sentence.
- Not a complete sentence

### Nesting inside a list item

It's possible to nest items under a list item, so that they render with the same
indentation as the list item. This can be done with:

- [Code blocks](#code-blocks)
- [Blockquotes](#blockquotes)
- [Alert boxes](#alert-boxes)
- [Images](#images)

Items nested in lists should always align with the first character of the list
item. In unordered lists (using `-`), this means two spaces for each level of
indentation:

````markdown
- Unordered list item 1

  A line nested using 2 spaces to align with the `U` above.

- Unordered list item 2

  > A quote block that will nest
  > inside list item 2.

- Unordered list item 3

  ```plaintext
629
  a code block that nests inside list item 3
630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651
  ```

- Unordered list item 4

  ![an image that will nest inside list item 4](image.png)
````

For ordered lists, use three spaces for each level of indentation:

````markdown
1. Ordered list item 1

   A line nested using 3 spaces to align with the `O` above.

1. Ordered list item 2

   > A quote block that will nest
   > inside list item 2.

1. Ordered list item 3

   ```plaintext
652
   a code block that nests inside list item 3
653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
   ```

1. Ordered list item 4

   ![an image that will nest inside list item 4](image.png)
````

You can nest full lists inside other lists using the same rules as above. If you
want to mix types, that's also possible, if you don't mix items at the same
level:

```markdown
1. Ordered list item one.
1. Ordered list item two.
   - Nested unordered list item one.
   - Nested unordered list item two.
1. Ordered list item three.

- Unordered list item one.
- Unordered list item two.
  1. Nested ordered list item one.
  1. Nested ordered list item two.
- Unordered list item three.
```

## Tables

Tables should be used to describe complex information in a straightforward
manner. Note that in many cases, an unordered list is sufficient to describe a
list of items with a single, simple description per item. But, if you have data
that's best described by a matrix, tables are the best choice.

### Creation guidelines

687
To keep tables accessible and scannable, tables should not have any
688
empty cells. If there is no otherwise meaningful value for a cell, consider entering
689
**N/A** for 'not applicable' or **None**.
690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708

To help tables be easier to maintain, consider adding additional spaces to the
column widths to make them consistent. For example:

```markdown
| App name | Description          | Requirements   |
|:---------|:---------------------|:---------------|
| App 1    | Description text 1.  | Requirements 1 |
| App 2    | Description text 2.  | None           |
```

Consider installing a plugin or extension in your editor for formatting tables:

- [Markdown Table Prettifier](https://marketplace.visualstudio.com/items?itemName=darkriszty.markdown-table-prettify) for Visual Studio Code
- [Markdown Table Formatter](https://packagecontrol.io/packages/Markdown%20Table%20Formatter) for Sublime Text
- [Markdown Table Formatter](https://atom.io/packages/markdown-table-formatter) for Atom

### Feature tables

709 710
When creating tables of lists of features (such the features
available to each role on the [Permissions](../../../user/permissions.md#project-members-permissions)
711
page), use these phrases:
712 713 714 715 716 717

| Option | Markdown                 | Displayed result       |
|--------|--------------------------|------------------------|
| No     | `**{dotted-circle}** No` | **{dotted-circle}** No |
| Yes    | `**{check-circle}** Yes` | **{check-circle}** Yes |

718 719 720 721 722 723 724 725 726 727 728 729 730
### Footnotes

To indicate a footnote, use the HTML tag `<sup>` with a number.
Put the tag at the end of the sentence or term.

For the footnotes below the table, use a bold number followed by a sentence.

For example:

```markdown
| App name | Description                      |
|:---------|:---------------------------------|
| App A    | Description text. <sup>1</sup>   |
731
| App B    | Description text. <sup>2</sup>   |
732

733 734
1. This is the footnote.
1. This is the other footnote.
735 736 737 738 739 740 741 742 743
```

This text renders this output:

| App name | Description                      |
|:---------|:---------------------------------|
| App A    | Description text. <sup>1</sup>   |
| App B    | Description text. <sup>2</sup>   |

744 745
1. This is the footnote.
1. This is the other footnote.
746

747 748 749 750 751 752
## Quotes

Valid for Markdown content only, not for front matter entries:

- Standard quotes: double quotes (`"`). Example: "This is wrapped in double
  quotes".
753
- Quote inside a quote: double quotes (`"`) wrap single quotes (`'`). Example:
754
  "This sentence 'quotes' something in a quote".
755 756

For other punctuation rules, refer to the
757
[Pajamas Design System Punctuation section](https://design.gitlab.com/content/punctuation/).
758
This is overridden by the [documentation-specific punctuation rules](#punctuation).
759 760 761

## Headings

762
- Add only one H1 in each document, by adding `#` at the beginning of
763
  it (when using Markdown). The `h1` becomes the document `<title>`.
764 765 766 767 768 769 770 771 772 773 774
- Start with an `h2` (`##`), and respect the order `h2` > `h3` > `h4` > `h5` > `h6`.
  Never skip the hierarchy level, such as `h2` > `h4`
- Avoid putting numbers in headings. Numbers shift, hence documentation anchor
  links shift too, which eventually leads to dead links. If you think it is
  compelling to add numbers in headings, make sure to at least discuss it with
  someone in the Merge Request.
- [Avoid using symbols and special characters](https://gitlab.com/gitlab-org/gitlab-docs/-/issues/84)
  in headers. Whenever possible, they should be plain and short text.
- When possible, avoid including words that might change in the future. Changing
  a heading changes its anchor URL, which affects other linked pages.
- When introducing a new document, be careful for the headings to be
775 776
  grammatically and syntactically correct. Mention an [assigned technical writer (TW)](https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments)
  for review, based upon the [product category](https://about.gitlab.com/handbook/product/categories/).
777 778
  This is to ensure that no document with wrong heading is going live without an
  audit, thus preventing dead links and redirection issues when corrected.
779 780 781
- Use the context provided by parent section headings. That is, don't repeat the parent heading's text in each
  subsection's heading.
- Use articles and prepositions in headings where it would make sense in regular text.
782 783
- Leave exactly one blank line before and after a heading.
- Do not use links in headings.
Craig Norris's avatar
Craig Norris committed
784
- Add the corresponding [product badge](#product-tier-badges) according to the tier the
785 786
  feature belongs.
- Our documentation site search engine prioritizes words used in headings and
787
  subheadings. Make your subheading titles clear, descriptive, and complete to help
788 789 790 791 792 793 794 795 796 797 798
  users find the right example, as shown in the section on [heading titles](#heading-titles).
- See [Capitalization](#capitalization) for guidelines on capitalizing headings.

### Heading titles

Keep heading titles clear and direct. Make every word count. To accommodate
search engine optimization (SEO), use the imperative, where possible.

| Do                                    | Don't                                                       |
|:--------------------------------------|:------------------------------------------------------------|
| Configure GDK                         | Configuring GDK                                             |
799
| GitLab Release and Maintenance Policy | This section covers the GitLab Release and Maintenance Policy |
800 801 802 803 804
| Backport to older releases            | Backporting to older releases                               |
| GitLab Pages examples                 | Examples                                                    |

For guidelines on capitalizing headings, see the section on [capitalization](#capitalization).

805
NOTE:
806 807
If you change an existing title, be careful. In-page [anchor links](#anchor-links),
links in the GitLab application, and links from external sites can break.
808 809 810 811 812 813

### Anchor links

Headings generate anchor links when rendered. `## This is an example` generates
the anchor `#this-is-an-example`.

814
NOTE:
815
[Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/39717) in
Craig Norris's avatar
Craig Norris committed
816 817
GitLab 13.4, [product badges](#product-tier-badges) used in headings aren't
included in the generated anchor links. For example, when you link to
Craig Norris's avatar
Craig Norris committed
818
`## This is an example **(FREE)**`, use the anchor `#this-is-an-example`.
819 820

Keep in mind that the GitLab user interface links to many documentation pages
821
and anchor links to take the user to the right spot. When you change
822
a heading, search `doc/*`, `app/views/*`, and `ee/app/views/*` for the old
Evan Read's avatar
Evan Read committed
823
anchor. If you do not fix these links, the [`ui-docs-lint` job](../testing.md#ui-link-tests)
824
in your merge request fails.
825 826 827 828

Important:

- Avoid crosslinking documentation to headings unless you need to link to a
829
  specific section of the document. This avoids breaking anchors in the
830
  future in case the heading is changed.
831
- If possible, avoid changing headings, because they're not only linked internally.
832 833 834 835
  There are various links to GitLab documentation on the internet, such as
  tutorials, presentations, StackOverflow posts, and other sources.
- Do not link to `h1` headings.

Suzanne Selhorn's avatar
Suzanne Selhorn committed
836 837 838
Note that with Kramdown, it's possible to add a custom ID to an HTML element
with Markdown markup, but they don't work in `/help`. Because of this, don't use
this option.
839 840 841

## Links

Suzanne Selhorn's avatar
Suzanne Selhorn committed
842 843
Links are important in GitLab documentation. Use links instead of
summarizing to help preserve a [single source of truth](#documentation-is-the-single-source-of-truth-ssot)
844
in GitLab documentation.
845

846
We include guidance for links in these categories:
847 848 849 850 851 852 853 854 855 856 857

- How to set up [anchor links](#anchor-links) for headings.
- How to set up [criteria](#basic-link-criteria) for configuring a link.
- What to set up when [linking to a `help`](../../documentation/index.md#linking-to-help)
  page.
- How to set up [links to internal documentation](#links-to-internal-documentation)
  for cross-references.
- How to set up [links to external documentation](#links-to-external-documentation)
  for authoritative sources.
- When to use [links requiring permissions](#links-requiring-permissions).
- How to set up a [link to a video](#link-to-video).
Craig Norris's avatar
Craig Norris committed
858
- How to [include links with version text](#where-to-put-version-text).
859 860 861 862 863
- How to [link to specific lines of code](#link-to-specific-lines-of-code)

### Basic link criteria

- Use inline link Markdown markup `[Text](https://example.com)`.
864
  It's easier to read, review, and maintain. Do not use `[Text][identifier]` reference-style links.
865

866 867 868
- Use [meaningful anchor text](https://www.futurehosting.com/blog/links-should-have-meaningful-anchor-text-heres-why/).
  For example, instead of writing something like `Read more about merge requests [here](LINK)`,
  write `Read more about [merge requests](LINK)`.
869 870 871

### Links to internal documentation

872
NOTE:
873
**Internal** refers to documentation in the same project. When linking to
874 875 876 877
documentation in separate projects (for example, linking to Omnibus documentation
from GitLab documentation), you must use absolute URLs.

Do not use absolute URLs like `https://docs.gitlab.com/ee/index.html` to
878
cross-link to other documentation in the same project. Use relative links to
879 880 881 882 883 884 885 886
the file, like `../index.md`. (These are converted to HTML when the site is
rendered.)

Relative linking enables crosslinks to work:

- in Review Apps, local previews, and `/help`.
- when working on the documentation locally, so you can verify that they work as
  early as possible in the process.
887
- in the GitLab user interface when browsing doc files in their respective
888 889 890 891 892 893 894 895
  repositories. For example, the links displayed at
  `https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/README.md`.

To link to internal documentation:

- Use relative links to Markdown files in the same repository.
- Do not use absolute URLs or URLs from `docs.gitlab.com`.
- Use `../` to navigate to higher-level directories.
Craig Norris's avatar
Craig Norris committed
896 897
- Don't prepend `./` to links to files or directories. To link to a file in the
  same directory or one of its sub-directories, use the syntax `path/to/file.md`.
898 899 900 901 902 903 904 905 906 907
- Don't link relative to root. For example, `/ee/user/gitlab_com/index.md`.

  Don't:

  - `https://docs.gitlab.com/ee/administration/geo/replication/troubleshooting.html`
  - `/ee/administration/geo/replication/troubleshooting.md`
  - `./troubleshooting.md`

  Do: `../../geo/replication/troubleshooting.md`

908
- Always add the filename `file.md` at the end of the link with the `.md`
909 910 911 912 913 914 915 916 917 918 919 920 921
  extension, not `.html`.

  Don't:

  - `../../merge_requests/`
  - `../../issues/tags.html`
  - `../../issues/tags.html#stages`

  Do:

  - `../../merge_requests/index.md`
  - `../../issues/tags.md`
  - `../../issues/tags.md#stages`
922
  - `issues/tags.md`
923

924
NOTE:
925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964
Using the Markdown extension is necessary for the [`/help`](../index.md#gitlab-help)
section of GitLab.

### Links to external documentation

When describing interactions with external software, it's often helpful to
include links to external documentation. When possible, make sure that you're
linking to an [**authoritative** source](#authoritative-sources). For example,
if you're describing a feature in Microsoft's Active Directory, include a link
to official Microsoft documentation.

### Authoritative sources

When citing external information, use sources that are written by the people who
created the item or product in question. These sources are the most likely to be
accurate and remain up to date.

Examples of authoritative sources include:

- Specifications, such as a [Request for Comments](https://www.ietf.org/standards/rfcs/)
  document from the Internet Engineering Task Force.
- Official documentation for a product. For example, if you're setting up an
  interface with the Google OAuth 2 authorization server, include a link to
  Google's documentation.
- Official documentation for a project. For example, if you're citing NodeJS
  functionality, refer directly to [NodeJS documentation](https://nodejs.org/en/docs/).
- Books from an authoritative publisher.

Examples of sources to avoid include:

- Personal blog posts.
- Wikipedia.
- Non-trustworthy articles.
- Discussions on forums such as Stack Overflow.
- Documentation from a company that describes another company's product.

While many of these sources to avoid can help you learn skills and or features,
they can become obsolete quickly. Nobody is obliged to maintain any of these
sites. Therefore, we should avoid using them as reference literature.

965
NOTE:
966 967 968 969 970 971 972 973 974 975 976 977
Non-authoritative sources are acceptable only if there is no equivalent
authoritative source. Even then, focus on non-authoritative sources that are
extensively cited or peer-reviewed.

### Links requiring permissions

Don't link directly to:

- [Confidential issues](../../../user/project/issues/confidential_issues.md).
- Project features that require [special permissions](../../../user/permissions.md)
  to view.

978
These fail for:
979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998

- Those without sufficient permissions.
- Automated link checkers.

Instead:

- To reduce confusion, mention in the text that the information is either:
  - Contained in a confidential issue.
  - Requires special permission to a project to view.
- Provide a link in back ticks (`` ` ``) so that those with access to the issue
  can navigate to it.

Example:

```markdown
For more information, see the [confidential issue](../../../user/project/issues/confidential_issues.md) `https://gitlab.com/gitlab-org/gitlab-foss/-/issues/<issue_number>`.
```

### Link to specific lines of code

999 1000
When linking to specific lines in a file, link to a commit instead of to the
branch. Lines of code change over time. Linking to a line by using
1001
the commit link ensures the user lands on the line you're referring to. The
1002 1003
**Permalink** button, displayed when viewing a file in a project,
provides a link to the most recent commit of that file.
1004

1005 1006
- Do: `[link to line 3](https://gitlab.com/gitlab-org/gitlab/-/blob/11f17c56d8b7f0b752562d78a4298a3a95b5ce66/.gitlab/issue_templates/Feature%20proposal.md#L3)`
- Don't: `[link to line 3](https://gitlab.com/gitlab-org/gitlab/-/blob/master/.gitlab/issue_templates/Feature%20proposal.md#L3).`
1007

1008
If that linked expression has changed line numbers due to additional
1009 1010 1011 1012 1013
commits, you can still search the file for that query. In this case, update the
document to ensure it links to the most recent version of the file.

## Navigation

1014 1015 1016
When documenting how to navigate through the GitLab UI:

- Always use location, then action.
1017
  - From the **Visibility** dropdown list (location), select **Public** (action).
1018
- Be brief and specific. For example:
1019 1020 1021 1022 1023
  - Do: Select **Save**.
  - Do not: Select **Save** for the changes to take effect.
- If a step must include a reason, start the step with it. This helps the user scan more quickly.
  - Do: To view the changes, in the merge request, select the link.
  - Do not: Select the link in the merge request to view the changes.
1024 1025

### Names for menus
1026

1027
Use these terms when referring to the main GitLab user interface
1028 1029
elements:

1030 1031
- **Top bar**: This is the top bar that spans the width of the user interface.
  It includes the menu, the GitLab logo, search field, counters, and the user's avatar.
1032 1033 1034 1035 1036
- **Left sidebar**: This is the navigation sidebar on the left of the user
  interface, specific to the project or group.
- **Right sidebar**: This is the navigation sidebar on the right of the user
  interface, specific to the open issue, merge request, or epic.

1037 1038 1039 1040 1041 1042
### Names for UI elements

UI elements, like button and checkbox names, should be **bold**.
Guidance for each individual UI element is in [the word list](word_list.md).

### How to write navigation task steps
1043

1044 1045 1046
To be consistent, use these templates when you write navigation steps in a task topic.

To open project settings:
1047

1048
```markdown
1049
1. On the top bar, select **Menu > Projects** and find your project.
1050 1051
1. On the left sidebar, select **Settings > CI/CD**.
1. Expand **General pipelines**.
1052
```
1053

1054
To open group settings:
1055

1056
```markdown
1057
1. On the top bar, select **Menu > Groups** and find your group.
1058
1. On the left sidebar, select **Settings > CI/CD**.
1059
1. Expand **General pipelines**.
1060
```
1061

1062
To open the Admin Area:
1063

1064
```markdown
1065
1. On the top bar, select **Menu > Admin**.
1066
```
1067

1068
To select your avatar:
1069

1070 1071 1072
```markdown
1. On the top bar, in the top right corner, select your avatar.
```
1073

1074 1075 1076 1077 1078 1079 1080 1081 1082
To save the selection in some dropdown lists:

```markdown
1. Go to your issue.
1. On the right sidebar, in the **Iteration** section, select **Edit**.
1. From the dropdown list, select the iteration to associate this issue with.
1. Select any area outside the dropdown list.
```

1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097
### Optional steps

If a step is optional, start the step with the word `Optional` followed by a period.

For example:

```markdown
1. Optional. Enter a description for the job.
```

### Documenting multiple fields at once

If the UI text sufficiently explains the fields in a section, do not include a task step for every field.
Instead, summarize multiple fields in a single task step.

1098
Use the phrase **Complete the fields**.
1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118

For example:

1. On the top bar, select **Menu > Projects** and find your project.
1. On the left sidebar, select **Settings > Repository**.
1. Expand **Push rules**.
1. Complete the fields.

If you are documenting multiple fields and only one field needs explanation, do it in the same step:

1. Expand **Push rules**.
1. Complete the fields. **Branch name** must be a regular expression.

To describe multiple fields, use bullets:

1. Expand **General pipelines**.
1. Complete the fields.
   - **Branch name** must be a regular expression.
   - **User** must be a user with at least the **Maintainer** role.

1119 1120 1121
## Images

Images, including screenshots, can help a reader better understand a concept.
1122
However, they should be used sparingly because:
1123

1124 1125 1126 1127
- They tend to become out-of-date.
- They are difficult and expensive to localize.
- They cannot be read by screen readers.

1128
When needed, use images to help the reader understand:
1129

1130 1131
- Where they are in a complicated process.
- How they should interact with the application.
1132

1133
### Capture the image
1134 1135 1136

When you take screenshots:

1137 1138 1139 1140 1141 1142 1143
- **Ensure it provides value.** Don't use `lorem ipsum` text.
  Try to replicate how the feature would be used in a real-world scenario, and
  [use realistic text](#fake-user-information).
- **Capture only the relevant UI.** Don't include unnecessary white
  space or areas of the UI that don't help illustrate the point. The
  sidebars in GitLab can change, so don't include
  them in screenshots unless absolutely necessary.
1144
- **Keep it small.** If you don't need to show the full width of the screen, don't.
1145 1146 1147 1148
  Reduce the size of your browser window as much as possible to keep elements close
  together and reduce empty space. Try to keep the screenshot dimensions as small as possible.
- **Review how the image renders on the page.** Preview the image locally or use the
review app in the merge request. Make sure the image isn't blurry or overwhelming.
1149
- **Be consistent.** Coordinate screenshots with the other screenshots already on
1150
  a documentation page for a consistent reading experience.
1151

1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162
### Add callouts

If you need to emphasize an area in a screenshot, use an arrow.

- For color, use `#EE2604`. If you use the Preview application on macOS, this is the default red.
- For the line width, use 3 pt. If you use the Preview application on macOS, this is the third line in the list.
- Use the arrow style shown in the following image.
- If you have multiple arrows, make them parallel when possible.

![callout example](img/callouts.png)

1163 1164
### Save the image

1165 1166 1167 1168
- Resize any wide or tall screenshots if needed, but make sure the screenshot is
  still clear after being resized and compressed.
- All images **must** be [compressed](#compress-images) to 100KB or less.
  In many cases, 25-50KB or less is often possible without reducing image quality.
1169
- Save the image with a lowercase filename that's descriptive of the feature
1170 1171 1172 1173 1174 1175 1176
  or concept in the image:
  - If the image is of the GitLab interface, append the GitLab version to the filename,
    based on this format: `image_name_vX_Y.png`. For example, for a screenshot taken
    from the pipelines page of GitLab 11.1, a valid name is `pipelines_v11_1.png`.
  - If you're adding an illustration that doesn't include parts of the user interface,
    add the release number corresponding to the release the image was added to.
    For an MR added to 11.1's milestone, a valid name for an illustration is `devops_diagram_v11_1.png`.
1177 1178 1179
- Place images in a separate directory named `img/` in the same directory where
  the `.md` document that you're working on is located.
- Consider using PNG images instead of JPEG.
1180
- Compress GIFs with <https://ezgif.com/optimize> or similar tool.
1181 1182
- Images should be used (only when necessary) to illustrate the description
  of a process, not to replace it.
1183
- See also how to link and embed [videos](#videos) to illustrate the documentation.
1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194

### Add the image link to content

The Markdown code for including an image in a document is:
`![Image description which will be the alt tag](img/document_image_title_vX_Y.png)`

The image description is the alt text for the rendered image on the
documentation site. For accessibility and SEO, use [descriptions](https://webaim.org/techniques/alttext/)
that:

- Are accurate, succinct, and unique.
1195
- Don't use **image of** or **graphic of** to describe the image.
1196 1197 1198 1199 1200 1201 1202 1203

### Compress images

You should always compress any new images you add to the documentation. One
known tool is [`pngquant`](https://pngquant.org/), which is cross-platform and
open source. Install it by visiting the official website and following the
instructions for your OS.

1204 1205 1206
If you use macOS and want all screenshots to be compressed automatically, read
[One simple trick to make your screenshots 80% smaller](https://about.gitlab.com/blog/2020/01/30/simple-trick-for-smaller-screenshots/).

1207
GitLab has a [Ruby script](https://gitlab.com/gitlab-org/gitlab/-/blob/master/bin/pngquant)
1208
that you can use to simplify the manual process. In the root directory of your local
1209 1210 1211 1212 1213 1214
copy of `https://gitlab.com/gitlab-org/gitlab`, run in a terminal:

- Before compressing, if you want, check that all documentation PNG images have
  been compressed:

  ```shell
1215
  bin/pngquant lint
1216 1217 1218 1219 1220
  ```

- Compress all documentation PNG images using `pngquant`:

  ```shell
1221
  bin/pngquant compress
1222 1223
  ```

1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234
- Compress specific files:

  ```shell
  bin/pngquant compress doc/user/img/award_emoji_select.png doc/user/img/markdown_logo.png
  ```

- Compress all PNG files in a specific directory:

  ```shell
  bin/pngquant compress doc/user/img
  ```
1235 1236 1237

## Videos

Suzanne Selhorn's avatar
Suzanne Selhorn committed
1238
Adding GitLab YouTube video tutorials to the documentation is highly
1239 1240
encouraged, unless the video is outdated. Videos should not replace
documentation, but complement or illustrate it. If content in a video is
1241 1242 1243 1244 1245
fundamental to a feature and its key use cases, but isn't adequately
covered in the documentation, you should:

- Add this detail to the documentation text.
- Create an issue to review the video and update the page.
1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268

Do not upload videos to the product repositories. [Link](#link-to-video) or
[embed](#embed-videos) them instead.

### Link to video

To link out to a video, include a YouTube icon so that readers can scan the page
for videos before reading:

```markdown
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
For an overview, see [Video Title](link-to-video).
```

You can link any up-to-date video that's useful to the GitLab user.

### Embed videos

> [Introduced](https://gitlab.com/gitlab-org/gitlab-docs/-/merge_requests/472) in GitLab 12.1.

The [GitLab documentation site](https://docs.gitlab.com) supports embedded
videos.

Suzanne Selhorn's avatar
Suzanne Selhorn committed
1269
You can embed videos from [the official YouTube account for GitLab](https://www.youtube.com/channel/UCnMGQ8QHMAnVIsI3xJrihhg) only.
1270 1271
For videos from other sources, [link](#link-to-video) them instead.

1272 1273
In most cases, [link to a video](#link-to-video), because
embedded videos take up a lot of space on the page and can be distracting to readers.
1274 1275 1276 1277

To embed a video:

1. Copy the code from this procedure and paste it into your Markdown file. Leave a
1278
   blank line above and below it. Do not edit the code (don't remove or add any spaces).
1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312
1. In YouTube, visit the video URL you want to display. Copy the regular URL
   from your browser (`https://www.youtube.com/watch?v=VIDEO-ID`) and replace
   the video title and link in the line under `<div class="video-fallback">`.
1. In YouTube, select **Share**, and then select **Embed**.
1. Copy the `<iframe>` source (`src`) **URL only**
   (`https://www.youtube.com/embed/VIDEO-ID`),
   and paste it, replacing the content of the `src` field in the
   `iframe` tag.

```html
leave a blank line here
<div class="video-fallback">
  See the video: <a href="https://www.youtube.com/watch?v=MqL6BMOySIQ">Video title</a>.
</div>
<figure class="video-container">
  <iframe src="https://www.youtube.com/embed/MqL6BMOySIQ" frameborder="0" allowfullscreen="true"> </iframe>
</figure>
leave a blank line here
```

This is how it renders on the GitLab documentation site:

<div class="video-fallback">
  See the video: <a href="https://www.youtube.com/watch?v=enMumwvLAug">What is GitLab</a>.
</div>
<figure class="video-container">
  <iframe src="https://www.youtube.com/embed/MqL6BMOySIQ" frameborder="0" allowfullscreen="true"> </iframe>
</figure>

> Notes:
>
> - The `figure` tag is required for semantic SEO and the `video_container`
class is necessary to make sure the video is responsive and displays on
different mobile devices.
Suzanne Selhorn's avatar
Suzanne Selhorn committed
1313 1314 1315
> - The `<div class="video-fallback">` is a fallback necessary for
`/help`, because the GitLab Markdown processor doesn't support iframes. It's
hidden on the documentation site, but is displayed by `/help`.
1316 1317 1318 1319

## Code blocks

- Always wrap code added to a sentence in inline code blocks (`` ` ``).
1320
  For example, `.gitlab-ci.yml`, `git add .`, `CODEOWNERS`, or `only: [main]`.
1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332
  File names, commands, entries, and anything that refers to code should be
  added to code blocks. To make things easier for the user, always add a full
  code block for things that can be useful to copy and paste, as they can do it
  with the button on code blocks.
- HTTP methods (`HTTP POST`) and HTTP status codes, both full (`404 File Not Found`)
  and abbreviated (`404`), should be wrapped in inline code blocks when used in sentences.
  For example: Send a `DELETE` request to delete the runner. Send a `POST` request to create one.
- Add a blank line above and below code blocks.
- When providing a shell command and its output, prefix the shell command with `$`
  and leave a blank line between the command and the output.
- When providing a command without output, don't prefix the shell command with `$`.
- If you need to include triple backticks inside a code block, use four backticks
1333
  for the code block fences instead of three.
1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355
- For regular fenced code blocks, always use a highlighting class corresponding to
  the language for better readability. Examples:

  ````markdown
  ```ruby
  Ruby code
  ```

  ```javascript
  JavaScript code
  ```

  ```markdown
  [Markdown code example](example.md)
  ```

  ```plaintext
  Code or text for which no specific highlighting class is available.
  ```
  ````

Syntax highlighting is required for fenced code blocks added to the GitLab
1356
documentation. Refer to this table for the most common language classes,
1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369
or check the [complete list](https://github.com/rouge-ruby/rouge/wiki/List-of-supported-languages-and-lexers)
of available language classes:

| Preferred language tags | Language aliases and notes                                                   |
|-------------------------|------------------------------------------------------------------------------|
| `asciidoc`              |                                                                              |
| `dockerfile`            | Alias: `docker`.                                                             |
| `elixir`                |                                                                              |
| `erb`                   |                                                                              |
| `golang`                | Alias: `go`.                                                                 |
| `graphql`               |                                                                              |
| `haml`                  |                                                                              |
| `html`                  |                                                                              |
1370
| `ini`                   | For some simple configuration files that are not in TOML format.             |
1371 1372 1373 1374 1375 1376 1377
| `javascript`            | Alias `js`.                                                                  |
| `json`                  |                                                                              |
| `markdown`              | Alias: `md`.                                                                 |
| `mermaid`               |                                                                              |
| `nginx`                 |                                                                              |
| `perl`                  |                                                                              |
| `php`                   |                                                                              |
1378
| `plaintext`             | Examples with no defined language, such as output from shell commands or API calls. If a code block has no language, it defaults to `plaintext`. Alias: `text`.|
1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395
| `prometheus`            | Prometheus configuration examples.                                           |
| `python`                |                                                                              |
| `ruby`                  | Alias: `rb`.                                                                 |
| `shell`                 | Aliases: `bash` or `sh`.                                                     |
| `sql`                   |                                                                              |
| `toml`                  | Runner configuration examples, and other TOML-formatted configuration files. |
| `typescript`            | Alias: `ts`.                                                                 |
| `xml`                   |                                                                              |
| `yaml`                  | Alias: `yml`.                                                                |

For a complete reference on code blocks, see the [Kramdown guide](https://about.gitlab.com/handbook/markdown-guide/#code-blocks).

## GitLab SVG icons

> [Introduced](https://gitlab.com/gitlab-org/gitlab-docs/-/issues/384) in GitLab 12.7.

You can use icons from the [GitLab SVG library](https://gitlab-org.gitlab.io/gitlab-svgs/)
1396
directly in the documentation. For example, `**{tanuki}**` renders as: **{tanuki}**.
1397

1398 1399 1400 1401
In most cases, you should avoid using the icons in text.
However, you can use an icon when hover text is the only
available way to describe a UI element. For example, **Delete** or **Edit** buttons
often have hover text only.
1402

1403
When you do use an icon, start with the hover text and follow it with the SVG reference in parentheses.
1404

1405 1406
- Avoid: `Select **{pencil}** **Edit**.` This generates as: Select **{pencil}** **Edit**.
- Use instead: `Select **Edit** (**{pencil}**).` This generates as: Select **Edit** (**{pencil}**).
1407

1408
Do not use words to describe the icon:
1409

1410 1411
- Avoid: `Select **Erase job log** (the trash icon).`
- Use instead: `Select **Erase job log** (**{remove}**).` This generates as: Select **Erase job log** (**{remove}**).
1412 1413 1414

## Alert boxes

1415
Use alert boxes to call attention to information. Use them sparingly, and never have an alert box immediately follow another alert box.
1416

1417 1418 1419 1420 1421
Alert boxes are generated when one of these words is followed by a line break:

- `FLAG:`
- `NOTE:`
- `WARNING:`
Suzanne Selhorn's avatar
Suzanne Selhorn committed
1422
- `INFO:` (Marketing only)
1423
- `DISCLAIMER:`
1424 1425

For example:
1426

1427 1428 1429 1430
```markdown
NOTE:
This is something to note.
```
1431

1432 1433
To display an alert box for multiple paragraphs, lists, or headers, use
[blockquotes](#blockquotes) instead.
1434

1435 1436
Alert boxes render only on the GitLab documentation site (<https://docs.gitlab.com>).
In the GitLab product help, alert boxes appear as plain text.
1437

1438 1439 1440 1441 1442
### Flag

Use this alert type to describe a feature's availability. For information about how to format
`FLAG` alerts, see [Document features deployed behind feature flags](../feature_flags.md).

1443 1444
### Note

1445
Use notes sparingly. Too many notes can make topics difficult to scan.
1446

1447
Instead of adding a note:
1448

1449 1450 1451
- Re-write the sentence as part of a paragraph.
- Put the information into its own paragraph.
- Put the content under a new subheading.
1452

1453
If you must use a note, use this format:
1454 1455

```markdown
1456
NOTE:
1457 1458 1459
This is something to note.
```

1460
It renders on the GitLab documentation site as:
1461

1462
NOTE:
1463 1464
This is something to note.

1465
### Warning
1466

1467
Use a warning to indicate deprecated features, or to provide a warning about
1468
procedures that have the potential for data loss.
1469 1470

```markdown
1471 1472
WARNING:
This is something to be warned about.
1473 1474
```

1475
It renders on the GitLab documentation site as:
1476

1477 1478
WARNING:
This is something to be warned about.
1479

Suzanne Selhorn's avatar
Suzanne Selhorn committed
1480 1481 1482 1483 1484
### Info

The Marketing team uses the `INFO` alert to add information relating
to sales and marketing efforts.

1485
The text in an `INFO:` alert always renders in a floating text box to the right of the text around it.
1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499
To view the rendered GitLab docs site, check the review app in the MR. You might need to move the text up or down
in the surrounding text, depending on where you'd like to floating box to appear.

For example, if your page has text like this:

```markdown
This is an introductory paragraph. GitLab uses the SSH protocol to securely communicate with Git.
When you use SSH keys to authenticate to the GitLab remote server,
you don't need to supply your username and password each time.

INFO:
Here is some information. This information is an important addition to how you
work with GitLab and you might want to consider it.

1500 1501 1502 1503
And here is another paragraph. GitLab uses the SSH protocol to securely communicate with Git.
When you use SSH keys to authenticate to the GitLab remote server,
you don't need to supply your username and password each time.

1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522
And here is another paragraph. GitLab uses the SSH protocol to securely communicate with Git.
When you use SSH keys to authenticate to the GitLab remote server,
you don't need to supply your username and password each time.
```

It renders on the GitLab documentation site as:

This is an introductory paragraph. GitLab uses the SSH protocol to securely communicate with Git.
When you use SSH keys to authenticate to the GitLab remote server,
you don't need to supply your username and password each time.

INFO:
Here is some information. This information is an important addition to how you
work with GitLab and you might want to consider it.

And here is another paragraph. GitLab uses the SSH protocol to securely communicate with Git.
When you use SSH keys to authenticate to the GitLab remote server,
you don't need to supply your username and password each time.

1523 1524 1525 1526
And here is another paragraph. GitLab uses the SSH protocol to securely communicate with Git.
When you use SSH keys to authenticate to the GitLab remote server,
you don't need to supply your username and password each time.

1527 1528 1529 1530
### Disclaimer

Use to describe future functionality only.
For more information, see [Legal disclaimer for future features](#legal-disclaimer-for-future-features).
Suzanne Selhorn's avatar
Suzanne Selhorn committed
1531

1532 1533
## Blockquotes

1534
For highlighting a text inside a blockquote, use this format:
1535 1536 1537 1538 1539

```markdown
> This is a blockquote.
```

1540
It renders on the GitLab documentation site as:
1541 1542 1543

> This is a blockquote.

1544
If the text spans multiple lines, you can split them.
1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556

For multiple paragraphs, use the symbol `>` before every line:

```markdown
> This is the first paragraph.
>
> This is the second paragraph.
>
> - This is a list item
> - Second item in the list
```

1557
It renders on the GitLab documentation site as:
1558 1559 1560 1561 1562 1563 1564 1565 1566 1567

> This is the first paragraph.
>
> This is the second paragraph.
>
> - This is a list item
> - Second item in the list

## Terms

1568
To maintain consistency through GitLab documentation, use these styles and terms.
1569 1570 1571

### Describe UI elements

1572
Follow these styles when you're describing user interface elements in an
1573 1574 1575
application:

- For elements with a visible label, use that label in bold with matching case.
1576
  For example, `Select **Cancel**`.
1577
- For elements with a tooltip or hover label, use that label in bold with
1578
  matching case. For example, `Select **Add status emoji**`.
1579

Craig Norris's avatar
Craig Norris committed
1580
## GitLab versions
1581

1582
GitLab product documentation pages (not including [Contributor and Development](../../index.md)
Mike Jang's avatar
Mike Jang committed
1583 1584
pages in the `/development` directory) can include version information to help
users be aware of recent improvements or additions.
1585

Suzanne Selhorn's avatar
Suzanne Selhorn committed
1586 1587
The GitLab Technical Writing team determines which versions of
documentation to display on this site based on the GitLab
1588
[Statement of Support](https://about.gitlab.com/support/statement-of-support.html#version-support).
1589

Craig Norris's avatar
Craig Norris committed
1590
### View older GitLab documentation versions
1591

1592 1593
Older versions of GitLab may no longer have documentation available from `docs.gitlab.com`.
If documentation for your version is no longer available from `docs.gitlab.com`, you can still view a
Craig Norris's avatar
Craig Norris committed
1594 1595 1596 1597 1598 1599 1600 1601
tagged and released set of documentation for your installed version:

- In the [documentation archives](https://docs.gitlab.com/archives/).
- At the `/help` URL of your GitLab instance.
- In the documentation repository based on the respective branch (for example,
  the [13.2 branch](https://gitlab.com/gitlab-org/gitlab/-/tree/13-2-stable-ee/doc)).

### Where to put version text
1602

Craig Norris's avatar
Craig Norris committed
1603 1604
When a feature is added or updated, you can include its version information
either as a **Version history** item or as an inline text reference.
1605 1606 1607

#### Version text in the **Version History**

1608 1609 1610 1611
If all content in a section is related, add version text after the header for
the section. The version information must:

- Be surrounded by blank lines.
1612 1613
- Start with `>`. If there are multiple bullets, each line must start with `> -`.
- The string must include these words in this order (capitalization doesn't matter):
1614
  - `introduced`, `enabled`, `deprecated`, `changed`, `moved`, `recommended` (as in the
1615
  [feature flag documentation](../feature_flags.md)), `removed`, or `renamed`
1616 1617 1618
  - `in` or `to`
  - `GitLab`
- Whenever possible, include a link to the completed issue, merge request, or epic
1619 1620
  that introduced the feature. An issue is preferred over a merge request, and
  a merge request is preferred over an epic.
1621 1622 1623
- Do not include information about the tier, unless documenting a tier change
  (for example, `Feature X [moved](issue-link) to Premium in GitLab 19.2`).
- Do not link to the pricing page.
1624
  The tier is provided by the [product badge](#product-tier-badges) on the heading.
1625 1626 1627 1628

```markdown
## Feature name

1629
> [Introduced](<link-to-issue>) in GitLab 11.3.
1630 1631 1632

This feature does something.

1633
## Feature name 2
1634 1635

> - [Introduced](<link-to-issue>) in GitLab 11.3.
1636 1637 1638
> - [Enabled by default](<link-to-issue>) in GitLab 11.4.

This feature does something else.
1639 1640
```

1641 1642 1643 1644 1645 1646 1647
If you're documenting elements of a feature, start with the feature name or a gerund:

```markdown
> - Notifications for expiring tokens [introduced](<link-to-issue>) in GitLab 11.3.
> - Creating an issue from an issue board [introduced](<link-to-issue>) in GitLab 13.1.
```

Marcel Amirault's avatar
Marcel Amirault committed
1648 1649 1650
If a feature is moved to another tier:

```markdown
Craig Norris's avatar
Craig Norris committed
1651 1652
> - [Moved](<link-to-issue>) from GitLab Ultimate to GitLab Premium in 11.8.
> - [Moved](<link-to-issue>) from GitLab Premium to GitLab Free in 12.0.
Marcel Amirault's avatar
Marcel Amirault committed
1653 1654
```

1655 1656 1657 1658 1659 1660 1661 1662 1663 1664
#### Inline version text

If you're adding content to an existing topic, you can add version information
inline with the existing text.

In this case, add `([introduced/deprecated](<link-to-issue>) in GitLab X.X)`.

Including the issue link is encouraged, but isn't a requirement. For example:

```markdown
Craig Norris's avatar
Craig Norris committed
1665 1666
The voting strategy in GitLab 13.4 and later requires the primary and secondary
voters to agree.
1667 1668 1669 1670
```

#### End-of-life for features or products

1671
When a feature or product enters its end-of-life, indicate its status by
1672
creating a [warning alert](#alert-boxes) directly after its relevant header.
1673
If possible, link to its deprecation and removal issues.
1674 1675 1676 1677

For example:

```markdown
1678
WARNING:
1679 1680 1681 1682
This feature is in its end-of-life process. It is [deprecated](link-to-issue)
for use in GitLab X.X, and is planned for [removal](link-to-issue) in GitLab X.X.
```

Craig Norris's avatar
Craig Norris committed
1683
After the feature or product is officially deprecated and removed, remove
1684
its information from the GitLab documentation.
Craig Norris's avatar
Craig Norris committed
1685

1686 1687 1688 1689
### Versions in the past or future

When describing functionality available in past or future versions, use:

Craig Norris's avatar
Craig Norris committed
1690 1691
- Earlier, and not older or before.
- Later, and not newer or after.
1692 1693 1694

For example:

Craig Norris's avatar
Craig Norris committed
1695
- Available in GitLab 13.1 and earlier.
1696
- Available in GitLab 12.4 and later.
Craig Norris's avatar
Craig Norris committed
1697 1698
- In GitLab 12.2 and earlier, ...
- In GitLab 11.6 and later, ...
1699

1700 1701 1702 1703 1704 1705
### Promising features in future versions

Do not promise to deliver features in a future release. For example, avoid phrases like,
"Support for this feature is planned."

We cannot guarantee future feature work, and promises
1706 1707 1708 1709 1710
like these can raise legal issues. Instead, say that an issue exists.
For example:

- Support for improvements is tracked `[in this issue](LINK)`.
- You cannot do this thing, but `[an issue exists](LINK)` to change this behavior.
1711

1712
You can say that we plan to remove a feature.
1713

1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727
#### Legal disclaimer for future features

If you **must** write about features we have not yet delivered, put this exact disclaimer near the content it applies to.

```markdown
DISCLAIMER:
This page contains information related to upcoming products, features, and functionality.
It is important to note that the information presented is for informational purposes only.
Please do not rely on this information for purchasing or planning purposes.
As with all projects, the items mentioned on this page are subject to change or delay.
The development, release, and timing of any products, features, or functionality remain at the
sole discretion of GitLab Inc.
```

1728 1729 1730 1731 1732 1733 1734 1735 1736 1737
It renders on the GitLab documentation site as:

DISCLAIMER:
This page contains information related to upcoming products, features, and functionality.
It is important to note that the information presented is for informational purposes only.
Please do not rely on this information for purchasing or planning purposes.
As with all projects, the items mentioned on this page are subject to change or delay.
The development, release, and timing of any products, features, or functionality remain at the
sole discretion of GitLab Inc.

1738 1739 1740 1741
If all of the content on the page is not available, use the disclaimer once at the top of the page.

If the content in a topic is not ready, use the disclaimer in the topic.

Craig Norris's avatar
Craig Norris committed
1742
### Removing versions after each major release
1743

1744
Whenever a major GitLab release occurs, we remove all version references
Craig Norris's avatar
Craig Norris committed
1745 1746
to now-unsupported versions of GitLab. Note that this includes the removal of
specific instructions for users of non-supported GitLab versions. For example,
1747 1748
if GitLab versions 11.x and later are supported, special
instructions for users of GitLab 10 should be removed.
1749

1750
To view historical information about a feature, review GitLab
Craig Norris's avatar
Craig Norris committed
1751 1752
[release posts](https://about.gitlab.com/releases/), or search for the issue or
merge request where the work was done.
1753

1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794
### Deprecated features

When a feature is deprecated, add `(DEPRECATED)` to the page title or to
the heading of the section documenting the feature, immediately before
the tier badge:

```markdown
<!-- Page title example: -->
# Feature A (DEPRECATED) **(ALL TIERS)**

<!-- Doc section example: -->
## Feature B (DEPRECATED) **(PREMIUM SELF)**
```

Add the deprecation to the version history note (you can include a link
to a replacement when available):

```markdown
> - [Deprecated](<link-to-issue>) in GitLab 11.3. Replaced by [meaningful text](<link-to-appropriate-documentation>).
```

You can also describe the replacement in surrounding text, if available. If the
deprecation isn't obvious in existing text, you may want to include a warning:

```markdown
WARNING:
This feature was [deprecated](link-to-issue) in GitLab 12.3 and replaced by
[Feature name](link-to-feature-documentation).
```

If you add `(DEPRECATED)` to the page's title and the document is linked from the docs
navigation, either remove the page from the nav or update the nav item to include the
same text before the feature name:

```yaml
 - doc_title: (DEPRECATED) Feature A
```

In the first major GitLab version after the feature was deprecated, be sure to
remove information about that deprecated feature.

1795 1796 1797
## Products and features

Refer to the information in this section when describing products and features
1798
in the GitLab product documentation.
1799 1800 1801

### Avoid line breaks in names

1802 1803
If a feature or product name contains spaces, don't split the name with a line break.
When names change, it is more complicated to search or grep text that has line breaks.
1804

Craig Norris's avatar
Craig Norris committed
1805
### Product tier badges
1806

1807 1808
Tier badges are displayed as orange text next to a heading. These badges link to the GitLab
pricing page. For example:
1809

1810 1811 1812 1813
![Tier badge](img/tier_badge.png)

You must assign a tier badge:

1814
- To all H1 topic headings.
1815
- To topic headings that don't apply to the same tier as the H1.
1816

1817
To add a tier badge to a heading, add the relevant tier badge
1818 1819 1820
after the heading text. For example:

```markdown
1821
# Heading title **(FREE)**
1822 1823
```

1824 1825 1826
Do not add tier badges inline with other text, except for [API attributes](../restful_api_styleguide.md).
The single source of truth for a feature should be the heading where the
functionality is described.
1827 1828 1829

#### Available product tier badges

1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840
| Tier in which feature is available                                      | Tier badge            |
|:------------------------------------------------------------------------|:----------------------|
| GitLab Free self-managed and SaaS, and higher tiers                     | `**(FREE)**`          |
| GitLab Premium self-managed and SaaS, and their higher tiers            | `**(PREMIUM)**`       |
| GitLab Ultimate self-managed and SaaS                                   | `**(ULTIMATE)**`      |
| Only GitLab Free self-managed and higher tiers (no SaaS-based tiers)    | `**(FREE SELF)**`     |
| Only GitLab Premium self-managed and higher tiers (no SaaS-based tiers) | `**(PREMIUM SELF)**`  |
| Only GitLab Ultimate self-managed (no SaaS-based tiers)                 | `**(ULTIMATE SELF)**` |
| Only GitLab Free SaaS and higher tiers (no self-managed instances)      | `**(FREE SAAS)**`     |
| Only GitLab Premium SaaS and higher tiers (no self-managed instances)   | `**(PREMIUM SAAS)**`  |
| Only GitLab Ultimate SaaS (no self-managed instances)                   | `**(ULTIMATE SAAS)**` |
1841

1842
Topics that mention the `gitlab.rb` file are referring to
1843
self-managed instances of GitLab. To prevent confusion, include the relevant `TIER SELF`
1844 1845
tier badge on the highest applicable heading level on
the page.
1846 1847 1848 1849 1850 1851 1852 1853

## Specific sections

Certain styles should be applied to specific sections. Styles for specific
sections are outlined in this section.

### GitLab restart

1854 1855 1856
When a restart or reconfigure of GitLab is required, avoid duplication by linking
to [`doc/administration/restart_gitlab.md`](../../../administration/restart_gitlab.md)
with text like this, replacing 'reconfigure' with 'restart' as needed:
1857 1858 1859 1860 1861 1862

```markdown
Save the file and [reconfigure GitLab](../../../administration/restart_gitlab.md)
for the changes to take effect.
```

1863 1864 1865
If the document resides outside of the `doc/` directory, use the full path
instead of the relative link:
`https://docs.gitlab.com/ee/administration/restart_gitlab.html`.
1866 1867 1868 1869

### Installation guide

In [step 2 of the installation guide](../../../install/installation.md#2-ruby),
1870
we install Ruby from source. To update the guide for a new Ruby version:
1871

1872 1873 1874
- Change the version throughout the code block.
- Replace the sha256sum. It's available on the
  [downloads page](https://www.ruby-lang.org/en/downloads/) of the Ruby website.
1875

1876
### Configuration documentation for source and Omnibus installations
1877

1878 1879
GitLab supports two installation methods: installations from source, and Omnibus
packages. Possible configuration settings include:
1880 1881

- Settings that touch configuration files in `config/`.
1882 1883
- NGINX settings.
- Other settings in `lib/support/`.
1884

1885
Configuration procedures can require users to edit configuration files, reconfigure
Amy Qualls's avatar
Amy Qualls committed
1886 1887
GitLab, or restart GitLab. Use these styles to document these steps, replacing
`PATH/TO` with the appropriate path:
1888 1889 1890 1891 1892 1893 1894 1895 1896 1897

````markdown
**For Omnibus installations**

1. Edit `/etc/gitlab/gitlab.rb`:

   ```ruby
   external_url "https://gitlab.example.com"
   ```

Amy Qualls's avatar
Amy Qualls committed
1898
1. Save the file and [reconfigure](PATH/TO/administration/restart_gitlab.md#omnibus-gitlab-reconfigure)
1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911
   GitLab for the changes to take effect.

---

**For installations from source**

1. Edit `config/gitlab.yml`:

   ```yaml
   gitlab:
     host: "gitlab.example.com"
   ```

Amy Qualls's avatar
Amy Qualls committed
1912
1. Save the file and [restart](PATH/TO/administration/restart_gitlab.md#installations-from-source)
1913 1914 1915 1916 1917
   GitLab for the changes to take effect.
````

In this case:

1918 1919 1920 1921 1922
- Bold the installation method's name.
- Separate the methods with three dashes (`---`) to create a horizontal line.
- Indent the code blocks to line up with the list item they belong to..
- Use the appropriate syntax highlighting for each code block.
- Use the [GitLab Restart](#gitlab-restart) section to explain any required
1923 1924 1925 1926 1927 1928
  restart or reconfigure of GitLab.

## Feature flags

Learn how to [document features deployed behind flags](../feature_flags.md). For
guidance on developing GitLab with feature flags, see [Feature flags in development of GitLab](../../feature_flags/index.md).