debian-mirror-gitlab/doc/development/documentation/styleguide.md

2186 lines
92 KiB
Markdown
Raw Normal View History

2018-11-08 19:23:39 +05:30
---
2020-11-24 15:15:51 +05:30
stage: none
group: Style Guide
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers
2019-02-15 15:39:39 +05:30
description: 'Writing styles, markup, formatting, and other standards for GitLab Documentation.'
2018-11-08 19:23:39 +05:30
---
2019-02-15 15:39:39 +05:30
# Documentation Style Guide
2018-11-08 19:23:39 +05:30
2020-11-24 15:15:51 +05:30
This document defines the standards for GitLab's documentation content and
files.
2018-11-08 19:23:39 +05:30
2019-07-31 22:56:46 +05:30
For broader information about the documentation, see the [Documentation guidelines](index.md).
2018-11-08 19:23:39 +05:30
2020-11-24 15:15:51 +05:30
For guidelines specific to text in the GitLab interface, see the Pajamas [Content](https://design.gitlab.com/content/error-messages) section.
2018-12-05 23:21:45 +05:30
2020-11-24 15:15:51 +05:30
For information on how to validate styles locally or by using GitLab CI/CD, see [Testing](index.md#testing).
2018-11-20 20:47:30 +05:30
2020-11-24 15:15:51 +05:30
Use this guide for standards on grammar, formatting, word usage, and more.
You can also view a list of [recent updates to this guide](https://gitlab.com/dashboard/merge_requests?scope=all&utf8=%E2%9C%93&state=merged&label_name[]=tw-style&not[label_name][]=docs%3A%3Afix).
If you can't find what you need:
- View the GitLab Handbook for [writing style guidelines](https://about.gitlab.com/handbook/communication/#writing-style-guidelines) that apply to all GitLab content.
- Refer to one of the following:
- [Microsoft Style Guide](https://docs.microsoft.com/en-us/style-guide/).
- [Google Developer Documentation Style Guide](https://developers.google.com/style).
If you have questions about style, mention `@tw-style` in an issue or merge request, or, if you have access to the GitLab Slack workspace, use `#docs-process`.
2020-10-24 23:57:45 +05:30
2019-07-31 22:56:46 +05:30
## Documentation is the single source of truth (SSOT)
2018-11-20 20:47:30 +05:30
2019-07-31 22:56:46 +05:30
### Why a single source of truth
2018-11-20 20:47:30 +05:30
2020-11-24 15:15:51 +05:30
The documentation of GitLab products and features is the SSOT for all
information related to implementation, usage, and troubleshooting. It evolves
continuously, in keeping with new products and features, and with improvements
for clarity, accuracy, and completeness.
2019-07-31 22:56:46 +05:30
2020-11-24 15:15:51 +05:30
This policy prevents information silos, making it easier to find information
about GitLab products.
2019-07-31 22:56:46 +05:30
2020-11-24 15:15:51 +05:30
It also informs decisions about the kinds of content we include in our
documentation.
2019-07-31 22:56:46 +05:30
### All information
2020-11-24 15:15:51 +05:30
Include problem-solving actions that may address rare cases or be considered
*risky*, so long as proper context is provided in the form of fully detailed
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.
2019-07-31 22:56:46 +05:30
2020-11-24 15:15:51 +05:30
We will add all troubleshooting information to the documentation, no matter how
unlikely a user is to encounter a situation. For the [Troubleshooting sections](#troubleshooting),
people in GitLab Support can merge additions themselves.
2019-07-31 22:56:46 +05:30
### All media types
2020-11-24 15:15:51 +05:30
Include any media types/sources if the content is relevant to readers. You can
freely include or link presentations, diagrams, videos, and so on; no matter who
it was originally composed for, if it is helpful to any of our audiences, we can
include it.
2019-07-31 22:56:46 +05:30
2020-11-24 15:15:51 +05:30
- If you use an image that has a separate source file (for example, a vector or
diagram format), link the image to the source file so that it may be reused or
updated by anyone.
- 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.
2019-07-31 22:56:46 +05:30
### No special types
2020-11-24 15:15:51 +05:30
In the software industry, it is a best practice to organize documentation in
different types. For example, [Divio recommends](https://www.divio.com/blog/documentation/):
2019-07-31 22:56:46 +05:30
2020-11-24 15:15:51 +05:30
- Tutorials
- How-to guides
- Explanation
- Reference (for example, a glossary)
2019-07-31 22:56:46 +05:30
2020-11-24 15:15:51 +05:30
At GitLab, we have so many product changes in our monthly releases that we can't
afford to continuously update multiple types of information. If we have multiple
types, the information will become outdated. Therefore, we have a
[single template](structure.md) for documentation.
2019-07-31 22:56:46 +05:30
2020-11-24 15:15:51 +05:30
We currently do not distinguish specific document types, although we are open to
reconsidering this policy after the documentation has reached a future stage of
maturity and quality. If you are reading this, then despite our continuous
improvement efforts, that point hasn't been reached.
2019-07-31 22:56:46 +05:30
### Link instead of summarize
2020-11-24 15:15:51 +05:30
There is a temptation to summarize the information on another page. This will
cause the information to live in two places. Instead, link to the single source
of truth and explain why it is important to consume the information.
2019-07-31 22:56:46 +05:30
### Organize by topic, not by type
2020-11-24 15:15:51 +05:30
Beyond top-level audience-type folders (for example, `administration`), we
organize content by topic, not by type, so it can be located as easily as
possible within the single-source-of-truth (SSOT) section for the subject
matter.
2020-04-08 14:13:33 +05:30
For example, do not create groupings of similar media types. For example:
2019-07-31 22:56:46 +05:30
2020-04-08 14:13:33 +05:30
- Glossaries.
- FAQs.
- Sets of all articles or videos.
2019-07-31 22:56:46 +05:30
2020-11-24 15:15:51 +05:30
Such grouping of content by type makes it difficult to browse for the information
you need and difficult to maintain up-to-date content. Instead, organize content
by its subject (for example, everything related to CI goes together) and
cross-link between any related content.
2018-11-20 20:47:30 +05:30
2019-07-31 22:56:46 +05:30
### Docs-first methodology
2019-02-15 15:39:39 +05:30
2020-11-24 15:15:51 +05:30
We employ a *documentation-first methodology* to help ensure the documentation
remains a complete and trusted resource, and to make communicating about the use
of GitLab more efficient.
2019-07-31 22:56:46 +05:30
2020-11-24 15:15:51 +05:30
- If the answer to a question exists in documentation, share the link to the
documentation instead of rephrasing the information.
- When you encounter new information not available in GitLabs documentation (for
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 in order to communicate this
information.
2019-07-31 22:56:46 +05:30
2020-11-24 15:15:51 +05:30
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,
but added to a documentation MR and then referenced, as described above. Note
that among any other documentation changes, you can either:
2020-04-08 14:13:33 +05:30
2020-04-22 19:07:51 +05:30
- Add a [Troubleshooting section](#troubleshooting) to a doc if none exists.
2020-11-24 15:15:51 +05:30
- Un-comment and use the placeholder Troubleshooting section included as part of
our [documentation template](structure.md#template-for-new-docs), if present.
2019-07-31 22:56:46 +05:30
2020-11-24 15:15:51 +05:30
The more we reflexively add useful information to the documentation, the more
(and more successfully) the documentation will be used to efficiently accomplish
tasks and solve problems.
2019-07-31 22:56:46 +05:30
2020-11-24 15:15:51 +05:30
If you have questions when considering, authoring, or editing documentation, ask
the Technical Writing team on Slack in `#docs` or in GitLab by mentioning the
writer for the applicable [DevOps stage](https://about.gitlab.com/handbook/product/product-categories/#devops-stages).
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. Please review the
[Documentation guidelines](index.md) before you begin your first documentation MR.
2019-07-31 22:56:46 +05:30
2020-11-24 15:15:51 +05:30
Having a knowledge base in any form that is separate from the documentation would
be against the documentation-first methodology because the content would overlap with
the documentation.
2019-07-31 22:56:46 +05:30
## Markdown
All GitLab documentation is written using [Markdown](https://en.wikipedia.org/wiki/Markdown).
2020-11-24 15:15:51 +05:30
The [documentation website](https://docs.gitlab.com) uses GitLab Kramdown as its
Markdown rendering engine. For a complete Kramdown reference, see the
[GitLab Markdown Kramdown Guide](https://about.gitlab.com/handbook/markdown-guide/).
2019-02-15 15:39:39 +05:30
2020-11-24 15:15:51 +05:30
The [`gitlab-kramdown`](https://gitlab.com/gitlab-org/gitlab_kramdown) Ruby gem
will support all [GFM markup](../../user/markdown.md) in the future. That is,
all markup supported for display in the GitLab application itself. For now, use
regular Markdown markup, following the rules in the linked style guide.
2019-07-31 22:56:46 +05:30
2020-11-24 15:15:51 +05:30
Note that Kramdown-specific markup (for example, `{:.class}`) will not render
properly on GitLab instances under [`/help`](index.md#gitlab-help).
2019-07-31 22:56:46 +05:30
2020-04-22 19:07:51 +05:30
### HTML in Markdown
2020-11-24 15:15:51 +05:30
Hard-coded HTML is valid, although it's discouraged from being used while we
have `/help`. HTML is permitted as long as:
2019-09-30 21:07:59 +05:30
2020-01-01 13:55:28 +05:30
- There's no equivalent markup in Markdown.
2019-09-30 21:07:59 +05:30
- Advanced tables are necessary.
- Special styling is required.
- Reviewed and approved by a technical writer.
2019-10-12 21:52:04 +05:30
### Markdown Rules
GitLab ensures that the Markdown used across all documentation is consistent, as
2020-11-24 15:15:51 +05:30
well as easy to review and maintain, by [testing documentation changes](index.md#testing)
with [markdownlint](index.md#markdownlint). This lint test fails when any
document has an issue with Markdown formatting that may cause the page to render
incorrectly within GitLab. It will also fail when a document is using
non-standard Markdown (which may render correctly, but is not the current
standard for GitLab documentation).
2019-10-12 21:52:04 +05:30
2020-01-01 13:55:28 +05:30
#### Markdown rule `MD044/proper-names` (capitalization)
2020-11-24 15:15:51 +05:30
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
failure. This rule checks a list of known words, listed in the `.markdownlint.json`
file in each project, to verify proper use of capitalization and backticks.
Words in backticks will be ignored by markdownlint.
2020-01-01 13:55:28 +05:30
2020-11-24 15:15:51 +05:30
In general, product names should follow the exact capitalization of the official
names of the products, protocols, and so on. See [`.markdownlint.json`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/.markdownlint.json)
2020-06-23 00:09:42 +05:30
for the words tested for proper capitalization in GitLab documentation.
2020-01-01 13:55:28 +05:30
2020-05-24 23:13:21 +05:30
Some examples fail if incorrect capitalization is used:
2020-01-01 13:55:28 +05:30
- MinIO (needs capital `IO`)
- NGINX (needs all capitals)
- runit (needs lowercase `r`)
2020-11-24 15:15:51 +05:30
Additionally, commands, parameters, values, filenames, and so on must be
included in backticks. For example:
2020-01-01 13:55:28 +05:30
- "Change the `needs` keyword in your `.gitlab.yml`..."
2020-11-24 15:15:51 +05:30
- `needs` is a parameter, and `.gitlab.yml` is a file, so both need backticks.
Additionally, `.gitlab.yml` will fail markdownlint without backticks as it
does not have capital G or L.
2020-01-01 13:55:28 +05:30
- "Run `git clone` to clone a Git repository..."
2020-11-24 15:15:51 +05:30
- `git clone` is a command, so it must be lowercase, while Git is the product,
so it must have a capital G.
2020-01-01 13:55:28 +05:30
2019-07-31 22:56:46 +05:30
## Structure
2020-11-24 15:15:51 +05:30
Because we want documentation to be a SSOT, we should [organize by topic, not by
type](#organize-by-topic-not-by-type).
2019-07-31 22:56:46 +05:30
### Folder structure overview
2019-12-04 20:38:33 +05:30
The documentation is separated by top-level audience folders [`user`](https://gitlab.com/gitlab-org/gitlab-foss/tree/master/doc/user),
2020-11-24 15:15:51 +05:30
[`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.
2019-07-31 22:56:46 +05:30
2020-11-24 15:15:51 +05:30
Beyond that, we primarily follow the structure of the GitLab user interface or
API.
2019-07-31 22:56:46 +05:30
2020-11-24 15:15:51 +05:30
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
2019-07-31 22:56:46 +05:30
those of our repository, so the clear structure also makes documentation easier to update.
The table below shows what kind of documentation goes where.
2020-11-24 15:15:51 +05:30
| Directory | What belongs here |
|:----------------------|:----------------------------------------------------------------------------------------------------------------------------------------|
| `doc/user/` | User related documentation. Anything that can be done within the GitLab user interface goes here, including usage of the `/admin` interface. |
2019-07-31 22:56:46 +05:30
| `doc/administration/` | Documentation that requires the user to have access to the server where GitLab is installed. The admin settings that can be accessed via GitLab's interface exist under `doc/user/admin_area/`. |
2020-11-24 15:15:51 +05:30
| `doc/api/` | API related documentation. |
| `doc/development/` | Documentation related to the development of GitLab, whether contributing code or documentation. Related process and style guides should go here. |
| `doc/legal/` | Legal documents about contributing to GitLab. |
| `doc/install/` | Contains instructions for installing GitLab. |
| `doc/update/` | Contains instructions for updating GitLab. |
| `doc/topics/` | Indexes per topic (`doc/topics/topic-name/index.md`): all resources for that topic. |
2019-07-31 22:56:46 +05:30
2020-03-13 15:44:24 +05:30
### Work with directories and files
2019-07-31 22:56:46 +05:30
1. When you create a new directory, always start with an `index.md` file.
2020-11-24 15:15:51 +05:30
Do not use another file name and *do not* create `README.md` files.
1. *Do not* use special characters and spaces, or capital letters in file
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.
2019-07-31 22:56:46 +05:30
1. For image files, do not exceed 100KB.
2019-09-30 21:07:59 +05:30
1. Do not upload video files to the product repositories.
[Link or embed videos](#videos) instead.
2020-11-24 15:15:51 +05:30
1. There are four main directories: `user`, `administration`, `api`, and
`development`.
2019-07-31 22:56:46 +05:30
1. The `doc/user/` directory has five main subdirectories: `project/`, `group/`,
`profile/`, `dashboard/` and `admin_area/`.
1. `doc/user/project/` should contain all project related documentation.
1. `doc/user/group/` should contain all group related documentation.
1. `doc/user/profile/` should contain all profile related documentation.
Every page you would navigate under `/profile` should have its own document,
2020-04-22 19:07:51 +05:30
for example, `account.md`, `applications.md`, or `emails.md`.
2019-07-31 22:56:46 +05:30
1. `doc/user/dashboard/` should contain all dashboard related documentation.
1. `doc/user/admin_area/` should contain all admin related documentation
describing what can be achieved by accessing GitLab's admin interface
(_not to be confused with `doc/administration` where server access is
required_).
2020-03-13 15:44:24 +05:30
1. Every category under `/admin/application_settings/` should have its
2019-07-31 22:56:46 +05:30
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
2020-11-24 15:15:51 +05:30
`doc/topics/topic_name/subtopic_name/index.md` when subtopics become necessary.
2019-07-31 22:56:46 +05:30
General user- and admin- related documentation, should be placed accordingly.
2020-11-24 15:15:51 +05:30
1. The directories `/workflow/`, `/university/`, and `/articles/` have been
*deprecated* and the majority their documentation has been moved to their
correct location in small iterations.
2019-07-31 22:56:46 +05:30
2020-11-24 15:15:51 +05:30
If you are unsure where to place a document or a content addition, this should
2019-07-31 22:56:46 +05:30
not stop you from authoring and contributing. You can use your best judgment and
2020-11-24 15:15:51 +05:30
then ask the reviewer of your MR to confirm your decision, and/or ask a
technical writer at any stage in the process. The technical writing team will
review all documentation changes, regardless, and can move content if there is a
better place for it.
2019-07-31 22:56:46 +05:30
### Avoid duplication
2020-11-24 15:15:51 +05:30
Do not include the same information in multiple places.
[Link to a single source of truth instead.](#link-instead-of-summarize)
2019-07-31 22:56:46 +05:30
### References across documents
2020-11-24 15:15:51 +05:30
- Give each folder an `index.md` page that introduces the topic, introduces the
pages within, and links to the pages within (including to the index pages of
any next-level subpaths).
- 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.
2019-07-31 22:56:46 +05:30
### Structure within documents
2020-11-24 15:15:51 +05:30
- 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).
2019-02-15 15:39:39 +05:30
## Language
2020-04-22 19:07:51 +05:30
GitLab documentation should be clear and easy to understand.
- Be clear, concise, and stick to the goal of the documentation.
2020-06-23 00:09:42 +05:30
- Write in US English with US grammar. (Tested in [`British.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/British.yml).)
2020-10-24 23:57:45 +05:30
- Use [inclusive language](#inclusive-language).
2020-04-22 19:07:51 +05:30
### Point of view
2020-11-24 15:15:51 +05:30
In most cases, its appropriate to use the second-person (you, yours) point of
view, because its friendly and easy to understand. (Tested in
[`FirstPerson.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/FirstPerson.yml).)
2020-04-22 19:07:51 +05:30
<!-- How do we harmonize the second person in Pajamas with our first person plural in our doc guide? -->
### Capitalization
2020-10-24 23:57:45 +05:30
#### Headings
Use sentence case. For example:
- `# Use variables to configure pipelines`
- `## Use the To-Do List`
#### UI text
2020-11-24 15:15:51 +05:30
When referring to specific user interface text, like a button label or menu
item, use the same capitalization that is displayed in the user interface.
Standards for this content are listed in the [Pajamas Design System Content section](https://design.gitlab.com/content/punctuation/)
and typically match what is called for in this Documentation Style Guide.
2020-10-24 23:57:45 +05:30
2020-11-24 15:15:51 +05:30
If you think there is a mistake in the way the user interface text is styled,
create an issue or an MR to propose a change to the user interface text.
2020-10-24 23:57:45 +05:30
#### Feature names
2020-11-24 15:15:51 +05:30
- *Feature names are typically lowercase*, like those describing actions and
types of objects in GitLab. For example:
2020-10-24 23:57:45 +05:30
- epics
- issues
- issue weights
- merge requests
- milestones
- reorder issues
- runner, runners, shared runners
2020-11-24 15:15:51 +05:30
- a to-do, to-dos
- *Some features are capitalized*, typically nouns naming GitLab-specific
capabilities or tools. For example:
2020-10-24 23:57:45 +05:30
- GitLab CI/CD
- Repository Mirroring
- Value Stream Analytics
- the To-Do List
- the Web IDE
- Geo
- GitLab Runner (see [this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/233529) for details)
2020-11-24 15:15:51 +05:30
Document any exceptions in this style guide. If you're not sure, ask a GitLab
Technical Writer so that they can help decide and document the result.
2020-10-24 23:57:45 +05:30
2020-11-24 15:15:51 +05:30
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.
2020-10-24 23:57:45 +05:30
#### Other terms
Capitalize names of:
2020-11-24 15:15:51 +05:30
- GitLab [product tiers](https://about.gitlab.com/pricing/). For example,
GitLab Core and GitLab Ultimate. (Tested in [`BadgeCapitalization.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/BadgeCapitalization.yml).)
- Third-party organizations, software, and products. For example, Prometheus,
Kubernetes, Git, and The Linux Foundation.
- Methods or methodologies. For example, Continuous Integration,
Continuous Deployment, Scrum, and Agile. (Tested in [`.markdownlint.json`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/.markdownlint.json).)
Follow the capitalization style listed at the [authoritative source](#links-to-external-documentation)
for the entity, which may use non-standard case styles. For example: GitLab and
npm.
2020-10-24 23:57:45 +05:30
2020-11-24 15:15:51 +05:30
Use forms of *sign in*, instead of *log in* or *login*. For example:
- Sign in to GitLab.
- Open the sign-in page.
Exceptions to this rule include the concept of *single sign-on* and
references to user interface elements. For example:
- To sign in to product X, enter your credentials, and then click **Log in**.
2020-10-24 23:57:45 +05:30
### Inclusive language
2020-11-24 15:15:51 +05:30
We strive to create documentation that is inclusive. This section includes
guidance and examples in the following categories:
2020-10-24 23:57:45 +05:30
- [Gender-specific wording](#avoid-gender-specific-wording).
- [Ableist language](#avoid-ableist-language).
- [Cultural sensitivity](#culturally-sensitive-language).
2020-11-24 15:15:51 +05:30
We write our developer documentation with inclusivity and diversity in mind. This
page is not an exhaustive reference, but describes some general guidelines and
examples that illustrate some best practices to follow.
2020-10-24 23:57:45 +05:30
#### Avoid gender-specific wording
When possible, use gender-neutral pronouns. For example, you can use a singular
2020-11-24 15:15:51 +05:30
[they](https://developers.google.com/style/pronouns#gender-neutral-pronouns) as
a gender-neutral pronoun.
2020-10-24 23:57:45 +05:30
Avoid the use of gender-specific pronouns, unless referring to a specific person.
2020-11-24 15:15:51 +05:30
| Use | Avoid |
|-----------------------------------|---------------------------------|
| People, humanity | Mankind |
| GitLab Team Members | Manpower |
2020-10-24 23:57:45 +05:30
| You can install; They can install | He can install; She can install |
2020-11-24 15:15:51 +05:30
If you need to set up [Fake user information](#fake-user-information), use
diverse or non-gendered names with common surnames.
2020-10-24 23:57:45 +05:30
#### Avoid ableist language
Avoid terms that are also used in negative stereotypes for different groups.
| Use | Avoid |
|------------------------|----------------------|
| Check for completeness | Sanity check |
| Uncertain outliers | Crazy outliers |
| Slows the service | Cripples the service |
| Placeholder variable | Dummy variable |
| Active/Inactive | Enabled/Disabled |
| On/Off | Enabled/Disabled |
2020-11-24 15:15:51 +05:30
Credit: [Avoid ableist language](https://developers.google.com/style/inclusive-documentation#ableist-language)
in the Google Developer Style Guide.
2020-10-24 23:57:45 +05:30
#### Culturally sensitive language
2020-11-24 15:15:51 +05:30
Avoid terms that reflect negative cultural stereotypes and history. In most
cases, you can replace terms such as `master` and `slave` with terms that are
more precise and functional, such as `primary` and `secondary`.
2020-10-24 23:57:45 +05:30
| Use | Avoid |
|----------------------|-----------------------|
| Primary / secondary | Master / slave |
| Allowlist / denylist | Blacklist / whitelist |
For more information see the following [Internet Draft specification](https://tools.ietf.org/html/draft-knodel-terminology-02).
2019-12-21 20:55:43 +05:30
2020-05-24 23:13:21 +05:30
### Language to avoid
When creating documentation, limit or avoid the use of the following verb
tenses, words, and phrases:
2020-11-24 15:15:51 +05:30
- Avoid jargon when possible, and when not possible, define the term or
[link to a definition](#links-to-external-documentation).
- Avoid uncommon words when a more-common alternative is possible, ensuring that
content is accessible to more readers.
2020-05-24 23:13:21 +05:30
- Don't write in the first person singular.
2020-06-23 00:09:42 +05:30
(Tested in [`FirstPerson.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/FirstPerson.yml).)
2020-05-24 23:13:21 +05:30
- Instead of "I" or "me," use "we," "you," "us," or "one."
- When possible, stay user focused by writing in the second person ("you" or
the imperative).
- Don't overuse "that". In many cases, you can remove "that" from a sentence
and improve readability.
2019-12-21 20:55:43 +05:30
- Avoid use of the future tense:
2020-05-24 23:13:21 +05:30
- Instead of "after you execute this command, GitLab will display the
result", use "after you execute this command, GitLab displays the result".
- Only use the future tense to convey when the action or result will actually
occur at a future time.
- Don't use slashes to clump different words together or as a replacement for
the word "or":
- Instead of "and/or," consider using "or," or use another sensible
construction.
- Other examples include "clone/fetch," author/assignee," and
"namespace/repository name." Break apart any such instances in an
appropriate way.
- Exceptions to this rule include commonly accepted technical terms, such as
CI/CD and TCP/IP.
- <!-- vale gitlab.LatinTerms = NO -->
We discourage use of Latin abbreviations, such as "e.g.," "i.e.," or "etc.,"
as even native users of English might misunderstand them.
2020-06-23 00:09:42 +05:30
(Tested in [`LatinTerms.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/LatinTerms.yml).)
2020-04-22 19:07:51 +05:30
- Instead of "i.e.," use "that is."
- Instead of "e.g.," use "for example," "such as," "for instance," or "like."
2020-05-24 23:13:21 +05:30
- Instead of "etc.," either use "and so on" or consider editing it out, since
it can be vague.
2020-11-24 15:15:51 +05:30
<!-- vale gitlab.LatinTerms = YES -->
2020-05-24 23:13:21 +05:30
- Avoid using the word *currently* when talking about the product or its
features. The documentation describes the product as it is, and not as it
will be at some indeterminate point in the future.
2020-07-28 23:09:34 +05:30
- Avoid the using the word *scalability* with increasing GitLab's performance
for additional users. Using the words *scale* or *scaling* in other cases is
acceptable, but references to increasing GitLab's performance for additional
users should direct readers to the GitLab
[reference architectures](../../administration/reference_architectures/index.md)
page.
- Avoid all forms of the phrases *high availability* and *HA*, and instead
direct readers to the GitLab [reference architectures](../../administration/reference_architectures/index.md)
for information about configuring GitLab to have the performance needed for
additional users over time.
2020-06-23 00:09:42 +05:30
- Don't use profanity or obscenities. Doing so may negatively affect other
users and contributors, which is contrary to GitLab's value of
2020-07-28 23:09:34 +05:30
[Diversity, Inclusion, and Belonging](https://about.gitlab.com/handbook/values/#diversity-inclusion).
- Avoid the use of [racially-insensitive terminology or phrases](https://www.marketplace.org/2020/06/17/tech-companies-update-language-to-avoid-offensive-terms/). For example:
- Use *primary* and *secondary* for database and server relationships.
- Use *allowlist* and *denylist* to describe access control lists.
2020-05-24 23:13:21 +05:30
### Word usage clarifications
- Don't use "may" and "might" interchangeably:
- Use "might" to indicate the probability of something occurring. "If you
skip this step, the import process might fail."
- Use "may" to indicate giving permission for someone to do something, or
consider using "can" instead. "You may select either option on this
screen." Or, "You can select either option on this screen."
2018-11-08 19:23:39 +05:30
2020-04-08 14:13:33 +05:30
### Contractions
2020-11-24 15:15:51 +05:30
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:
2020-04-08 14:13:33 +05:30
- Do not use contractions with a proper noun and a verb. For example:
2020-11-24 15:15:51 +05:30
| Do | Don't |
|------------------------------------------|-----------------------------------------|
| GitLab is creating X. | GitLab's creating X. |
2020-04-08 14:13:33 +05:30
- Do not use contractions when you need to emphasize a negative. For example:
2020-11-24 15:15:51 +05:30
| Do | Don't |
|------------------------------------------|-----------------------------------------|
| Do *not* install X with Y. | *Don't* install X with Y. |
2020-04-08 14:13:33 +05:30
- Do not use contractions in reference documentation. For example:
2020-11-24 15:15:51 +05:30
| Do | Don't |
|------------------------------------------|-----------------------------------------|
| Do *not* set a limit greater than 1000. | *Don't* set a limit greater than 1000. |
| For `parameter1`, the default is 10. | For `parameter1`, the default's 10. |
2020-04-08 14:13:33 +05:30
- Avoid contractions in error messages. Examples:
2020-11-24 15:15:51 +05:30
| Do | Don't |
|------------------------------------------|-----------------------------------------|
| Requests to localhost are not allowed. | Requests to localhost aren't allowed. |
| Specified URL cannot be used. | Specified URL can't be used. |
2020-05-24 23:13:21 +05:30
2019-02-15 15:39:39 +05:30
## Text
2020-01-01 13:55:28 +05:30
- [Write in Markdown](#markdown).
2020-11-24 15:15:51 +05:30
- Splitting long lines (preferably up to 100 characters) can make it easier to
provide feedback on small chunks of text.
2019-07-07 11:18:12 +05:30
- Insert an empty line for new paragraphs.
2020-11-24 15:15:51 +05:30
- Insert an empty line between different markups (for example, after every
paragraph, header, list, and so on). Example:
2018-11-08 19:23:39 +05:30
2020-05-24 23:13:21 +05:30
```markdown
2019-10-12 21:52:04 +05:30
## Header
2018-11-08 19:23:39 +05:30
2019-10-12 21:52:04 +05:30
Paragraph.
2018-11-08 19:23:39 +05:30
2019-10-12 21:52:04 +05:30
- List item 1
- List item 2
```
2018-11-08 19:23:39 +05:30
2019-12-21 20:55:43 +05:30
### Emphasis
2018-11-08 19:23:39 +05:30
2019-02-15 15:39:39 +05:30
- Use double asterisks (`**`) to mark a word or text in bold (`**bold**`).
2019-07-07 11:18:12 +05:30
- Use underscore (`_`) for text in italics (`_italic_`).
2019-02-15 15:39:39 +05:30
- Use greater than (`>`) for blockquotes.
2019-12-21 20:55:43 +05:30
### Punctuation
2019-02-15 15:39:39 +05:30
2020-11-24 15:15:51 +05:30
Review the general punctuation rules for the GitLab documentation in the
following table. Check specific punctuation rules for [lists](#lists) below.
2020-10-24 23:57:45 +05:30
Additional examples are available in the [Pajamas guide for punctuation](https://design.gitlab.com/content/punctuation/).
2019-02-15 15:39:39 +05:30
2020-11-24 15:15:51 +05:30
| Rule | Example |
|------------------------------------------------------------------|--------------------------------------------------------|
| Always end full sentences with a period. | _For a complete overview, read through this document._ |
2020-04-22 19:07:51 +05:30
| 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._ |
2020-06-23 00:09:42 +05:30
| Do not use double spaces. (Tested in [`SentenceSpacing.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/SentenceSpacing.yml).) | --- |
2019-02-15 15:39:39 +05:30
| 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. | --- |
2020-06-23 00:09:42 +05:30
| Use serial commas ("Oxford commas") before the final 'and/or' in a list. (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._ |
2019-02-15 15:39:39 +05:30
| 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._ |
2020-11-24 15:15:51 +05:30
| Always use lowercase after a colon. | _Related Issues: a way to create a relationship between issues._ |
2019-02-15 15:39:39 +05:30
2019-12-21 20:55:43 +05:30
### Placeholder text
2020-11-24 15:15:51 +05:30
Often in examples, a writer will provide a command or configuration that
uses values specific to the reader.
2019-12-21 20:55:43 +05:30
2020-11-24 15:15:51 +05:30
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.
2019-12-21 20:55:43 +05:30
For example:
2020-03-13 15:44:24 +05:30
```shell
2019-12-21 20:55:43 +05:30
cp <your_source_directory> <your_destination_directory>
```
2020-11-24 15:15:51 +05:30
### Keyboard commands
Use the HTML `<kbd>` tag when referring to keystroke presses. For example:
```plaintext
To stop the command, press <kbd>Ctrl</kbd>+<kbd>C</kbd>.
```
When the docs are generated, the output is:
To stop the command, press <kbd>Ctrl</kbd>+<kbd>C</kbd>.
2019-12-04 20:38:33 +05:30
## Lists
2019-02-15 15:39:39 +05:30
2020-11-24 15:15:51 +05:30
- Always start list items with a capital letter, unless they are parameters or
commands that are in backticks, or similar.
2019-02-15 15:39:39 +05:30
- Always leave a blank line before and after a list.
2020-06-23 00:09:42 +05:30
- Begin a line with spaces (not tabs) to denote a [nested sub-item](#nesting-inside-a-list-item).
2019-10-12 21:52:04 +05:30
2019-12-04 20:38:33 +05:30
### Ordered vs. unordered lists
Only use ordered lists when their items describe a sequence of steps to follow.
Do:
2019-10-12 21:52:04 +05:30
2020-05-24 23:13:21 +05:30
```markdown
2019-12-04 20:38:33 +05:30
These are the steps to do something:
2019-10-12 21:52:04 +05:30
2019-12-04 20:38:33 +05:30
1. First, do the first step.
1. Then, do the next step.
1. Finally, do the last step.
```
2019-10-12 21:52:04 +05:30
2019-12-04 20:38:33 +05:30
Don't:
2019-10-12 21:52:04 +05:30
2020-05-24 23:13:21 +05:30
```markdown
2019-12-04 20:38:33 +05:30
This is a list of available features:
2019-10-12 21:52:04 +05:30
2019-12-04 20:38:33 +05:30
1. Feature 1
1. Feature 2
1. Feature 3
```
2018-11-08 19:23:39 +05:30
2019-12-04 20:38:33 +05:30
### Markup
2018-11-08 19:23:39 +05:30
2019-01-03 12:48:30 +05:30
- Use dashes (`-`) for unordered lists instead of asterisks (`*`).
2020-11-24 15:15:51 +05:30
- Prefix `1.` to every item in an ordered list. When rendered, the list items
will appear with sequential numbering automatically.
2019-02-15 15:39:39 +05:30
2019-12-04 20:38:33 +05:30
### Punctuation
2019-02-15 15:39:39 +05:30
2019-10-12 21:52:04 +05:30
- Do not add commas (`,`) or semicolons (`;`) to the end of list items.
2020-11-24 15:15:51 +05:30
- Only add periods to the end of a list item if the item consists of a complete
sentence. The [definition of full sentence](https://www2.le.ac.uk/offices/ld/all-resources/writing/grammar/grammar-guides/sentence)
2019-10-12 21:52:04 +05:30
is: _"a complete sentence always contains a verb, expresses a complete idea, and makes sense standing alone"_.
2020-11-24 15:15:51 +05:30
- 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.
2018-11-20 20:47:30 +05:30
- Separate list items from explanatory text with a colon (`:`). For example:
2019-02-15 15:39:39 +05:30
2020-05-24 23:13:21 +05:30
```markdown
2019-10-12 21:52:04 +05:30
The list is as follows:
2018-11-20 20:47:30 +05:30
2019-10-12 21:52:04 +05:30
- First item: this explains the first item.
- Second item: this explains the second item.
```
2019-02-15 15:39:39 +05:30
**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.
2019-12-04 20:38:33 +05:30
Don't (vary use of periods; majority rules):
2019-02-15 15:39:39 +05:30
- Let's say this is a complete sentence.
- Let's say this is also a complete sentence.
- Not a complete sentence
2019-10-12 21:52:04 +05:30
### Nesting inside a list item
2020-11-24 15:15:51 +05:30
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:
2019-10-12 21:52:04 +05:30
- [Code blocks](#code-blocks)
- [Blockquotes](#blockquotes)
- [Alert boxes](#alert-boxes)
- [Images](#images)
2020-11-24 15:15:51 +05:30
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:
2019-10-12 21:52:04 +05:30
2020-04-08 14:13:33 +05:30
````markdown
2019-10-12 21:52:04 +05:30
- 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
2020-05-24 23:13:21 +05:30
```plaintext
2019-10-12 21:52:04 +05:30
a codeblock that will next inside list item 3
```
- Unordered list item 4
![an image that will nest inside list item 4](image.png)
2020-04-08 14:13:33 +05:30
````
2019-10-12 21:52:04 +05:30
For ordered lists, use three spaces for each level of indentation:
2020-04-08 14:13:33 +05:30
````markdown
2019-10-12 21:52:04 +05:30
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
2020-05-24 23:13:21 +05:30
```plaintext
2019-10-12 21:52:04 +05:30
a codeblock that will next inside list item 3
```
1. Ordered list item 4
![an image that will nest inside list item 4](image.png)
2020-04-08 14:13:33 +05:30
````
2019-10-12 21:52:04 +05:30
2020-11-24 15:15:51 +05:30
You can nest full lists inside other lists using the same rules as above. If you
want to mix types, that is also possible, as long as you don't mix items at the
same level:
2019-10-12 21:52:04 +05:30
2020-04-22 19:07:51 +05:30
```markdown
2019-10-12 21:52:04 +05:30
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.
```
2020-05-24 23:13:21 +05:30
## 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 is best described by a matrix, tables are the best choice for use.
### Creation guidelines
2020-06-23 00:09:42 +05:30
Due to accessibility and scannability requirements, tables should not have any
2020-05-24 23:13:21 +05:30
empty cells. If there is no otherwise meaningful value for a cell, consider entering
*N/A* (for 'not applicable') or *none*.
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
When creating tables of lists of features (such as whether or not features are
available to certain roles on the [Permissions](../../user/permissions.md#project-members-permissions)
page), use the following phrases (based on the SVG icons):
- *No*: **{dotted-circle}** No
- *Yes*: **{check-circle}** Yes
2019-02-15 15:39:39 +05:30
## Quotes
2020-05-24 23:13:21 +05:30
Valid for Markdown content only, not for front matter entries:
2019-02-15 15:39:39 +05:30
2020-11-24 15:15:51 +05:30
- Standard quotes: double quotes (`"`). Example: "This is wrapped in double
quotes".
- Quote within a quote: double quotes (`"`) wrap single quotes (`'`). Example:
"I am 'quoting' something within a quote".
2019-02-15 15:39:39 +05:30
For other punctuation rules, please refer to the
[GitLab UX guide](https://design.gitlab.com/content/punctuation/).
2018-11-08 19:23:39 +05:30
## Headings
- Add **only one H1** in each document, by adding `#` at the beginning of
2020-01-01 13:55:28 +05:30
it (when using Markdown). The `h1` will be the document `<title>`.
2019-02-15 15:39:39 +05:30
- Start with an `h2` (`##`), and respect the order `h2` > `h3` > `h4` > `h5` > `h6`.
Never skip the hierarchy level, such as `h2` > `h4`
2018-11-08 19:23:39 +05:30
- 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
2018-11-20 20:47:30 +05:30
someone in the Merge Request.
2020-06-23 00:09:42 +05:30
- [Avoid using symbols and special characters](https://gitlab.com/gitlab-org/gitlab-docs/-/issues/84)
2018-11-08 19:23:39 +05:30
in headers. Whenever possible, they should be plain and short text.
2020-11-24 15:15:51 +05:30
- When possible, avoid including words that might change in the future. Changing
a heading changes its anchor URL, which affects other linked pages.
2018-11-08 19:23:39 +05:30
- When introducing a new document, be careful for the headings to be
2020-07-28 23:09:34 +05:30
grammatically and syntactically correct. Mention an [assigned technical writer (TW)](https://about.gitlab.com/handbook/product/product-categories/)
2019-02-15 15:39:39 +05:30
for review.
2020-11-24 15:15:51 +05:30
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.
2019-12-04 20:38:33 +05:30
- Leave exactly one blank line before and after a heading.
2019-02-15 15:39:39 +05:30
- Do not use links in headings.
2020-11-24 15:15:51 +05:30
- Add the corresponding [product badge](#product-badges) according to the tier the
feature belongs.
- Our documentation site search engine prioritizes words used in headings and
subheadings. Make you subheading titles clear, descriptive, and complete to help
users find the right example, as shown in the section on [heading titles](#heading-titles).
2020-04-22 19:07:51 +05:30
- See [Capitalization](#capitalization) for guidelines on capitalizing headings.
2020-03-13 15:44:24 +05:30
### Heading titles
2020-11-24 15:15:51 +05:30
Keep heading titles clear and direct. Make every word count. To accommodate
search engine optimization (SEO), use the imperative, where possible.
2020-03-13 15:44:24 +05:30
2020-11-24 15:15:51 +05:30
| Do | Don't |
|:--------------------------------------|:------------------------------------------------------------|
| Configure GDK | Configuring GDK |
2020-03-13 15:44:24 +05:30
| GitLab Release and Maintenance Policy | This section covers GitLab's Release and Maintenance Policy |
2020-11-24 15:15:51 +05:30
| Backport to older releases | Backporting to older releases |
| GitLab Pages examples | Examples |
2020-04-22 19:07:51 +05:30
For guidelines on capitalizing headings, see the section on [capitalization](#capitalization).
2020-03-13 15:44:24 +05:30
2020-04-08 14:13:33 +05:30
NOTE: **Note:**
2020-11-24 15:15:51 +05:30
If you change an existing title, be careful. Any such changes may affect not
only [links](#anchor-links) within the page, but may also affect links to the
GitLab documentation from both the GitLab application and external sites.
2020-04-08 14:13:33 +05:30
2020-03-13 15:44:24 +05:30
### Anchor links
Headings generate anchor links automatically when rendered. `## This is an example`
generates the anchor `#this-is-an-example`.
2020-11-24 15:15:51 +05:30
NOTE: **Note:**
[Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/39717) in GitLab 13.4, [product badges](#product-badges) used in headings aren't included in the
generated anchor links. For example, when you link to
`## This is an example **(CORE)**`, use the anchor `#this-is-an-example`.
Keep in mind that the GitLab user interface links to many documentation pages
and anchor links to take the user to the right spot. Therefore, when you change
a heading, search `doc/*`, `app/views/*`, and `ee/app/views/*` for the old
anchor to make sure you're not breaking an anchor linked from other
documentation nor from the GitLab user interface. If you find the old anchor, be
sure to replace it with the new one.
2020-03-13 15:44:24 +05:30
Important:
2020-11-24 15:15:51 +05:30
- Avoid crosslinking documentation to headings unless you need to link to a
specific section of the document. This will avoid breaking anchors in the
future in case the heading is changed.
2020-03-13 15:44:24 +05:30
- If possible, avoid changing headings since they're not only linked internally.
2020-11-24 15:15:51 +05:30
There are various links to GitLab documentation on the internet, such as
tutorials, presentations, StackOverflow posts, and other sources.
2020-03-13 15:44:24 +05:30
- Do not link to `h1` headings.
Note that, with Kramdown, it is possible to add a custom ID to an HTML element
with Markdown markup, but they **do not** work in GitLab's `/help`. Therefore,
do not use this option until further notice.
2018-11-08 19:23:39 +05:30
## Links
2020-11-24 15:15:51 +05:30
Links are important in GitLab documentation. They allow you to [link instead of
summarizing](#link-instead-of-summarize) to help preserve a [single source of truth](#why-a-single-source-of-truth)
within GitLab documentation.
2020-04-22 19:07:51 +05:30
We include guidance for links in the following categories:
- How to set up [anchor links](#anchor-links) for headings.
- How to set up [criteria](#basic-link-criteria) for configuring a link.
2020-11-24 15:15:51 +05:30
- 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.
2020-04-22 19:07:51 +05:30
- When to use [links requiring permissions](#links-requiring-permissions).
- How to set up a [link to a video](#link-to-video).
- How to [include links with version text](#text-for-documentation-requiring-version-text).
- How to [link to specific lines of code](#link-to-specific-lines-of-code)
### Basic link criteria
2020-01-01 13:55:28 +05:30
- Use inline link Markdown markup `[Text](https://example.com)`.
2020-11-24 15:15:51 +05:30
It's easier to read, review, and maintain. *Do not* use `[Text][identifier]`.
2019-12-21 20:55:43 +05:30
2018-11-08 19:23:39 +05:30
- Use [meaningful anchor texts](https://www.futurehosting.com/blog/links-should-have-meaningful-anchor-text-heres-why/).
2020-04-22 19:07:51 +05:30
For example, instead of writing something like `Read more about GitLab Issue Boards [here](LINK)`,
2018-11-08 19:23:39 +05:30
write `Read more about [GitLab Issue Boards](LINK)`.
2019-12-21 20:55:43 +05:30
### Links to internal documentation
2020-04-08 14:13:33 +05:30
NOTE: **Note:**
2020-11-24 15:15:51 +05:30
_Internal_ refers to documentation in the same project. When linking to
documentation in separate projects (for example, linking to Omnibus documentation
from GitLab documentation), you must use absolute URLs.
2019-12-21 20:55:43 +05:30
2020-11-24 15:15:51 +05:30
Do not use absolute URLs like `https://docs.gitlab.com/ee/index.html` to
crosslink to other documentation within the same project. Use relative links to
the file, like `../index.md`. (These are converted to HTML when the site is
rendered.)
2020-07-28 23:09:34 +05:30
Relative linking enables crosslinks to work:
- in Review Apps, local previews, and `/help`.
2020-11-24 15:15:51 +05:30
- when working on the documentation locally, so you can verify that they work as
early as possible in the process.
- within the GitLab user interface when browsing doc files in their respective
repositories. For example, the links displayed at
`https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/README.md`.
2020-07-28 23:09:34 +05:30
2020-04-08 14:13:33 +05:30
To link to internal documentation:
2019-12-21 20:55:43 +05:30
2020-04-08 14:13:33 +05:30
- 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.
- Do not link relative to root. For example, `/ee/user/gitlab_com/index.md`.
2019-12-21 20:55:43 +05:30
2020-04-08 14:13:33 +05:30
Don't:
2019-12-21 20:55:43 +05:30
2020-04-08 14:13:33 +05:30
- `https://docs.gitlab.com/ee/administration/geo/replication/troubleshooting.html`
- `/ee/administration/geo/replication/troubleshooting.md`
Do: `../../geo/replication/troubleshooting.md`
2019-12-21 20:55:43 +05:30
2020-11-24 15:15:51 +05:30
- Always add the file name `file.md` at the end of the link with the `.md`
extension, not `.html`.
2019-12-21 20:55:43 +05:30
Don't:
2020-04-08 14:13:33 +05:30
- `../../merge_requests/`
- `../../issues/tags.html`
- `../../issues/tags.html#stages`
2019-12-21 20:55:43 +05:30
Do:
2020-04-08 14:13:33 +05:30
- `../../merge_requests/index.md`
- `../../issues/tags.md`
- `../../issues/tags.md#stages`
2019-12-21 20:55:43 +05:30
2020-07-28 23:09:34 +05:30
NOTE: **Note:**
2020-11-24 15:15:51 +05:30
Using the Markdown extension is necessary for the [`/help`](index.md#gitlab-help)
section of GitLab.
2019-12-21 20:55:43 +05:30
2020-06-23 00:09:42 +05:30
### Links to external documentation
2020-11-24 15:15:51 +05:30
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.
2020-06-23 00:09:42 +05:30
2020-10-24 23:57:45 +05:30
### Authoritative sources
2020-11-24 15:15:51 +05:30
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.
2020-10-24 23:57:45 +05:30
Examples of authoritative sources include:
2020-11-24 15:15:51 +05:30
- 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/).
2020-10-24 23:57:45 +05:30
- 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.
2020-11-24 15:15:51 +05:30
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.
2020-10-24 23:57:45 +05:30
NOTE: **Note:**
2020-11-24 15:15:51 +05:30
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.
2020-10-24 23:57:45 +05:30
2019-07-31 22:56:46 +05:30
### Links requiring permissions
Don't link directly to:
2019-07-07 11:18:12 +05:30
2019-07-31 22:56:46 +05:30
- [Confidential issues](../../user/project/issues/confidential_issues.md).
2020-11-24 15:15:51 +05:30
- Project features that require [special permissions](../../user/permissions.md)
to view.
2019-07-31 22:56:46 +05:30
These will fail for:
2019-07-07 11:18:12 +05:30
- Those without sufficient permissions.
- Automated link checkers.
Instead:
2019-07-31 22:56:46 +05:30
- 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.
2020-11-24 15:15:51 +05:30
- Provide a link in back ticks (`` ` ``) so that those with access to the issue
can easily navigate to it.
2019-07-07 11:18:12 +05:30
Example:
2020-05-24 23:13:21 +05:30
```markdown
2020-06-23 00:09:42 +05:30
For more information, see the [confidential issue](../../user/project/issues/confidential_issues.md) `https://gitlab.com/gitlab-org/gitlab-foss/-/issues/<issue_number>`.
2019-03-02 22:35:43 +05:30
```
2020-04-22 19:07:51 +05:30
### Link to specific lines of code
2020-11-24 15:15:51 +05:30
When linking to specific lines within a file, link to a commit instead of to the
branch. Lines of code change through time, therefore, linking to a line by using
the commit link ensures the user lands on the line you're referring to. The
**Permalink** button, which is available when viewing a file within a project,
makes it easy to generate a link to the most recent commit of the given file.
2020-04-22 19:07:51 +05:30
2020-11-24 15:15:51 +05:30
- *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).`
2020-04-22 19:07:51 +05:30
2020-11-24 15:15:51 +05:30
If that linked expression is no longer in that line of the file due to additional
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.
2020-04-22 19:07:51 +05:30
2018-11-08 19:23:39 +05:30
## Navigation
2020-11-24 15:15:51 +05:30
To indicate the steps of navigation through the user interface:
2018-11-08 19:23:39 +05:30
2018-11-20 20:47:30 +05:30
- Use the exact word as shown in the UI, including any capital letters as-is.
2020-11-24 15:15:51 +05:30
- Use bold text for navigation items and the char "greater than" (`>`) as a
separator (for example, `Navigate to your project's **Settings > CI/CD**` ).
- If there are any expandable menus, make sure to mention that the user needs to
expand the tab to find the settings you're referring to (for example,
`Navigate to your project's **Settings > CI/CD** and expand **General pipelines**`).
2018-11-08 19:23:39 +05:30
## Images
2020-07-28 23:09:34 +05:30
Images, including screenshots, can help a reader better understand a concept.
However, they can be hard to maintain, and should be used sparingly.
2020-11-24 15:15:51 +05:30
Before including an image in the documentation, ensure it provides value to the
reader.
2020-07-28 23:09:34 +05:30
### Capture the image
2020-11-24 15:15:51 +05:30
Use images to help the reader understand where they are in a process, or how
they need to interact with the application.
2020-07-28 23:09:34 +05:30
When you take screenshots:
- *Capture the most relevant area of the page.* Don't include unnecessary white
2020-11-24 15:15:51 +05:30
space or areas of the page that don't help illustrate the point. The left
sidebar of the GitLab user interface can change, so don't include the sidebar
if it's not necessary.
- *Keep it small.* If you don't need to show the full width of the screen, don't.
A value of 1000 pixels is a good maximum width for your screenshot image.
- *Be consistent.* Coordinate screenshots with the other screenshots already on
a documentation page. For example, if other screenshots include the left
sidebar, include the sidebar in all screenshots.
2020-07-28 23:09:34 +05:30
### Save the image
- Save the image with a lowercase file name that is descriptive of the feature
or concept in the image. If the image is of the GitLab interface, append the
GitLab version to the file name, based on the following 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`.
2018-11-08 19:23:39 +05:30
- Place images in a separate directory named `img/` in the same directory where
2019-09-30 21:07:59 +05:30
the `.md` document that you're working on is located.
2018-11-08 19:23:39 +05:30
- Consider using PNG images instead of JPEG.
2020-04-22 19:07:51 +05:30
- [Compress all PNG images](#compress-images).
2018-11-08 19:23:39 +05:30
- Compress gifs with <https://ezgif.com/optimize> or similar tool.
- Images should be used (only when necessary) to _illustrate_ the description
2019-01-03 12:48:30 +05:30
of a process, not to _replace_ it.
2018-11-20 20:47:30 +05:30
- Max image size: 100KB (gifs included).
2020-11-24 15:15:51 +05:30
- See also how to link and embed [videos](#videos) to illustrate the
documentation.
2018-11-08 19:23:39 +05:30
2020-07-28 23:09:34 +05:30
### 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)`
2020-11-24 15:15:51 +05:30
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/)
2020-07-28 23:09:34 +05:30
that:
- Are accurate, succinct, and unique.
- Don't use *image of …* or *graphic of…* to describe the image.
2018-11-08 19:23:39 +05:30
2020-07-28 23:09:34 +05:30
Also, if a heading immediately follows an image, be sure to add three dashes
(`---`) between the image and the heading.
2018-11-08 19:23:39 +05:30
2019-03-02 22:35:43 +05:30
### Remove image shadow
2020-11-24 15:15:51 +05:30
All images displayed on the [GitLab documentation site](https://docs.gitlab.com)
have a box shadow by default. To remove the box shadow, use the image class
`.image-noshadow` applied directly to an HTML `img` tag:
2019-03-02 22:35:43 +05:30
```html
<img src="path/to/image.jpg" alt="Alt text (required)" class="image-noshadow">
```
2020-04-22 19:07:51 +05:30
### 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.
2020-05-24 23:13:21 +05:30
GitLab has a [Rake task](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/tasks/pngquant.rake)
2020-04-22 19:07:51 +05:30
that you can use to automate the process. In the root directory of your local
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
bundle exec rake pngquant:lint
```
- Compress all documentation PNG images using `pngquant`:
```shell
bundle exec rake pngquant:compress
```
The only caveat is that the task runs on all images under `doc/`, not only the
ones you might have included in a merge request. In that case, you can run the
compress task and only commit the images that are relevant to your merge
request.
2019-09-30 21:07:59 +05:30
## Videos
2020-11-24 15:15:51 +05:30
Adding GitLab's existing YouTube video tutorials to the documentation is highly
encouraged, unless the video is outdated. Videos should not replace
documentation, but complement or illustrate it. If content in a video is
fundamental to a feature and its key use cases, but this is not adequately
covered in the documentation, add this detail to the documentation text or
create an issue to review the video and do so.
2019-09-30 21:07:59 +05:30
2020-11-24 15:15:51 +05:30
Do not upload videos to the product repositories. [Link](#link-to-video) or
[embed](#embed-videos) them instead.
2019-09-30 21:07:59 +05:30
### Link to video
2020-11-24 15:15:51 +05:30
To link out to a video, include a YouTube icon so that readers can scan the page
for videos before reading:
2019-09-30 21:07:59 +05:30
2020-05-24 23:13:21 +05:30
```markdown
2019-09-30 21:07:59 +05:30
<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 is useful to the GitLab user.
### Embed videos
2020-03-13 15:44:24 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab-docs/-/merge_requests/472) in GitLab 12.1.
2019-09-30 21:07:59 +05:30
2020-11-24 15:15:51 +05:30
The [GitLab documentation site](https://docs.gitlab.com) supports embedded
videos.
2019-09-30 21:07:59 +05:30
2020-11-24 15:15:51 +05:30
You can only embed videos from [GitLab's official YouTube account](https://www.youtube.com/channel/UCnMGQ8QHMAnVIsI3xJrihhg).
2019-09-30 21:07:59 +05:30
For videos from other sources, [link](#link-to-video) them instead.
2020-11-24 15:15:51 +05:30
In most cases, it is better to [link to video](#link-to-video) instead, because
an embed takes up a lot of space on the page and can be distracting to readers.
2019-09-30 21:07:59 +05:30
2020-11-24 15:15:51 +05:30
To embed a video, follow the instructions below and make sure you have your MR
reviewed and approved by a technical writer.
2019-09-30 21:07:59 +05:30
2020-11-24 15:15:51 +05:30
1. Copy the code below and paste it into your Markdown file. Leave a blank line
above and below it. Do *not* edit the code (don't remove or add any spaces).
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, click **Share**, and then click **Embed**.
2019-09-30 21:07:59 +05:30
1. Copy the `<iframe>` source (`src`) **URL only**
2019-10-12 21:52:04 +05:30
(`https://www.youtube.com/embed/VIDEO-ID`),
and paste it, replacing the content of the `src` field in the
`iframe` tag.
2019-09-30 21:07:59 +05:30
```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
```
2020-11-24 15:15:51 +05:30
This is how it renders on the GitLab documentation site:
2019-09-30 21:07:59 +05:30
<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`
2020-11-24 15:15:51 +05:30
class is necessary to make sure the video is responsive and displays on
different mobile devices.
2019-09-30 21:07:59 +05:30
> - The `<div class="video-fallback">` is a fallback necessary for GitLab's
2020-11-24 15:15:51 +05:30
`/help`, as GitLab's Markdown processor does not support iframes. It's hidden on
the documentation site, but will be displayed on GitLab's `/help`.
2019-09-30 21:07:59 +05:30
2019-02-15 15:39:39 +05:30
## Code blocks
2019-10-12 21:52:04 +05:30
- Always wrap code added to a sentence in inline code blocks (`` ` ``).
2020-04-22 19:07:51 +05:30
For example, `.gitlab-ci.yml`, `git add .`, `CODEOWNERS`, or `only: [master]`.
2020-11-24 15:15:51 +05:30
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 easily
do it with the button on code blocks.
2019-10-12 21:52:04 +05:30
- Add a blank line above and below code blocks.
2020-11-24 15:15:51 +05:30
- When providing a shell command and its output, prefix the shell command with `$`
and leave a blank line between the command and the output.
2020-03-13 15:44:24 +05:30
- When providing a command without output, don't prefix the shell command with `$`.
2020-04-08 14:13:33 +05:30
- If you need to include triple backticks inside a code block, use four backticks
for the codeblock fences instead of three.
2020-11-24 15:15:51 +05:30
- For regular fenced code blocks, always use a highlighting class corresponding to
the language for better readability. Examples:
2019-02-15 15:39:39 +05:30
2020-04-08 14:13:33 +05:30
````markdown
2019-03-02 22:35:43 +05:30
```ruby
Ruby code
```
2020-04-08 14:13:33 +05:30
```javascript
2019-03-02 22:35:43 +05:30
JavaScript code
```
2019-02-15 15:39:39 +05:30
2020-04-08 14:13:33 +05:30
```markdown
2019-10-12 21:52:04 +05:30
[Markdown code example](example.md)
2019-03-02 22:35:43 +05:30
```
2019-02-15 15:39:39 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2019-10-12 21:52:04 +05:30
Code or text for which no specific highlighting class is available.
2019-03-02 22:35:43 +05:30
```
2020-04-08 14:13:33 +05:30
````
2020-11-24 15:15:51 +05:30
Syntax highlighting is required for fenced code blocks added to the GitLab
documentation. Refer to the following table for the most common language classes,
or check the [complete list](https://github.com/rouge-ruby/rouge/wiki/List-of-supported-languages-and-lexers)
of available language classes:
2020-04-08 14:13:33 +05:30
| Preferred language tags | Language aliases and notes |
|-------------------------|------------------------------------------------------------------------------|
| `asciidoc` | |
| `dockerfile` | Alias: `docker`. |
| `elixir` | |
| `erb` | |
| `golang` | Alias: `go`. |
| `graphql` | |
| `haml` | |
| `html` | |
| `ini` | For some simple config files that are not in TOML format. |
| `javascript` | Alias `js`. |
| `json` | |
| `markdown` | Alias: `md`. |
| `mermaid` | |
| `nginx` | |
| `perl` | |
| `php` | |
| `plaintext` | Examples with no defined language, such as output from shell commands or API calls. If a codeblock has no language, it defaults to `plaintext`. Alias: `text`. |
| `prometheus` | Prometheus configuration examples. |
| `python` | |
| `ruby` | Alias: `rb`. |
| `shell` | Aliases: `bash` or `sh`. |
| `sql` | |
2020-05-24 23:13:21 +05:30
| `toml` | Runner configuration examples, and other TOML-formatted configuration files. |
2020-04-08 14:13:33 +05:30
| `typescript` | Alias: `ts`. |
| `xml` | |
| `yaml` | Alias: `yml`. |
2020-11-24 15:15:51 +05:30
For a complete reference on code blocks, see the [Kramdown guide](https://about.gitlab.com/handbook/markdown-guide/#code-blocks).
2019-02-15 15:39:39 +05:30
2020-03-13 15:44:24 +05:30
## GitLab SVG icons
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab-docs/-/issues/384) in GitLab 12.7.
2020-03-13 15:44:24 +05:30
2020-11-24 15:15:51 +05:30
You can use icons from the [GitLab SVG library](https://gitlab-org.gitlab.io/gitlab-svgs/)
directly in the documentation.
2020-03-13 15:44:24 +05:30
2020-11-24 15:15:51 +05:30
This way, you can achieve a consistent look when writing about interacting with
GitLab user interface elements.
2020-03-13 15:44:24 +05:30
Usage examples:
- Icon with default size (16px): `**{icon-name}**`
Example: `**{tanuki}**` renders as: **{tanuki}**.
- Icon with custom size: `**{icon-name, size}**`
Available sizes (in px): 8, 10, 12, 14, 16, 18, 24, 32, 48, and 72
Example: `**{tanuki, 24}**` renders as: **{tanuki, 24}**.
- Icon with custom size and class: `**{icon-name, size, class-name}**`.
2020-11-24 15:15:51 +05:30
You can access any class available to this element in GitLab documentation CSS.
2020-03-13 15:44:24 +05:30
Example with `float-right`, a
[Bootstrap utility class](https://getbootstrap.com/docs/4.4/utilities/float/):
`**{tanuki, 32, float-right}**` renders as: **{tanuki, 32, float-right}**
2020-10-24 23:57:45 +05:30
### When to use icons
2020-03-13 15:44:24 +05:30
2020-11-24 15:15:51 +05:30
Icons should be used sparingly, and only in ways that aid and do not hinder the
readability of the text.
2020-03-13 15:44:24 +05:30
2020-10-24 23:57:45 +05:30
For example, the following adds little to the accompanying text:
2020-03-13 15:44:24 +05:30
2020-10-24 23:57:45 +05:30
```markdown
1. Go to **{home}** **Project overview > Details**
```
2020-03-13 15:44:24 +05:30
2020-10-24 23:57:45 +05:30
1. Go to **{home}** **Project overview > Details**
2020-03-13 15:44:24 +05:30
2020-11-24 15:15:51 +05:30
However, the following might help the reader connect the text to the user
interface:
2020-03-13 15:44:24 +05:30
2020-05-24 23:13:21 +05:30
```markdown
2020-10-24 23:57:45 +05:30
| Section | Description |
|:-------------------------|:----------------------------------------------------------------------------------------------------------------------------|
2020-11-24 15:15:51 +05:30
| **{overview}** Overview | View your GitLab Dashboard, and administer projects, users, groups, jobs, runners, and Gitaly servers. |
2020-10-24 23:57:45 +05:30
| **{monitor}** Monitoring | View GitLab system information, and information on background jobs, logs, health checks, requests profiles, and audit logs. |
| **{messages}** Messages | Send and manage broadcast messages for your users. |
2020-03-13 15:44:24 +05:30
```
2020-10-24 23:57:45 +05:30
| Section | Description |
|:-------------------------|:----------------------------------------------------------------------------------------------------------------------------|
2020-11-24 15:15:51 +05:30
| **{overview}** Overview | View your GitLab Dashboard, and administer projects, users, groups, jobs, runners, and Gitaly servers. |
2020-10-24 23:57:45 +05:30
| **{monitor}** Monitoring | View GitLab system information, and information on background jobs, logs, health checks, requests profiles, and audit logs. |
| **{messages}** Messages | Send and manage broadcast messages for your users. |
2020-11-24 15:15:51 +05:30
Use an icon when you find yourself having to describe an interface element. For
example:
2020-10-24 23:57:45 +05:30
- Do: Click the Admin Area icon ( **{admin}** ).
- Don't: Click the Admin Area icon (the wrench icon).
2020-03-13 15:44:24 +05:30
2018-11-08 19:23:39 +05:30
## Alert boxes
2020-11-24 15:15:51 +05:30
When you need to call special attention to particular sentences, use the
following markup to create highlighted alert boxes.
2018-11-08 19:23:39 +05:30
2020-07-28 23:09:34 +05:30
Note that the alert boxes only work for one paragraph only. Multiple paragraphs,
2020-11-24 15:15:51 +05:30
lists, headers and so on, will not render correctly. For multiple lines, use
[blockquotes](#blockquotes) instead.
2018-11-08 19:23:39 +05:30
2020-11-24 15:15:51 +05:30
Alert boxes render only on the GitLab documentation site (<https://docs.gitlab.com>).
2020-01-01 13:55:28 +05:30
Within GitLab itself, they will appear as plain Markdown text (like the examples
2019-12-21 20:55:43 +05:30
above the rendered versions, below).
2020-11-24 15:15:51 +05:30
These alert boxes are used in the GitLab documentation. These aren't strict
guidelines, but for consistency you should try to use these values:
| Color | Markup | Default keyword | Alternative keywords |
|--------|------------|-----------------|----------------------------------------------------------------------|
| Blue | `NOTE:` | `**Note:**` | |
| Yellow | `CAUTION:` | `**Caution:**` | `**Warning:**`, `**Important:**` |
| Red | `DANGER:` | `**Danger:**` | `**Warning:**`, `**Important:**`, `**Deprecated:**`, `**Required:**` |
| Green | `TIP:` | `**Tip:**` | |
2018-11-08 19:23:39 +05:30
### Note
2019-09-30 21:07:59 +05:30
Notes catch the eye of most readers, and therefore should be used very sparingly.
In most cases, content considered for a note should be included:
2020-11-24 15:15:51 +05:30
- As just another sentence in the previous paragraph or the most-relevant
paragraph.
2019-09-30 21:07:59 +05:30
- As its own standalone paragraph.
2020-11-24 15:15:51 +05:30
- As content under a new subheading that introduces the topic, making it more
visible or findable.
2019-09-30 21:07:59 +05:30
#### When to use
Use a note when there is a reason that most or all readers who browse the
2020-11-24 15:15:51 +05:30
section should see the content. That is, if missed, its likely to cause major
trouble for a minority of users or significant trouble for a majority of users.
2019-09-30 21:07:59 +05:30
Weigh the costs of distracting users to whom the content is not relevant against
the cost of users missing the content if it were not expressed as a note.
2020-05-24 23:13:21 +05:30
```markdown
2018-11-08 19:23:39 +05:30
NOTE: **Note:**
This is something to note.
```
2020-11-24 15:15:51 +05:30
How it renders on the GitLab documentation site:
2018-11-08 19:23:39 +05:30
NOTE: **Note:**
This is something to note.
### Tip
2020-05-24 23:13:21 +05:30
```markdown
2018-11-08 19:23:39 +05:30
TIP: **Tip:**
This is a tip.
```
2020-11-24 15:15:51 +05:30
How it renders on the GitLab documentation site:
2018-11-08 19:23:39 +05:30
TIP: **Tip:**
This is a tip.
### Caution
2020-05-24 23:13:21 +05:30
```markdown
2018-11-08 19:23:39 +05:30
CAUTION: **Caution:**
This is something to be cautious about.
```
2020-11-24 15:15:51 +05:30
How it renders on the GitLab documentation site:
2018-11-08 19:23:39 +05:30
CAUTION: **Caution:**
This is something to be cautious about.
### Danger
2020-05-24 23:13:21 +05:30
```markdown
2018-11-08 19:23:39 +05:30
DANGER: **Danger:**
This is a breaking change, a bug, or something very important to note.
```
2020-11-24 15:15:51 +05:30
How it renders on the GitLab documentation site:
2018-11-08 19:23:39 +05:30
DANGER: **Danger:**
This is a breaking change, a bug, or something very important to note.
## Blockquotes
For highlighting a text within a blue blockquote, use this format:
2020-05-24 23:13:21 +05:30
```markdown
2018-11-08 19:23:39 +05:30
> This is a blockquote.
```
2020-11-24 15:15:51 +05:30
which renders on the [GitLab documentation site](https://docs.gitlab.com) as:
2018-11-08 19:23:39 +05:30
> This is a blockquote.
If the text spans across multiple lines it's OK to split the line.
2019-02-15 15:39:39 +05:30
For multiple paragraphs, use the symbol `>` before every line:
2020-05-24 23:13:21 +05:30
```markdown
2019-02-15 15:39:39 +05:30
> This is the first paragraph.
>
> This is the second paragraph.
>
> - This is a list item
> - Second item in the list
```
Which renders to:
> This is the first paragraph.
>
> This is the second paragraph.
>
> - This is a list item
> - Second item in the list
2019-03-02 22:35:43 +05:30
## Terms
2018-11-08 19:23:39 +05:30
2020-11-24 15:15:51 +05:30
To maintain consistency through GitLab documentation, the following guides
documentation authors on agreed styles and usage of terms.
2019-02-15 15:39:39 +05:30
2020-10-24 23:57:45 +05:30
### Merge requests (MRs)
2020-03-13 15:44:24 +05:30
2020-11-24 15:15:51 +05:30
Merge requests allow you to exchange changes you made to source code and
collaborate with other people on the same project. You'll see this term used in
the following ways:
2020-03-13 15:44:24 +05:30
2020-11-24 15:15:51 +05:30
- Use lowercase *merge requests* regardless of whether referring to the feature
or individual merge requests.
2020-03-13 15:44:24 +05:30
2020-10-24 23:57:45 +05:30
As noted in the GitLab [Writing Style Guidelines](https://about.gitlab.com/handbook/communication/#writing-style-guidelines),
2020-03-13 15:44:24 +05:30
if you use the **MR** acronym, expand it at least once per document page.
2020-11-24 15:15:51 +05:30
Typically, the first use would be phrased as _merge request (MR)_ with subsequent
instances being _MR_.
2020-03-13 15:44:24 +05:30
Examples:
2020-10-24 23:57:45 +05:30
- "We prefer GitLab merge requests".
2020-03-13 15:44:24 +05:30
- "Open a merge request to fix a broken link".
- "After you open a merge request (MR), submit your MR for review and approval".
### Describe UI elements
2019-02-15 15:39:39 +05:30
2020-11-24 15:15:51 +05:30
The following are styles to follow when describing user interface elements in an
application:
2019-02-15 15:39:39 +05:30
2020-11-24 15:15:51 +05:30
- For elements with a visible label, use that label in bold with matching case.
For example, `the **Cancel** button`.
- For elements with a tooltip or hover label, use that label in bold with
matching case. For example, `the **Add status emoji** button`.
2019-02-15 15:39:39 +05:30
### Verbs for UI elements
2020-11-24 15:15:51 +05:30
The following are recommended verbs for specific uses with user interface
elements:
2019-02-15 15:39:39 +05:30
2020-07-28 23:09:34 +05:30
| Recommended | Used for | Replaces |
|:--------------------|:---------------------------|:---------------------------|
| *click* | buttons, links, menu items | "hit", "press", "select" |
| *select* or *clear* | checkboxes | "enable", "click", "press" |
| *select* | dropdowns | "pick" |
| *expand* | expandable sections | "open" |
2019-02-15 15:39:39 +05:30
### Other Verbs
2020-07-28 23:09:34 +05:30
| Recommended | Used for | Replaces |
|:------------|:--------------------------------|:----------------------|
| *go to* | making a browser go to location | "navigate to", "open" |
2018-11-08 19:23:39 +05:30
2019-03-02 22:35:43 +05:30
## GitLab versions and tiers
2018-11-08 19:23:39 +05:30
2019-07-31 22:56:46 +05:30
Tagged and released versions of GitLab documentation are available:
- In the [documentation archives](https://docs.gitlab.com/archives/).
- At the `/help` URL for any GitLab installation.
2020-11-24 15:15:51 +05:30
The version introducing a new feature is added to the top of the topic in the
documentation to provide a link back to how the feature was developed.
2019-07-31 22:56:46 +05:30
2020-07-28 23:09:34 +05:30
TIP: **Tip:**
2020-11-24 15:15:51 +05:30
Whenever you have documentation related to the `gitlab.rb` file, you're working
with a self-managed installation. The section or page is therefore likely to
apply only to self-managed instances. If so, the relevant "`TIER` ONLY"
[Product badge](#product-badges) should be included at the highest applicable
heading level.
2020-07-28 23:09:34 +05:30
2019-07-31 22:56:46 +05:30
### Text for documentation requiring version text
2020-11-24 15:15:51 +05:30
- For features that need to declare the GitLab version that the feature was
introduced. Text similar to the following should be added immediately below
the heading as a blockquote:
2020-04-22 19:07:51 +05:30
- `> Introduced in GitLab 11.3.`.
2018-11-08 19:23:39 +05:30
2020-11-24 15:15:51 +05:30
- Whenever possible, version text should have a link to the _completed_ issue,
merge request, or epic that introduced the feature. An issue is preferred over
a merge request, and a merge request is preferred over an epic. For example:
2020-04-22 19:07:51 +05:30
- `> [Introduced](<link-to-issue>) in GitLab 11.3.`.
2018-11-08 19:23:39 +05:30
2019-07-31 22:56:46 +05:30
- If the feature is only available in GitLab Enterprise Edition, mention
2018-11-08 19:23:39 +05:30
the [paid tier](https://about.gitlab.com/handbook/marketing/product-marketing/#tiers)
the feature is available in:
2020-04-22 19:07:51 +05:30
- `> [Introduced](<link-to-issue>) in [GitLab Starter](https://about.gitlab.com/pricing/) 11.3.`.
2020-11-24 15:15:51 +05:30
- If listing information for multiple version as a feature evolves, add the
information to a block-quoted bullet list. For example:
2020-04-22 19:07:51 +05:30
2020-05-24 23:13:21 +05:30
```markdown
2020-04-22 19:07:51 +05:30
> - [Introduced](<link-to-issue>) in GitLab 11.3.
> - Enabled by default in GitLab 11.4.
```
- If a feature is moved to another tier:
2018-11-08 19:23:39 +05:30
2020-05-24 23:13:21 +05:30
```markdown
2020-04-22 19:07:51 +05:30
> - [Introduced](<link-to-issue>) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.5.
> - [Moved](<link-to-issue>) to [GitLab Starter](https://about.gitlab.com/pricing/) in 11.8.
> - [Moved](<link-to-issue>) to GitLab Core in 12.0.
2019-10-12 21:52:04 +05:30
```
2018-11-08 19:23:39 +05:30
2020-07-28 23:09:34 +05:30
- If a feature is deprecated, 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>).
```
2020-11-24 15:15:51 +05:30
It's also acceptable to describe the replacement in surrounding text, if
available.
2020-07-28 23:09:34 +05:30
2020-11-24 15:15:51 +05:30
If the deprecation is not obvious in existing text, you may want to include a
warning such as:
2020-07-28 23:09:34 +05:30
```markdown
2020-11-24 15:15:51 +05:30
DANGER: **Deprecated:**
2020-07-28 23:09:34 +05:30
This feature was [deprecated](link-to-issue) in GitLab 12.3
and replaced by [Feature name](link-to-feature-documentation).
```
2020-04-22 19:07:51 +05:30
NOTE: **Note:**
2020-11-24 15:15:51 +05:30
Version text must be on its own line and surrounded by blank lines to render
correctly.
2020-05-24 23:13:21 +05:30
### Versions in the past or future
When describing functionality available in past or future versions, use:
2020-11-24 15:15:51 +05:30
- *Earlier*, and not *older* or *before*.
- *Later*, and not *newer* or *after*.
2020-05-24 23:13:21 +05:30
For example:
- Available in GitLab 12.3 and earlier.
- Available in GitLab 12.4 and later.
- If using GitLab 11.4 or earlier, ...
- If using GitLab 10.6 or later, ...
2020-04-22 19:07:51 +05:30
2020-03-13 15:44:24 +05:30
### Importance of referencing GitLab versions and tiers
2018-12-05 23:21:45 +05:30
2020-03-13 15:44:24 +05:30
Mentioning GitLab versions and tiers is important to all users and contributors
2020-11-24 15:15:51 +05:30
to quickly have access to the issue or merge request that introduced the change
for reference. Also, they can easily understand what features they have in their
GitLab instance and version, given that the note has some key information.
2018-12-05 23:21:45 +05:30
2020-04-22 19:07:51 +05:30
`[Introduced](link-to-issue) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.7`
2020-03-13 15:44:24 +05:30
links to the issue that introduced the feature, says which GitLab tier it
belongs to, says the GitLab version that it became available in, and links to
2020-11-24 15:15:51 +05:30
the pricing page in case the user wants to upgrade to a paid tier to use that
feature.
2018-12-05 23:21:45 +05:30
2020-11-24 15:15:51 +05:30
For example, if you're a regular user and you're looking at the documentation
for a feature you haven't used before, you can immediately see if that feature
is available to you or not. Alternatively, if you've been using a certain
feature for a long time and it changed in some way, it's important to be able to
determine when it changed and what's new in that feature.
2020-03-13 15:44:24 +05:30
2020-11-24 15:15:51 +05:30
This is even more important as we don't have a perfect process for shipping
documentation. Unfortunately, we still see features without documentation, and
documentation without features. So, for now, we cannot rely 100% on the
documentation site versions.
2020-03-13 15:44:24 +05:30
Over time, version text will reference a progressively older version of GitLab.
In cases where version text refers to versions of GitLab four or more major
versions back, you can consider removing the text if it's irrelevant or confusing.
2020-11-24 15:15:51 +05:30
For example, if the current major version is 12.x, version text referencing
versions of GitLab 8.x and older are candidates for removal if necessary for
clearer or cleaner documentation.
2018-12-05 23:21:45 +05:30
2020-06-23 00:09:42 +05:30
## Products and features
Refer to the information in this section when describing products and features
within the GitLab product documentation.
### Avoid line breaks in names
When entering a product or feature name that includes a space (such as
GitLab Community Edition) or even other companies' products (such as
Amazon Web Services), be sure to not split the product or feature name across
lines with an inserted line break. Splitting product or feature names across
lines makes searching for these items more difficult, and can cause problems if
names change.
2020-07-28 23:09:34 +05:30
For example, the following Markdown content is *not* formatted correctly:
2020-06-23 00:09:42 +05:30
```markdown
When entering a product or feature name that includes a space (such as GitLab
Community Edition), don't split the product or feature name across lines.
```
Instead, it should appear similar to the following:
```markdown
When entering a product or feature name that includes a space (such as
GitLab Community Edition), don't split the product or feature name across lines.
```
### Product badges
2018-11-08 19:23:39 +05:30
2020-10-24 23:57:45 +05:30
When a feature is available in paid tiers, add the corresponding tier to the
header or other page element according to the feature's availability:
2018-11-08 19:23:39 +05:30
2020-10-24 23:57:45 +05:30
| Tier in which feature is available | Tier markup |
|:-----------------------------------------------------------------------|:----------------------|
| GitLab Core and GitLab.com Free, and their higher tiers | `**(CORE)**` |
| GitLab Starter and GitLab.com Bronze, and their higher tiers | `**(STARTER)**` |
| GitLab Premium and GitLab.com Silver, and their higher tiers | `**(PREMIUM)**` |
| GitLab Ultimate and GitLab.com Gold | `**(ULTIMATE)**` |
| *Only* GitLab Core and higher tiers (no GitLab.com-based tiers) | `**(CORE ONLY)**` |
| *Only* GitLab Starter and higher tiers (no GitLab.com-based tiers) | `**(STARTER ONLY)**` |
| *Only* GitLab Premium and higher tiers (no GitLab.com-based tiers) | `**(PREMIUM ONLY)**` |
| *Only* GitLab Ultimate (no GitLab.com-based tiers) | `**(ULTIMATE ONLY)**` |
| *Only* GitLab.com Free and higher tiers (no self-managed instances) | `**(FREE ONLY)**` |
| *Only* GitLab.com Bronze and higher tiers (no self-managed instances) | `**(BRONZE ONLY)**` |
| *Only* GitLab.com Silver and higher tiers (no self-managed instances) | `**(SILVER ONLY)**` |
| *Only* GitLab.com Gold (no self-managed instances) | `**(GOLD ONLY)**` |
2018-11-08 19:23:39 +05:30
2020-11-24 15:15:51 +05:30
For clarity, all page title headers (H1s) must be have a tier markup for the
lowest tier that has information on the documentation page.
2018-11-08 19:23:39 +05:30
2020-10-24 23:57:45 +05:30
If sections of a page apply to higher tier levels, they can be separately
labeled with their own tier markup.
2018-11-08 19:23:39 +05:30
2020-10-24 23:57:45 +05:30
#### Product badge display behavior
2019-07-31 22:56:46 +05:30
2020-11-24 15:15:51 +05:30
When using the tier markup with headers, the documentation page will display the
full tier badge with the header line.
2019-07-31 22:56:46 +05:30
2020-11-24 15:15:51 +05:30
You can also use the tier markup with paragraphs, list items, and table cells.
For these cases, the tier mention will be represented by an orange info icon
**{information}** that will display the tiers when visitors point to the icon.
For example:
2019-03-02 22:35:43 +05:30
2020-10-24 23:57:45 +05:30
- `**(STARTER)**` displays as **(STARTER)**
- `**(STARTER ONLY)**` displays as **(STARTER ONLY)**
- `**(SILVER ONLY)**` displays as **(SILVER ONLY)**
2018-11-08 19:23:39 +05:30
2020-06-23 00:09:42 +05:30
#### How it works
2018-11-08 19:23:39 +05:30
2020-03-13 15:44:24 +05:30
Introduced by [!244](https://gitlab.com/gitlab-org/gitlab-docs/-/merge_requests/244),
2019-09-30 21:07:59 +05:30
the special markup `**(STARTER)**` will generate a `span` element to trigger the
2018-11-08 19:23:39 +05:30
badges and tooltips (`<span class="badge-trigger starter">`). When the keyword
2020-11-24 15:15:51 +05:30
*only* is added, the corresponding GitLab.com badge will not be displayed.
2018-11-08 19:23:39 +05:30
2019-02-15 15:39:39 +05:30
## Specific sections
2020-11-24 15:15:51 +05:30
Certain styles should be applied to specific sections. Styles for specific
sections are outlined below.
2019-02-15 15:39:39 +05:30
2020-04-22 19:07:51 +05:30
### GitLab restart
2018-11-08 19:23:39 +05:30
2020-11-24 15:15:51 +05:30
There are many cases that a restart/reconfigure of GitLab is required. To avoid
duplication, link to the special document that can be found in
2020-04-22 19:07:51 +05:30
[`doc/administration/restart_gitlab.md`](../../administration/restart_gitlab.md).
Usually the text will read like:
2018-11-08 19:23:39 +05:30
2020-05-24 23:13:21 +05:30
```markdown
2018-11-20 20:47:30 +05:30
Save the file and [reconfigure GitLab](../../administration/restart_gitlab.md)
for the changes to take effect.
```
2018-11-08 19:23:39 +05:30
If the document you are editing resides in a place other than the GitLab CE/EE
`doc/` directory, instead of the relative link, use the full path:
2020-11-24 15:15:51 +05:30
`https://docs.gitlab.com/ce/administration/restart_gitlab.html`. Replace
`reconfigure` with `restart` where appropriate.
2018-11-08 19:23:39 +05:30
### Installation guide
**Ruby:**
In [step 2 of the installation guide](../../install/installation.md#2-ruby),
we install Ruby from source. Whenever there is a new version that needs to
be updated, remember to change it throughout the codeblock and also replace
2020-11-24 15:15:51 +05:30
the sha256sum (it can be found in the [downloads page](https://www.ruby-lang.org/en/downloads/)
of the Ruby website).
2018-11-08 19:23:39 +05:30
### Configuration documentation for source and Omnibus installations
GitLab currently officially supports two installation methods: installations
from source and Omnibus packages installations.
Whenever there is a setting that is configurable for both installation methods,
2020-11-24 15:15:51 +05:30
prefer to document it in the CE documentation to avoid duplication.
2018-11-08 19:23:39 +05:30
Configuration settings include:
2019-02-15 15:39:39 +05:30
1. Settings that touch configuration files in `config/`.
1. NGINX settings and settings in `lib/support/` in general.
2018-11-08 19:23:39 +05:30
When there is a list of steps to perform, usually that entails editing the
configuration file and reconfiguring/restarting GitLab. In such case, follow
the style below as a guide:
2020-05-24 23:13:21 +05:30
````markdown
2018-11-08 19:23:39 +05:30
**For Omnibus installations**
1. Edit `/etc/gitlab/gitlab.rb`:
2019-10-12 21:52:04 +05:30
```ruby
external_url "https://gitlab.example.com"
```
2018-11-08 19:23:39 +05:30
2020-11-24 15:15:51 +05:30
1. Save the file and [reconfigure](path/to/administration/restart_gitlab.md#omnibus-gitlab-reconfigure)
GitLab for the changes to take effect.
2018-11-08 19:23:39 +05:30
---
**For installations from source**
1. Edit `config/gitlab.yml`:
2019-10-12 21:52:04 +05:30
```yaml
gitlab:
host: "gitlab.example.com"
```
2018-11-08 19:23:39 +05:30
2020-11-24 15:15:51 +05:30
1. Save the file and [restart](path/to/administration/restart_gitlab.md#installations-from-source)
GitLab for the changes to take effect.
2019-10-12 21:52:04 +05:30
````
2018-11-08 19:23:39 +05:30
In this case:
2019-02-15 15:39:39 +05:30
- Before each step list the installation method is declared in bold.
2020-11-24 15:15:51 +05:30
- Three dashes (`---`) are used to create a horizontal line and separate the two
methods.
2019-02-15 15:39:39 +05:30
- The code blocks are indented one or more spaces under the list item to render
correctly.
- Different highlighting languages are used for each config in the code block.
2020-11-24 15:15:51 +05:30
- The [GitLab Restart](#gitlab-restart) section is used to explain a required
restart or reconfigure of GitLab.
2019-02-15 15:39:39 +05:30
2020-04-22 19:07:51 +05:30
### Troubleshooting
For troubleshooting sections, you should provide as much context as possible so
users can identify the problem they are facing and resolve it on their own. You
can facilitate this by making sure the troubleshooting content addresses:
1. The problem the user needs to solve.
1. How the user can confirm they have the problem.
1. Steps the user can take towards resolution of the problem.
2020-11-24 15:15:51 +05:30
If the contents of each category can be summarized in one line and a list of
steps aren't required, consider setting up a [table](#tables) with headers of
*Problem* \| *Cause* \| *Solution* (or *Workaround* if the fix is temporary), or
*Error message* \| *Solution*.
2020-07-28 23:09:34 +05:30
2019-12-21 20:55:43 +05:30
## Feature flags
2020-11-24 15:15:51 +05:30
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).
2020-01-01 13:55:28 +05:30
2020-10-24 23:57:45 +05:30
## RESTful API
2019-02-15 15:39:39 +05:30
2020-11-24 15:15:51 +05:30
REST API resources are documented in Markdown under
[`/doc/api`](https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api). Each
resource has its own Markdown file, which is linked from `api_resources.md`.
When modifying the Markdown, also update the corresponding
[OpenAPI definition](https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/api/openapi)
if one exists for the resource. If not, consider creating one. Match the latest
[OpenAPI 3.0.x specification](https://swagger.io/specification/). (For more
information, see the discussion in this
[issue](https://gitlab.com/gitlab-org/gitlab/-/issues/16023#note_370901810).)
In the Markdown doc for a resource (AKA endpoint):
2019-02-15 15:39:39 +05:30
- Every method must have the REST API request. For example:
2020-04-22 19:07:51 +05:30
```plaintext
2019-10-12 21:52:04 +05:30
GET /projects/:id/repository/branches
```
2019-02-15 15:39:39 +05:30
2020-11-24 15:15:51 +05:30
- Every method must have a detailed [description of the parameters](#method-description).
2019-02-15 15:39:39 +05:30
- Every method must have a cURL example.
- Every method must have a response body (in JSON format).
### API topic template
The following can be used as a template to get started:
2020-04-08 14:13:33 +05:30
````markdown
2019-02-15 15:39:39 +05:30
## Descriptive title
One or two sentence description of what endpoint does.
2020-05-24 23:13:21 +05:30
```plaintext
2019-02-15 15:39:39 +05:30
METHOD /endpoint
```
| Attribute | Type | Required | Description |
|:------------|:---------|:---------|:----------------------|
| `attribute` | datatype | yes/no | Detailed description. |
| `attribute` | datatype | yes/no | Detailed description. |
Example request:
2020-03-13 15:44:24 +05:30
```shell
2020-11-24 15:15:51 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/endpoint?parameters"
2019-02-15 15:39:39 +05:30
```
Example response:
```json
[
{
}
]
```
2020-04-08 14:13:33 +05:30
````
2018-11-08 19:23:39 +05:30
2020-04-22 19:07:51 +05:30
### Fake user information
You may need to demonstrate an API call or a cURL command that includes the name
and email address of a user. Don't use real user information in API calls:
- **Email addresses**: Use an email address ending in `example.com`.
2020-11-24 15:15:51 +05:30
- **Names**: Use strings like `Example Username`. Alternatively, use diverse or
non-gendered names with common surnames, such as `Sidney Jones`, `Zhang Wei`,
or `Maria Garcia`.
2020-04-22 19:07:51 +05:30
2020-07-28 23:09:34 +05:30
### Fake URLs
When including sample URLs in the documentation, use:
- `example.com` when the domain name is generic.
- `gitlab.example.com` when referring to self-managed instances of GitLab.
2018-11-08 19:23:39 +05:30
### Fake tokens
There may be times where a token is needed to demonstrate an API call using
2020-11-24 15:15:51 +05:30
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.
2018-11-08 19:23:39 +05:30
2020-11-24 15:15:51 +05:30
You can use the following fake tokens as examples:
2018-11-08 19:23:39 +05:30
2019-02-15 15:39:39 +05:30
| Token type | Token value |
2018-12-13 13:39:08 +05:30
|:----------------------|:-------------------------------------------------------------------|
2019-10-12 21:52:04 +05:30
| Private user token | `<your_access_token>` |
2018-12-13 13:39:08 +05:30
| Personal access token | `n671WNGecHugsdEDPsyo` |
2018-11-08 19:23:39 +05:30
| Application ID | `2fcb195768c39e9a94cec2c2e32c59c0aad7a3365c10892e8116b5d83d4096b6` |
| Application secret | `04f294d1eaca42b8692017b426d53bbc8fe75f827734f0260710b83a556082df` |
2019-02-15 15:39:39 +05:30
| CI/CD variable | `Li8j-mLUVA3eZYjPfd_H` |
2020-11-24 15:15:51 +05:30
| Specific runner token | `yrnZW46BrtBFqM7xDzE7dddd` |
| Shared runner token | `6Vk7ZsosqQyfreAxXTZr` |
2018-12-13 13:39:08 +05:30
| Trigger token | `be20d8dcc028677c931e04f3871a9b` |
| Webhook secret token | `6XhDroRcYPM5by_h-HLY` |
| Health check token | `Tu7BgjR9qeZTEyRzGG2P` |
| Request profile token | `7VgpS4Ax5utVD2esNstz` |
2018-11-08 19:23:39 +05:30
2019-02-15 15:39:39 +05:30
### Method description
2018-11-08 19:23:39 +05:30
Use the following table headers to describe the methods. Attributes should
2019-10-12 21:52:04 +05:30
always be in code blocks using backticks (`` ` ``).
2018-11-08 19:23:39 +05:30
2020-05-24 23:13:21 +05:30
```markdown
2018-11-08 19:23:39 +05:30
| Attribute | Type | Required | Description |
2018-12-13 13:39:08 +05:30
|:----------|:-----|:---------|:------------|
2018-11-08 19:23:39 +05:30
```
Rendered example:
2018-12-13 13:39:08 +05:30
| Attribute | Type | Required | Description |
|:----------|:-------|:---------|:--------------------|
| `user` | string | yes | The GitLab username |
2018-11-08 19:23:39 +05:30
2019-02-15 15:39:39 +05:30
### cURL commands
2018-11-08 19:23:39 +05:30
- Use `https://gitlab.example.com/api/v4/` as an endpoint.
2019-02-15 15:39:39 +05:30
- Wherever needed use this personal access token: `<your_access_token>`.
2018-11-08 19:23:39 +05:30
- Always put the request first. `GET` is the default so you don't have to
include it.
2020-06-23 00:09:42 +05:30
- Wrap the URL in double quotes (`"`).
2018-11-08 19:23:39 +05:30
- Prefer to use examples using the personal access token and don't pass data of
username and password.
2019-12-26 22:10:19 +05:30
| Methods | Description |
|:------------------------------------------- |:------------------------------------------------------|
| `--header "PRIVATE-TOKEN: <your_access_token>"` | Use this method as is, whenever authentication needed |
| `--request POST` | Use this method when creating new objects |
| `--request PUT` | Use this method when updating existing objects |
| `--request DELETE` | Use this method when removing existing objects |
2018-11-08 19:23:39 +05:30
2019-02-15 15:39:39 +05:30
### cURL Examples
2018-11-08 19:23:39 +05:30
2020-11-24 15:15:51 +05:30
The following sections include a set of [cURL](https://curl.haxx.se) examples
you can use in the API documentation.
2018-11-08 19:23:39 +05:30
2019-02-15 15:39:39 +05:30
#### Simple cURL command
2018-11-08 19:23:39 +05:30
Get the details of a group:
2020-03-13 15:44:24 +05:30
```shell
2020-11-24 15:15:51 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/gitlab-org"
2018-11-08 19:23:39 +05:30
```
2019-02-15 15:39:39 +05:30
#### cURL example with parameters passed in the URL
2018-11-08 19:23:39 +05:30
Create a new project under the authenticated user's namespace:
2020-03-13 15:44:24 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects?name=foo"
2018-11-08 19:23:39 +05:30
```
2019-12-26 22:10:19 +05:30
#### Post data using cURL's `--data`
2018-11-08 19:23:39 +05:30
2020-11-24 15:15:51 +05:30
Instead of using `--request POST` and appending the parameters to the URI, you
can use cURL's `--data` option. The example below will create a new project
`foo` under the authenticated user's namespace.
2018-11-08 19:23:39 +05:30
2020-03-13 15:44:24 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --data "name=foo" --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects"
2018-11-08 19:23:39 +05:30
```
2019-02-15 15:39:39 +05:30
#### Post data using JSON content
2018-11-08 19:23:39 +05:30
2020-10-24 23:57:45 +05:30
NOTE: **Note:**
2020-11-24 15:15:51 +05:30
In this example we create a new group. Watch carefully the single and double
quotes.
2018-11-08 19:23:39 +05:30
2020-03-13 15:44:24 +05:30
```shell
2020-11-24 15:15:51 +05:30
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --header "Content-Type: application/json" --data '{"path": "my-group", "name": "My group"}' "https://gitlab.example.com/api/v4/groups"
2018-11-08 19:23:39 +05:30
```
2019-02-15 15:39:39 +05:30
#### Post data using form-data
2018-11-08 19:23:39 +05:30
Instead of using JSON or urlencode you can use multipart/form-data which
properly handles data encoding:
2020-03-13 15:44:24 +05:30
```shell
2020-11-24 15:15:51 +05:30
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --form "title=ssh-key" --form "key=ssh-rsa AAAAB3NzaC1yc2EA..." "https://gitlab.example.com/api/v4/users/25/keys"
2018-11-08 19:23:39 +05:30
```
The above example is run by and administrator and will add an SSH public key
2020-05-24 23:13:21 +05:30
titled `ssh-key` to user's account which has an ID of 25.
2018-11-08 19:23:39 +05:30
2019-02-15 15:39:39 +05:30
#### Escape special characters
2018-11-08 19:23:39 +05:30
Spaces or slashes (`/`) may sometimes result to errors, thus it is recommended
to escape them when possible. In the example below we create a new issue which
contains spaces in its title. Observe how spaces are escaped using the `%20`
ASCII code.
2020-03-13 15:44:24 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/42/issues?title=Hello%20Dude"
2018-11-08 19:23:39 +05:30
```
Use `%2F` for slashes (`/`).
2019-02-15 15:39:39 +05:30
#### Pass arrays to API calls
2018-11-08 19:23:39 +05:30
The GitLab API sometimes accepts arrays of strings or integers. For example, to
2020-11-24 15:15:51 +05:30
exclude specific users when requesting a list of users for a project, you would
do something like this:
2018-11-08 19:23:39 +05:30
2020-03-13 15:44:24 +05:30
```shell
2020-11-24 15:15:51 +05:30
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" --data "skip_users[]=<user_id>" --data "skip_users[]=<user_id>" "https://gitlab.example.com/api/v4/projects/<project_id>/users"
2018-11-08 19:23:39 +05:30
```
2020-10-24 23:57:45 +05:30
## GraphQL API
2020-11-24 15:15:51 +05:30
GraphQL APIs are different from [RESTful APIs](#restful-api). Reference
information is generated in our [GraphQL reference](../../api/graphql/reference/index.md).
2020-10-24 23:57:45 +05:30
2020-11-24 15:15:51 +05:30
However, it's helpful to include examples on how to use GraphQL for different
*use cases*, with samples that readers can use directly in the
[GraphiQL explorer](../api_graphql_styleguide.md#graphiql).
2020-10-24 23:57:45 +05:30
2020-11-24 15:15:51 +05:30
This section describes the steps required to add your GraphQL examples to
GitLab documentation.
2020-10-24 23:57:45 +05:30
### Add a dedicated GraphQL page
2020-11-24 15:15:51 +05:30
To create a dedicated GraphQL page, create a new `.md` file in the
`doc/api/graphql/` directory. Give that file a functional name, such as
`import_from_specific_location.md`.
2020-10-24 23:57:45 +05:30
### Start the page with an explanation
2020-11-24 15:15:51 +05:30
Include a page title that describes the GraphQL functionality in a few words,
such as:
2020-10-24 23:57:45 +05:30
```markdown
# Search for [substitute kind of data]
```
2020-11-24 15:15:51 +05:30
Describe the search. One sentence may be all you need. More information may
help readers learn how to use the example for their GitLab deployments.
2020-10-24 23:57:45 +05:30
### Include a procedure using the GraphiQL explorer
2020-11-24 15:15:51 +05:30
The GraphiQL explorer can help readers test queries with working deployments.
Set up the section with the following:
2020-10-24 23:57:45 +05:30
- Use the following title:
```markdown
## Set up the GraphiQL explorer
```
2020-11-24 15:15:51 +05:30
- Include a code block with the query that anyone can include in their
instance of the GraphiQL explorer:
2020-10-24 23:57:45 +05:30
````markdown
```graphql
query {
<insert queries here>
}
```
````
- Tell the user what to do:
```markdown
1. Open the GraphiQL explorer tool in the following URL: `https://gitlab.com/-/graphql-explorer`.
1. Paste the `query` listed above into the left window of your GraphiQL explorer tool.
1. Click Play to get the result shown here:
```
- Include a screenshot of the result in the GraphiQL explorer. Follow the naming
convention described in the [Save the image](#save-the-image) section.
2020-11-24 15:15:51 +05:30
- Follow up with an example of what you can do with the output. Make sure the
example is something that readers can do on their own deployments.
2020-10-24 23:57:45 +05:30
- Include a link to the [GraphQL API resources](../../api/graphql/reference/index.md).
### Add the GraphQL example to the Table of Contents
2020-11-24 15:15:51 +05:30
You'll need to open a second MR, against the [GitLab documentation repository](https://gitlab.com/gitlab-org/gitlab-docs/).
2020-10-24 23:57:45 +05:30
2020-11-24 15:15:51 +05:30
We store our Table of Contents in the `default-nav.yaml` file, in the
`content/_data` subdirectory. You can find the GraphQL section under the
following line:
2020-10-24 23:57:45 +05:30
```yaml
2020-11-24 15:15:51 +05:30
- category_title: GraphQL
2020-10-24 23:57:45 +05:30
```
2020-11-24 15:15:51 +05:30
Be aware that CI tests for that second MR will fail with a bad link until the
main MR that adds the new GraphQL page is merged.
2020-10-24 23:57:45 +05:30
And that's all you need!