2021-09-04 01:27:46 +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/#assignments
description: 'Writing styles, markup, formatting, and other standards for GitLab Documentation.'
---
# A-Z word list
To help ensure consistency in the documentation, follow this guidance.
2021-09-30 23:02:18 +05:30
For guidance not on this page, we defer to these style guides:
- [Microsoft Style Guide ](https://docs.microsoft.com/en-us/style-guide/welcome/ )
- [Google Developer Documentation Style Guide ](https://developers.google.com/style )
2021-09-04 01:27:46 +05:30
<!-- vale off -->
<!-- markdownlint - disable -->
2021-11-11 11:23:49 +05:30
## `@mention`
2021-10-27 15:23:28 +05:30
2021-11-11 11:23:49 +05:30
Try to avoid ** `@mention` **. Say **mention** instead, and consider linking to the
2021-10-27 15:23:28 +05:30
[mentions topic ](../../../user/project/issues/issue_data_and_actions.md#mentions ).
2021-11-11 11:23:49 +05:30
Don't use backticks.
2021-10-27 15:23:28 +05:30
2021-09-04 01:27:46 +05:30
## above
2021-11-11 11:23:49 +05:30
Try to avoid using **above** when referring to an example or table in a documentation page. If required, use **previous** instead. For example:
- In the previous example, the dog had fleas.
2021-09-04 01:27:46 +05:30
2021-11-18 22:05:49 +05:30
Do not use **above** when referring to versions of the product. Use [**later** ](#later ) instead.
2021-09-04 01:27:46 +05:30
2021-11-18 22:05:49 +05:30
- Do: In GitLab 14.4 and later...
- Do not: In GitLab 14.4 and above...
- Do not: In GitLab 14.4 and higher...
## access level
Access levels are different than [roles ](#roles ) or [permissions ](#permissions ).
When you create a user, you choose an access level: **Regular** , **Auditor** , or **Admin** .
Capitalize these words when you refer to the UI. Otherwise use lowercase.
## administrator
Use **administrator** instead of **admin** when talking about a user's access level.
Use lowercase unless you are referring to the **Admin** access level you select in the UI.
To view the administrator access type, in the GitLab UI, go to the Admin Area and select
**Users**. Then select **New user** .
![admin access level ](img/admin_access_level.png )
An **administrator** is not a [role ](#roles ) or [permission ](#permissions ).
- Do: To do this thing, you must be an administrator.
- Do: To do this thing, you must have the administrator access level.
- Do not: To do this thing, you must have the Admin role.
## Admin Area
Use title case **Admin Area** to refer to the area of the UI that you access when you select **Menu > Admin** .
This area of the UI says **Admin Area** at the top of the page and on the menu.
2021-09-04 01:27:46 +05:30
## allow, enable
2021-11-11 11:23:49 +05:30
Try to avoid **allow** and **enable** , unless you are talking about security-related features. For example:
2021-09-30 23:02:18 +05:30
2021-11-11 11:23:49 +05:30
- Do: Use this feature to create a pipeline.
- Do not: This feature allows you to create a pipeline.
2021-09-30 23:02:18 +05:30
This phrasing is more active and is from the user perspective, rather than the person who implemented the feature.
[View details in the Microsoft style guide ](https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/a/allow-allows ).
2021-09-04 01:27:46 +05:30
2021-10-27 15:23:28 +05:30
## Alpha
2021-11-11 11:23:49 +05:30
Use uppercase for **Alpha** . For example: **The XYZ feature is in Alpha.** or **This Alpha release is ready to test.**
2021-10-27 15:23:28 +05:30
You might also want to link to [this section ](https://about.gitlab.com/handbook/product/gitlab-the-product/#alpha-beta-ga )
in the handbook when writing about Alpha features.
2021-09-04 01:27:46 +05:30
## and/or
2021-11-11 11:23:49 +05:30
Instead of **and/or** , use **or** or rewrite the sentence to spell out both options.
2021-11-18 22:05:49 +05:30
## and so on
Do not use **and so on** . Instead, be more specific. For details, see
[the Microsoft style guide ](https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/a/and-so-on ).
2021-11-11 11:23:49 +05:30
## area
2021-11-18 22:05:49 +05:30
Use [**section** ](#section ) instead of **area** . The only exception is [the Admin Area ](#admin-area ).
2021-09-04 01:27:46 +05:30
## below
2021-11-11 11:23:49 +05:30
Try to avoid **below** when referring to an example or table in a documentation page. If required, use **following** instead. For example:
- In the following example, the dog has fleas.
2021-09-04 01:27:46 +05:30
2021-10-27 15:23:28 +05:30
## Beta
2021-11-11 11:23:49 +05:30
Use uppercase for **Beta** . For example: **The XYZ feature is in Beta.** or **This Beta release is ready to test.**
2021-10-27 15:23:28 +05:30
You might also want to link to [this section ](https://about.gitlab.com/handbook/product/gitlab-the-product/#alpha-beta-ga )
in the handbook when writing about Beta features.
2021-09-30 23:02:18 +05:30
## blacklist
2021-11-11 11:23:49 +05:30
Do not use **blacklist** . Another option is **denylist** . ([Vale](../testing.md#vale) rule: [`InclusionCultural.yml` ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/InclusionCultural.yml ))
2021-09-30 23:02:18 +05:30
2021-10-27 15:23:28 +05:30
## board
Use lowercase for **boards** , **issue boards** , and **epic boards** .
2021-11-11 11:23:49 +05:30
## box
Use **text box** to refer to the UI field. Do not use **field** or **box** . For example:
- In the **Variable name** text box, enter `my text` .
## button
Don't use a descriptor with **button** .
- Do: Select **Run pipelines** .
- Do not: Select the **Run pipelines** button.
## cannot, can not
Use **cannot** instead of **can not** . You can also use **can't** .
See also [contractions ](index.md#contractions ).
2021-10-27 15:23:28 +05:30
## checkbox
2021-11-11 11:23:49 +05:30
Use one word for **checkbox** . Do not use **check box** .
You **select** (not **check** or **enable** ) and **clear** (not **deselect** or **disable** ) checkboxes.
For example:
- Select the **Protect environment** checkbox.
- Clear the **Protect environment** checkbox.
If you must refer to the checkbox, you can say it is selected or cleared. For example:
- Ensure the **Protect environment** checkbox is cleared.
- Ensure the **Protect environment** checkbox is selected.
2021-10-27 15:23:28 +05:30
## CI/CD
2021-11-11 11:23:49 +05:30
CI/CD is always uppercase. No need to spell it out on first use.
## click
Do not use **click** . Instead, use **select** with buttons, links, menu items, and lists.
**Select** applies to more devices, while **click** is more specific to a mouse.
## collapse
Use **collapse** instead of **close** when you are talking about expanding or collapsing a section in the UI.
## confirmation dialog
Use **confirmation dialog** to describe the dialog box that asks you to confirm your action. For example:
- On the confirmation dialog, select **OK** .
2021-10-27 15:23:28 +05:30
2021-09-04 01:27:46 +05:30
## currently
2021-11-11 11:23:49 +05:30
Do not use **currently** when talking about the product or its features. The documentation describes the product as it is today.
([Vale](../testing.md#vale) rule: [`CurrentStatus.yml` ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/CurrentStatus.yml ))
## deploy board
Use lowercase for **deploy board** .
2021-09-04 01:27:46 +05:30
## Developer
2021-09-30 23:02:18 +05:30
When writing about the Developer role:
2021-09-04 01:27:46 +05:30
2021-09-30 23:02:18 +05:30
- Use a capital **D** .
2021-10-27 15:23:28 +05:30
- Do not use bold.
2021-09-30 23:02:18 +05:30
- Do not use the phrase, **if you are a developer** to mean someone who is assigned the Developer
role. Instead, write it out. For example, **if you are assigned the Developer role** .
- To describe a situation where the Developer role is the minimum required:
2021-11-18 22:05:49 +05:30
- Do: at least the Developer role
- Do not: the Developer role or higher
2021-09-30 23:02:18 +05:30
Do not use **Developer permissions** . A user who is assigned the Developer role has a set of associated permissions.
## disable
2021-11-11 11:23:49 +05:30
See [the Microsoft style guide ](https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/d/disable-disabled ) for guidance on **disable** .
2021-09-30 23:02:18 +05:30
Use **inactive** or **off** instead. ([Vale](../testing.md#vale) rule: [`InclusionAbleism.yml` ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/InclusionAbleism.yml ))
2021-09-04 01:27:46 +05:30
2021-11-11 11:23:49 +05:30
## dropdown list
Use **dropdown list** to refer to the UI element. Do not use **dropdown** without **list** after it.
Do not use **drop-down** (hyphenated), **dropdown menu** , or other variants.
For example:
- From the **Visibility** dropdown list, select **Public** .
2021-10-27 15:23:28 +05:30
## earlier
2021-11-11 11:23:49 +05:30
Use **earlier** when talking about version numbers.
2021-10-27 15:23:28 +05:30
2021-11-11 11:23:49 +05:30
- Do: In GitLab 14.1 and earlier.
- Do not: In GitLab 14.1 and lower.
2021-10-27 15:23:28 +05:30
2021-09-04 01:27:46 +05:30
## easily
2021-11-11 11:23:49 +05:30
Do not use **easily** . If the user doesn't find the process to be easy, we lose their trust.
2021-09-04 01:27:46 +05:30
## e.g.
Do not use Latin abbreviations. Use **for example** , **such as** , **for instance** , or **like** instead. ([Vale](../testing.md#vale) rule: [`LatinTerms.yml` ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/LatinTerms.yml ))
2021-09-30 23:02:18 +05:30
## email
2021-11-11 11:23:49 +05:30
Do not use **e-mail** with a hyphen. When plural, use **emails** or **email messages** . ([Vale](../testing.md#vale) rule: [`SubstitutionSuggestions.yml` ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/SubstitutionSuggestions.yml ))
2021-09-30 23:02:18 +05:30
## enable
2021-11-11 11:23:49 +05:30
See [the Microsoft style guide ](https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/e/enable-enables ) for guidance on **enable** .
2021-09-30 23:02:18 +05:30
Use **active** or **on** instead. ([Vale](../testing.md#vale) rule: [`InclusionAbleism.yml` ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/InclusionAbleism.yml ))
2021-11-11 11:23:49 +05:30
## enter
Use **enter** instead of **type** when talking about putting values into text boxes.
2021-10-27 15:23:28 +05:30
## epic
2021-11-11 11:23:49 +05:30
Use lowercase for **epic** .
2021-10-27 15:23:28 +05:30
## epic board
2021-11-11 11:23:49 +05:30
Use lowercase for **epic board** .
2021-10-27 15:23:28 +05:30
## etc.
2021-11-18 22:05:49 +05:30
Try to avoid **etc.** . Be as specific as you can. Do not use
[**and so on** ](#and-so-on ) as a replacement.
2021-10-27 15:23:28 +05:30
2021-11-11 11:23:49 +05:30
- Do: You can update objects, like merge requests and issues.
- Do not: You can update objects, like merge requests, issues, etc.
## expand
Use **expand** instead of **open** when you are talking about expanding or collapsing a section in the UI.
## field
Use **box** instead of **field** or **text box** .
2021-11-18 22:05:49 +05:30
- Do: In the **Variable name** box, enter `my text` .
- Do not: In the **Variable name** field, enter `my text` .
2021-10-27 15:23:28 +05:30
2021-12-11 22:18:48 +05:30
However, you can make an exception when you are writing a task and you need to refer to all
of the fields at once. For example:
1. On the top bar, select **Menu > Projects** and find your project.
1. On the left sidebar, select **Settings > CI/CD** .
1. Expand **General pipelines** .
1. Complete the fields.
Learn more about [documenting multiple fields at once ](index.md#documenting-multiple-fields-at-once ).
2021-10-27 15:23:28 +05:30
## foo
2021-11-11 11:23:49 +05:30
Do not use **foo** in product documentation. You can use it in our API and contributor documentation, but try to use a clearer and more meaningful example instead.
2021-10-27 15:23:28 +05:30
2021-09-04 01:27:46 +05:30
## future tense
2021-11-11 11:23:49 +05:30
When possible, use present tense instead of future tense. For example, use **after you execute this command, GitLab displays the result** instead of **after you execute this command, GitLab will display the result** . ([Vale](../testing.md#vale) rule: [`FutureTense.yml` ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/FutureTense.yml ))
2021-09-04 01:27:46 +05:30
2021-10-27 15:23:28 +05:30
## Geo
2021-11-11 11:23:49 +05:30
Use title case for **Geo** .
2021-10-27 15:23:28 +05:30
2021-09-04 01:27:46 +05:30
## GitLab
2021-11-11 11:23:49 +05:30
Do not make **GitLab** possessive (GitLab's). This guidance follows [GitLab Trademark Guidelines ](https://about.gitlab.com/handbook/marketing/corporate-marketing/brand-activation/trademark-guidelines/ ).
2021-09-04 01:27:46 +05:30
2021-10-27 15:23:28 +05:30
## GitLab.com
2021-09-30 23:02:18 +05:30
2021-11-11 11:23:49 +05:30
**GitLab.com** refers to the GitLab instance managed by GitLab itself.
2021-09-30 23:02:18 +05:30
2021-10-27 15:23:28 +05:30
## GitLab SaaS
2021-09-30 23:02:18 +05:30
2021-11-11 11:23:49 +05:30
**GitLab SaaS** refers to the product license that provides access to GitLab.com. It does not refer to the
2021-09-30 23:02:18 +05:30
GitLab instance managed by GitLab itself.
2021-10-27 15:23:28 +05:30
## GitLab Runner
2021-11-11 11:23:49 +05:30
Use title case for **GitLab Runner** . This is the product you install. See also [runners ](#runner-runners ) and [this issue ](https://gitlab.com/gitlab-org/gitlab/-/issues/233529 ).
2021-10-27 15:23:28 +05:30
## GitLab self-managed
2021-09-30 23:02:18 +05:30
2021-11-11 11:23:49 +05:30
Use **GitLab self-managed** to refer to the product license for GitLab instances managed by customers themselves.
2021-09-30 23:02:18 +05:30
2021-09-04 01:27:46 +05:30
## Guest
2021-09-30 23:02:18 +05:30
When writing about the Guest role:
- Use a capital **G** .
2021-10-27 15:23:28 +05:30
- Do not use bold.
2021-09-30 23:02:18 +05:30
- Do not use the phrase, **if you are a guest** to mean someone who is assigned the Guest
role. Instead, write it out. For example, **if you are assigned the Guest role** .
- To describe a situation where the Guest role is the minimum required:
2021-11-18 22:05:49 +05:30
- Do: at least the Guest role
- Do not: the Guest role or higher
2021-09-04 01:27:46 +05:30
2021-09-30 23:02:18 +05:30
Do not use **Guest permissions** . A user who is assigned the Guest role has a set of associated permissions.
2021-09-04 01:27:46 +05:30
## handy
2021-11-11 11:23:49 +05:30
Do not use **handy** . If the user doesn't find the feature or process to be handy, we lose their trust. ([Vale](../testing.md#vale) rule: [`Simplicity.yml` ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/Simplicity.yml ))
2021-09-04 01:27:46 +05:30
## high availability, HA
2021-11-11 11:23:49 +05:30
Do not use **high availability** or **HA** . Instead, direct readers to the GitLab [reference architectures ](../../../administration/reference_architectures/index.md ) for information about configuring GitLab for handling greater amounts of users.
2021-09-04 01:27:46 +05:30
2021-10-27 15:23:28 +05:30
## higher
2021-11-11 11:23:49 +05:30
Do not use **higher** when talking about version numbers.
2021-10-27 15:23:28 +05:30
2021-11-18 22:05:49 +05:30
- Do: In GitLab 14.4 and later...
- Do not: In GitLab 14.4 and higher...
- Do not: In GitLab 14.4 and above...
2021-11-11 11:23:49 +05:30
## hit
Don't use **hit** to mean **press** .
2021-11-18 22:05:49 +05:30
- Do: Press **ENTER** .
- Do not: Hit the **ENTER** button.
2021-10-27 15:23:28 +05:30
2021-09-04 01:27:46 +05:30
## I
Do not use first-person singular. Use **you** , **we** , or **us** instead. ([Vale](../testing.md#vale) rule: [`FirstPerson.yml` ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/FirstPerson.yml ))
## i.e.
Do not use Latin abbreviations. Use **that is** instead. ([Vale](../testing.md#vale) rule: [`LatinTerms.yml` ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/LatinTerms.yml ))
2021-10-27 15:23:28 +05:30
## in order to
2021-11-11 11:23:49 +05:30
Do not use **in order to** . Use **to** instead. ([Vale](../testing.md#vale) rule: [`Wordy.yml` ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/Wordy.yml ))
2021-10-27 15:23:28 +05:30
## issue
2021-11-11 11:23:49 +05:30
Use lowercase for **issue** .
2021-10-27 15:23:28 +05:30
## issue board
2021-11-11 11:23:49 +05:30
Use lowercase for **issue board** .
2021-10-27 15:23:28 +05:30
## issue weights
2021-11-11 11:23:49 +05:30
Use lowercase for **issue weights** .
2021-10-27 15:23:28 +05:30
## job
Do not use **build** to be synonymous with **job** . A job is defined in the `.gitlab-ci.yml` file and runs as part of a pipeline.
If you want to use **CI** with the word **job** , use **CI/CD job** rather than **CI job** .
## later
2021-11-11 11:23:49 +05:30
Use **later** when talking about version numbers.
2021-10-27 15:23:28 +05:30
2021-11-18 22:05:49 +05:30
- Do: In GitLab 14.1 and later...
- Do not: In GitLab 14.1 and higher...
- Do not: In GitLab 14.1 and above...
2021-10-27 15:23:28 +05:30
2021-11-11 11:23:49 +05:30
## list
Do not use **list** when referring to a [**dropdown list** ](#dropdown-list ).
Use the full phrase **dropdown list** instead.
2021-10-27 15:23:28 +05:30
## log in, log on
2021-11-11 11:23:49 +05:30
Do not use **log in** or **log on** . Use [sign in ](#sign-in ) instead. If the user interface has **Log in** , you can use it.
2021-10-27 15:23:28 +05:30
## lower
2021-11-11 11:23:49 +05:30
Do not use **lower** when talking about version numbers.
2021-10-27 15:23:28 +05:30
2021-11-11 11:23:49 +05:30
- Do: In GitLab 14.1 and earlier.
- Do not: In GitLab 14.1 and lower.
2021-10-27 15:23:28 +05:30
2021-09-04 01:27:46 +05:30
## Maintainer
2021-09-30 23:02:18 +05:30
When writing about the Maintainer role:
- Use a capital **M** .
2021-10-27 15:23:28 +05:30
- Do not use bold.
2021-09-30 23:02:18 +05:30
- Do not use the phrase, **if you are a maintainer** to mean someone who is assigned the Maintainer
role. Instead, write it out. For example, **if you are assigned the Maintainer role** .
- To describe a situation where the Maintainer role is the minimum required:
2021-11-18 22:05:49 +05:30
- Do: at least the Maintainer role
- Do not: the Maintainer role or higher
2021-09-30 23:02:18 +05:30
Do not use **Maintainer permissions** . A user who is assigned the Maintainer role has a set of associated permissions.
## mankind
2021-11-11 11:23:49 +05:30
Do not use **mankind** . Use **people** or **humanity** instead. ([Vale](../testing.md#vale) rule: [`InclusionGender.yml` ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/InclusionGender.yml ))
2021-09-04 01:27:46 +05:30
2021-09-30 23:02:18 +05:30
## manpower
2021-11-11 11:23:49 +05:30
Do not use **manpower** . Use words like **workforce** or **GitLab team members** . ([Vale](../testing.md#vale) rule: [`InclusionGender.yml` ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/InclusionGender.yml ))
2021-09-30 23:02:18 +05:30
## master
2021-11-11 11:23:49 +05:30
Do not use **master** . Options are **primary** or **main** . ([Vale](../testing.md#vale) rule: [`InclusionCultural.yml` ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/InclusionCultural.yml ))
2021-09-04 01:27:46 +05:30
## may, might
**Might** means something has the probability of occurring. **May** gives permission to do something. Consider **can** instead of **may** .
## me, myself, mine
Do not use first-person singular. Use **you** , **we** , or **us** instead. ([Vale](../testing.md#vale) rule: [`FirstPerson.yml` ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/FirstPerson.yml ))
2021-09-30 23:02:18 +05:30
## merge requests
2021-11-11 11:23:49 +05:30
Use lowercase for **merge requests** . If you use **MR** as the acronym, spell it out on first use.
2021-09-30 23:02:18 +05:30
2021-10-27 15:23:28 +05:30
## milestones
2021-11-11 11:23:49 +05:30
Use lowercase for **milestones** .
## navigate
Do not use **navigate** . Use **go** instead. For example:
- Go to this webpage.
- Open a terminal and go to the `runner` directory.
2021-10-27 15:23:28 +05:30
## need to, should
2021-11-11 11:23:49 +05:30
Try to avoid **needs to** , because it's wordy. Avoid **should** when you can be more specific. If something is required, use **must** .
2021-10-27 15:23:28 +05:30
2021-11-11 11:23:49 +05:30
- Do: You must set the variable. Or: Set the variable.
- Do not: You need to set the variable.
2021-10-27 15:23:28 +05:30
**Should** is acceptable for recommended actions or items, or in cases where an event may not
happen. For example:
- Although you can configure the installation manually, you should use the express configuration to
avoid complications.
- You should see a success message in the console. Contact support if an error message appears
instead.
## note that
2021-11-11 11:23:49 +05:30
Do not use **note that** because it's wordy.
2021-10-27 15:23:28 +05:30
2021-11-11 11:23:49 +05:30
- Do: You can change the settings.
- Do not: Note that you can change the settings.
2021-10-27 15:23:28 +05:30
2021-12-11 22:18:48 +05:30
## on
When documenting how to select high-level UI elements, use the word **on** .
- Do: `On the left sidebar...`
- Do not: `From the left sidebar...` or `In the left sidebar...`
2021-11-18 22:05:49 +05:30
## once
The word **once** means **one time** . Don't use it to mean **after** or **when** .
- Do: When the process is complete...
- Do not: Once the process is complete...
2021-09-04 01:27:46 +05:30
## Owner
2021-09-30 23:02:18 +05:30
When writing about the Owner role:
- Use a capital **O** .
2021-10-27 15:23:28 +05:30
- Do not use bold.
2021-09-30 23:02:18 +05:30
- Do not use the phrase, **if you are an owner** to mean someone who is assigned the Owner
role. Instead, write it out. For example, **if you are assigned the Owner role** .
2021-09-04 01:27:46 +05:30
2021-09-30 23:02:18 +05:30
Do not use **Owner permissions** . A user who is assigned the Owner role has a set of associated permissions.
2021-09-04 01:27:46 +05:30
## permissions
2021-11-18 22:05:49 +05:30
Do not use [**roles** ](#roles ) and **permissions** interchangeably. Each user is assigned a role. Each role includes a set of permissions.
Permissions are not the same as [**access levels** ](#access-level ).
2021-09-04 01:27:46 +05:30
## please
2021-11-11 11:23:49 +05:30
Do not use **please** . For details, see the [Microsoft style guide ](https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/p/please ).
## press
Use **press** when talking about keyboard keys. For example:
- To stop the command, press < kbd > Control</ kbd > +< kbd > C</ kbd > .
2021-09-04 01:27:46 +05:30
## profanity
2021-11-11 11:23:49 +05:30
Do not use profanity. Doing so may negatively affect other users and contributors, which is contrary to the GitLab value of [Diversity, Inclusion, and Belonging ](https://about.gitlab.com/handbook/values/#diversity-inclusion ).
2021-09-04 01:27:46 +05:30
## Reporter
2021-09-30 23:02:18 +05:30
When writing about the Reporter role:
2021-09-04 01:27:46 +05:30
2021-09-30 23:02:18 +05:30
- Use a capital **R** .
2021-10-27 15:23:28 +05:30
- Do not use bold.
2021-09-30 23:02:18 +05:30
- Do not use the phrase, **if you are a reporter** to mean someone who is assigned the Reporter
role. Instead, write it out. For example, **if you are assigned the Reporter role** .
- To describe a situation where the Reporter role is the minimum required:
2021-11-18 22:05:49 +05:30
- Do: at least the Reporter role
- Do not: the Reporter role or higher
2021-09-30 23:02:18 +05:30
Do not use **Reporter permissions** . A user who is assigned the Reporter role has a set of associated permissions.
2021-09-04 01:27:46 +05:30
2021-10-27 15:23:28 +05:30
## Repository Mirroring
2021-11-11 11:23:49 +05:30
Use title case for **Repository Mirroring** .
2021-10-27 15:23:28 +05:30
2021-09-04 01:27:46 +05:30
## roles
2021-11-18 22:05:49 +05:30
Do not use **roles** and [**permissions** ](#permissions ) interchangeably. Each user is assigned a role. Each role includes a set of permissions.
Roles are not the same as [**access levels** ](#access-level ).
2021-09-04 01:27:46 +05:30
2021-10-27 15:23:28 +05:30
## runner, runners
2021-11-11 11:23:49 +05:30
Use lowercase for **runners** . These are the agents that run CI/CD jobs. See also [GitLab Runner ](#gitlab-runner ) and [this issue ](https://gitlab.com/gitlab-org/gitlab/-/issues/233529 ).
2021-10-27 15:23:28 +05:30
2021-11-18 22:05:49 +05:30
## (s)
Do not use ** (s)** to make a word optionally plural. It can slow down comprehension. For example:
2021-12-11 22:18:48 +05:30
- Do: Select the jobs you want.
- Do not: Select the job(s) you want.
2021-11-18 22:05:49 +05:30
If you can select multiples of something, then write the word as plural.
2021-09-30 23:02:18 +05:30
## sanity check
2021-11-11 11:23:49 +05:30
Do not use **sanity check** . Use **check for completeness** instead. ([Vale](../testing.md#vale) rule: [`InclusionAbleism.yml` ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/InclusionAbleism.yml ))
2021-09-30 23:02:18 +05:30
2021-09-04 01:27:46 +05:30
## scalability
2021-11-11 11:23:49 +05:30
Do not use **scalability** when talking about increasing GitLab performance for additional users. The words scale or scaling
are sometimes acceptable, but references to increasing GitLab performance for additional users should direct readers
to the GitLab [reference architectures ](../../../administration/reference_architectures/index.md ) page.
## section
Use **section** to describe an area on a page. For example, if a page has lines that separate the UI
into separate areas, refer to these areas as sections.
We often think of expandable/collapsible areas as **sections** . When you refer to expanding
or collapsing a section, don't include the word **section** .
- Do: Expand **Auto DevOps** .
- Do not: Expand the **Auto DevOps** section.
## select
Use **select** with buttons, links, menu items, and lists. **Select** applies to more devices,
while **click** is more specific to a mouse.
2021-09-04 01:27:46 +05:30
2021-12-11 22:18:48 +05:30
## Service Desk
Use title case for **Service Desk** .
2021-09-30 23:02:18 +05:30
## setup, set up
Use **setup** as a noun, and **set up** as a verb. For example:
- Your remote office setup is amazing.
- To set up your remote office correctly, consider the ergonomics of your work area.
2021-10-27 15:23:28 +05:30
## sign in
2021-11-11 11:23:49 +05:30
Use **sign in** instead of **sign on** or **log on** or **log in** . If the user interface has different words, use those.
2021-10-27 15:23:28 +05:30
You can use **single sign-on** .
2021-09-30 23:02:18 +05:30
## simply, simple
2021-09-04 01:27:46 +05:30
2021-11-11 11:23:49 +05:30
Do not use **simply** or **simple** . If the user doesn't find the process to be simple, we lose their trust. ([Vale](../testing.md#vale) rule: [`Simplicity.yml` ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/Simplicity.yml ))
2021-09-04 01:27:46 +05:30
2021-11-18 22:05:49 +05:30
## since
The word **since** indicates a timeframe. For example, **Since 1984, Bon Jovi has existed** . Don't use **since** to mean **because** .
- Do: Because you have the Developer role, you can delete the widget.
- Do not: Since you have the Developer role, you can delete the widget.
2021-09-04 01:27:46 +05:30
## slashes
2021-09-30 23:02:18 +05:30
Instead of **and/or** , use **or** or re-write the sentence. This rule also applies to other slashes, like **follow/unfollow** . Some exceptions (like **CI/CD** ) are allowed.
## slave
2021-11-11 11:23:49 +05:30
Do not use **slave** . Another option is **secondary** . ([Vale](../testing.md#vale) rule: [`InclusionCultural.yml` ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/InclusionCultural.yml ))
2021-09-04 01:27:46 +05:30
## subgroup
2021-11-11 11:23:49 +05:30
Use **subgroup** (no hyphen) instead of **sub-group** . ([Vale](../testing.md#vale) rule: [`SubstitutionSuggestions.yml` ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/SubstitutionSuggestions.yml ))
2021-09-04 01:27:46 +05:30
## that
2021-11-11 11:23:49 +05:30
Do not use **that** when describing a noun. For example:
2021-09-30 23:02:18 +05:30
2021-11-11 11:23:49 +05:30
- Do: The file you save...
- Do not: The file **that** you save...
2021-09-30 23:02:18 +05:30
2021-10-27 15:23:28 +05:30
See also [this, these, that, those ](#this-these-that-those ).
## terminal
2021-11-11 11:23:49 +05:30
Use lowercase for **terminal** . For example:
2021-10-27 15:23:28 +05:30
- Open a terminal.
- From a terminal, run the `docker login` command.
2021-11-11 11:23:49 +05:30
## text box
Use **text box** instead of **field** or **box** when referring to the UI element.
2021-10-27 15:23:28 +05:30
## there is, there are
2021-11-11 11:23:49 +05:30
Try to avoid **there is** and **there are** . These phrases hide the subject.
2021-10-27 15:23:28 +05:30
2021-11-11 11:23:49 +05:30
- Do: The bucket has holes.
- Do not: There are holes in the bucket.
2021-10-27 15:23:28 +05:30
2021-09-30 23:02:18 +05:30
## they
Avoid the use of gender-specific pronouns, unless referring to a specific person.
Use a singular [they ](https://developers.google.com/style/pronouns#gender-neutral-pronouns ) as
a gender-neutral pronoun.
2021-09-04 01:27:46 +05:30
2021-10-27 15:23:28 +05:30
## this, these, that, those
Always follow these words with a noun. For example:
2021-11-11 11:23:49 +05:30
- Do: **This setting** improves performance.
- Do not: **This** improves performance.
2021-10-27 15:23:28 +05:30
2021-11-11 11:23:49 +05:30
- Do: **These pants** are the best.
- Do not: **These** are the best.
2021-10-27 15:23:28 +05:30
2021-11-11 11:23:49 +05:30
- Do: **That droid** is the one you are looking for.
- Do not: **That** is the one you are looking for.
2021-10-27 15:23:28 +05:30
2021-11-11 11:23:49 +05:30
- Do: **Those settings** need to be configured. (Or even better, **Configure those settings.** )
- Do not: **Those** need to be configured.
2021-10-27 15:23:28 +05:30
## to-do item
2021-11-11 11:23:49 +05:30
Use lowercase and hyphenate **to-do** item. ([Vale](../testing.md#vale) rule: [`ToDo.yml` ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/ToDo.yml ))
2021-10-27 15:23:28 +05:30
## To-Do List
2021-11-11 11:23:49 +05:30
Use title case for **To-Do List** . ([Vale](../testing.md#vale) rule: [`ToDo.yml` ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/ToDo.yml ))
## toggle
You **turn on** or **turn off** a toggle. For example:
- Turn on the **blah** toggle.
## type
Do not use **type** if you can avoid it. Use **enter** instead.
2021-10-27 15:23:28 +05:30
2021-09-04 01:27:46 +05:30
## useful
2021-11-11 11:23:49 +05:30
Do not use **useful** . If the user doesn't find the process to be useful, we lose their trust. ([Vale](../testing.md#vale) rule: [`Simplicity.yml` ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/Simplicity.yml ))
2021-09-04 01:27:46 +05:30
## utilize
2021-11-11 11:23:49 +05:30
Do not use **utilize** . Use **use** instead. It's more succinct and easier for non-native English speakers to understand.
([Vale](../testing.md#vale) rule: [`SubstitutionSuggestions.yml` ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/SubstitutionSuggestions.yml ))
2021-09-04 01:27:46 +05:30
2021-10-27 15:23:28 +05:30
## Value Stream Analytics
2021-11-11 11:23:49 +05:30
Use title case for **Value Stream Analytics** .
2021-10-27 15:23:28 +05:30
2021-09-04 01:27:46 +05:30
## via
Do not use Latin abbreviations. Use **with** , **through** , or **by using** instead. ([Vale](../testing.md#vale) rule: [`LatinTerms.yml` ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/LatinTerms.yml ))
2021-09-30 23:02:18 +05:30
## we
Try to avoid **we** and focus instead on how the user can accomplish something in GitLab.
2021-11-11 11:23:49 +05:30
- Do: Use widgets when you have work you want to organize.
- Do not: We created a feature for you to add widgets.
2021-09-30 23:02:18 +05:30
2021-11-11 11:23:49 +05:30
One exception: You can use **we recommend** instead of **it is recommended** or **GitLab recommends** . ([Vale](../testing.md#vale) rule: [`SubstitutionSuggestions.yml` ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/SubstitutionSuggestions.yml ))
2021-09-30 23:02:18 +05:30
## whitelist
2021-11-11 11:23:49 +05:30
Do not use **whitelist** . Another option is **allowlist** . ([Vale](../testing.md#vale) rule: [`InclusionCultural.yml` ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/InclusionCultural.yml ))
2021-09-30 23:02:18 +05:30
2021-09-04 01:27:46 +05:30
<!-- vale on -->
<!-- markdownlint - enable -->