Commit 2ed3cde8 authored by Evan Read's avatar Evan Read

Merge branch 'selhorn-checkbox-update-add' into 'master'

Added guidance for the word 'checkbox'

See merge request gitlab-org/gitlab!68113
parents 3ddf80ec 0b3181ad
...@@ -23,7 +23,7 @@ The following steps enable AWS Cognito as an authentication provider: ...@@ -23,7 +23,7 @@ The following steps enable AWS Cognito as an authentication provider:
1. Under **How do you want your end users to sign in?**, select **Email address or phone number** and **Allow email addresses**. 1. Under **How do you want your end users to sign in?**, select **Email address or phone number** and **Allow email addresses**.
1. Under **Which standard attributes do you want to require?**, select **email**. 1. Under **Which standard attributes do you want to require?**, select **email**.
1. Go to the next steps of configuration and set the rest of the settings to suit your needs - in the basic setup they are not related to GitLab configuration. 1. Go to the next steps of configuration and set the rest of the settings to suit your needs - in the basic setup they are not related to GitLab configuration.
1. In the **App clients** settings, click **Add an app client**, add **App client name** and select the **Enable username password based authentication** check box. 1. In the **App clients** settings, click **Add an app client**, add **App client name** and select the **Enable username password based authentication** checkbox.
1. Click **Create app client**. 1. Click **Create app client**.
1. In the next step, you can set up AWS Lambda functions for sending emails. You can then finish creating the pool. 1. In the next step, you can set up AWS Lambda functions for sending emails. You can then finish creating the pool.
1. After creating the user pool, go to **App client settings** and provide the required information: 1. After creating the user pool, go to **App client settings** and provide the required information:
......
...@@ -208,7 +208,7 @@ After configuring your local PlantUML server, you're ready to enable the PlantUM ...@@ -208,7 +208,7 @@ After configuring your local PlantUML server, you're ready to enable the PlantUM
1. Sign in to GitLab as an [Administrator](../../user/permissions.md) user. 1. Sign in to GitLab as an [Administrator](../../user/permissions.md) user.
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu >** **{admin}** **Admin**.
1. In the left sidebar, go to **Settings > General** and expand the **PlantUML** section. 1. In the left sidebar, go to **Settings > General** and expand the **PlantUML** section.
1. Select the **Enable PlantUML** check box. 1. Select the **Enable PlantUML** checkbox.
1. Set the PlantUML instance as `https://gitlab.example.com/-/plantuml/`, 1. Set the PlantUML instance as `https://gitlab.example.com/-/plantuml/`,
and click **Save changes**. and click **Save changes**.
......
...@@ -64,7 +64,7 @@ To enable pipelines for merged results for your project: ...@@ -64,7 +64,7 @@ To enable pipelines for merged results for your project:
1. Click **Save changes**. 1. Click **Save changes**.
WARNING: WARNING:
If you select the check box but don't configure your CI/CD to use If you select the checkbox but don't configure your CI/CD to use
pipelines for merge requests, your merge requests may become stuck in an pipelines for merge requests, your merge requests may become stuck in an
unresolved state or your pipelines may be dropped. unresolved state or your pipelines may be dropped.
......
...@@ -294,7 +294,7 @@ To mask a variable: ...@@ -294,7 +294,7 @@ To mask a variable:
1. In the project, group, or Admin Area, go to **Settings > CI/CD**. 1. In the project, group, or Admin Area, go to **Settings > CI/CD**.
1. Expand the **Variables** section. 1. Expand the **Variables** section.
1. Next to the variable you want to protect, select **Edit**. 1. Next to the variable you want to protect, select **Edit**.
1. Select the **Mask variable** check box. 1. Select the **Mask variable** checkbox.
1. Select **Update variable**. 1. Select **Update variable**.
The value of the variable must: The value of the variable must:
...@@ -331,7 +331,7 @@ To protect a variable: ...@@ -331,7 +331,7 @@ To protect a variable:
1. Go to **Settings > CI/CD** in the project, group or instance admin area. 1. Go to **Settings > CI/CD** in the project, group or instance admin area.
1. Expand the **Variables** section. 1. Expand the **Variables** section.
1. Next to the variable you want to protect, select **Edit**. 1. Next to the variable you want to protect, select **Edit**.
1. Select the **Protect variable** check box. 1. Select the **Protect variable** checkbox.
1. Select **Update variable**. 1. Select **Update variable**.
The variable is available for all subsequent pipelines. The variable is available for all subsequent pipelines.
......
...@@ -61,6 +61,10 @@ in the handbook when writing about Beta features. ...@@ -61,6 +61,10 @@ in the handbook when writing about Beta features.
Do not use. Another option is **denylist**. ([Vale](../testing.md#vale) rule: [`InclusionCultural.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/InclusionCultural.yml)) Do not use. Another option is **denylist**. ([Vale](../testing.md#vale) rule: [`InclusionCultural.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/InclusionCultural.yml))
## checkbox
One word, **checkbox**. Do not use **check box**.
## CI/CD ## CI/CD
Always uppercase. No need to spell out on first use. Always uppercase. No need to spell out on first use.
......
...@@ -213,7 +213,7 @@ Potential resolutions: ...@@ -213,7 +213,7 @@ Potential resolutions:
the query string. the query string.
1. If `scope=api` is missing from the URL, edit the 1. If `scope=api` is missing from the URL, edit the
[GitLab account configuration](#configure-a-gitlab-application-for-dvcs). Review [GitLab account configuration](#configure-a-gitlab-application-for-dvcs). Review
the **Scopes** field and ensure the `api` check box is selected. the **Scopes** field and ensure the `api` checkbox is selected.
### Jira error adding account and no repositories listed ### Jira error adding account and no repositories listed
......
...@@ -59,7 +59,7 @@ To enforce this: ...@@ -59,7 +59,7 @@ To enforce this:
1. Navigate to your project's **Settings > General** page. 1. Navigate to your project's **Settings > General** page.
1. Expand the **Merge requests** section. 1. Expand the **Merge requests** section.
1. Under **Merge checks**, select the **Require an associated issue from Jira** check box. 1. Under **Merge checks**, select the **Require an associated issue from Jira** checkbox.
1. Select **Save** for the changes to take effect. 1. Select **Save** for the changes to take effect.
After you enable this feature, a merge request that doesn't reference an associated After you enable this feature, a merge request that doesn't reference an associated
...@@ -150,7 +150,7 @@ Jira issue to the next available status with a category of **Done**. To configur ...@@ -150,7 +150,7 @@ Jira issue to the next available status with a category of **Done**. To configur
this setting: this setting:
1. Refer to the [Configure GitLab](configure.md) instructions. 1. Refer to the [Configure GitLab](configure.md) instructions.
1. Select the **Enable Jira transitions** check box. 1. Select the **Enable Jira transitions** checkbox.
1. Select the **Move to Done** option. 1. Select the **Move to Done** option.
## Custom issue transitions ## Custom issue transitions
...@@ -180,7 +180,7 @@ GitLab can cross-link source commits or merge requests with Jira issues without ...@@ -180,7 +180,7 @@ GitLab can cross-link source commits or merge requests with Jira issues without
adding a comment to the Jira issue: adding a comment to the Jira issue:
1. Refer to the [Configure GitLab](configure.md) instructions. 1. Refer to the [Configure GitLab](configure.md) instructions.
1. Clear the **Enable comments** check box. 1. Clear the **Enable comments** checkbox.
## Enable or disable the ability to require an associated Jira issue on merge requests ## Enable or disable the ability to require an associated Jira issue on merge requests
......
...@@ -264,7 +264,7 @@ To enable/disable an OmniAuth provider: ...@@ -264,7 +264,7 @@ To enable/disable an OmniAuth provider:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu >** **{admin}** **Admin**.
1. In the left sidebar, go to **Settings**. 1. In the left sidebar, go to **Settings**.
1. Scroll to the **Sign-in Restrictions** section, and click **Expand**. 1. Scroll to the **Sign-in Restrictions** section, and click **Expand**.
1. Below **Enabled OAuth Sign-In sources**, select the check box for each provider you want to enable or disable. 1. Below **Enabled OAuth Sign-In sources**, select the checkbox for each provider you want to enable or disable.
![Enabled OAuth Sign-In sources](img/enabled-oauth-sign-in-sources_v13_10.png) ![Enabled OAuth Sign-In sources](img/enabled-oauth-sign-in-sources_v13_10.png)
......
...@@ -55,7 +55,7 @@ To create a system hook: ...@@ -55,7 +55,7 @@ To create a system hook:
1. On the top bar, select **Menu >** **{admin}** **Admin**. 1. On the top bar, select **Menu >** **{admin}** **Admin**.
1. In the left sidebar, select **System Hooks**. 1. In the left sidebar, select **System Hooks**.
1. Provide the **URL** and **Secret Token**. 1. Provide the **URL** and **Secret Token**.
1. Select the check box next to each **Trigger** you want to enable. 1. Select the checkbox next to each **Trigger** you want to enable.
1. Select **Enable SSL verification**, if desired. 1. Select **Enable SSL verification**, if desired.
1. Click **Add system hook**. 1. Click **Add system hook**.
......
...@@ -121,7 +121,7 @@ configuration. Otherwise, the Okta SCIM app may not work properly. ...@@ -121,7 +121,7 @@ configuration. Otherwise, the Okta SCIM app may not work properly.
1. In the **Application** tab, click **Add Application**. 1. In the **Application** tab, click **Add Application**.
1. Search for **GitLab**, find and click on the 'GitLab' application. 1. Search for **GitLab**, find and click on the 'GitLab' application.
1. On the GitLab application overview page, click **Add**. 1. On the GitLab application overview page, click **Add**.
1. Under **Application Visibility** select both check boxes. Currently the GitLab application does not support SAML authentication so the icon should not be shown to users. 1. Under **Application Visibility** select both checkboxes. Currently the GitLab application does not support SAML authentication so the icon should not be shown to users.
1. Click **Done** to finish adding the application. 1. Click **Done** to finish adding the application.
1. In the **Provisioning** tab, click **Configure API integration**. 1. In the **Provisioning** tab, click **Configure API integration**.
1. Select **Enable API integration**. 1. Select **Enable API integration**.
......
...@@ -56,11 +56,11 @@ Your **Global notification settings** are the default settings unless you select ...@@ -56,11 +56,11 @@ Your **Global notification settings** are the default settings unless you select
different values for a project or a group. different values for a project or a group.
- **Notification email**: the email address your notifications are sent to. - **Notification email**: the email address your notifications are sent to.
- **Receive product marketing emails**: select this check box to receive - **Receive product marketing emails**: select this checkbox to receive
[periodic emails](#product-marketing-emails) about GitLab features. [periodic emails](#product-marketing-emails) about GitLab features.
- **Global notification level**: the default [notification level](#notification-levels) - **Global notification level**: the default [notification level](#notification-levels)
which applies to all your notifications. which applies to all your notifications.
- **Receive notifications about your own activity**: select this check box to receive - **Receive notifications about your own activity**: select this checkbox to receive
notifications about your own activity. Not selected by default. notifications about your own activity. Not selected by default.
![notification settings](img/notification_global_settings_v13_12.png) ![notification settings](img/notification_global_settings_v13_12.png)
......
...@@ -110,7 +110,7 @@ provide to GitLab: ...@@ -110,7 +110,7 @@ provide to GitLab:
1. In the GitLab browser tab from 1. In the GitLab browser tab from
[getting configuration values from GitLab](#get-configuration-values-from-gitlab), [getting configuration values from GitLab](#get-configuration-values-from-gitlab),
select the **Active** check box to enable this configuration. select the **Active** checkbox to enable this configuration.
1. In the **Token** field, paste the token you obtained from Mattermost. 1. In the **Token** field, paste the token you obtained from Mattermost.
ensure that the **Active** toggle is enabled. ensure that the **Active** toggle is enabled.
......
...@@ -38,7 +38,7 @@ GitLab to send the notifications: ...@@ -38,7 +38,7 @@ GitLab to send the notifications:
to your project's page. to your project's page.
1. Go to **Settings > Integrations** and select **Microsoft Teams Notification**. 1. Go to **Settings > Integrations** and select **Microsoft Teams Notification**.
1. Select **Active** to enable the integration. 1. Select **Active** to enable the integration.
1. Select the check box next to each **Trigger** to enable: 1. Select the checkbox next to each **Trigger** to enable:
- Push - Push
- Issue - Issue
- Confidential issue - Confidential issue
...@@ -51,7 +51,7 @@ GitLab to send the notifications: ...@@ -51,7 +51,7 @@ GitLab to send the notifications:
1. In **Webhook**, paste the URL you copied when you 1. In **Webhook**, paste the URL you copied when you
[configured Microsoft Teams](#configure-microsoft-teams). [configured Microsoft Teams](#configure-microsoft-teams).
1. (Optional) If you enabled the pipeline trigger, you can select the 1. (Optional) If you enabled the pipeline trigger, you can select the
**Notify only broken pipelines** check box to push notifications only when pipelines break. **Notify only broken pipelines** checkbox to push notifications only when pipelines break.
1. Select the branches you want to send notifications for. 1. Select the branches you want to send notifications for.
1. Click **Save changes**. 1. Click **Save changes**.
......
...@@ -61,7 +61,7 @@ meaningful commit messages and: ...@@ -61,7 +61,7 @@ meaningful commit messages and:
## Enabling squash for a merge request ## Enabling squash for a merge request
Anyone who can create or edit a merge request can choose for it to be squashed Anyone who can create or edit a merge request can choose for it to be squashed
on the merge request form. Users can select or clear the check box when they on the merge request form. Users can select or clear the checkbox when they
create the merge request: create the merge request:
![Squash commits checkbox on edit form](img/squash_edit_form.png) ![Squash commits checkbox on edit form](img/squash_edit_form.png)
......
...@@ -181,7 +181,7 @@ To subscribe to notifications for releases: ...@@ -181,7 +181,7 @@ To subscribe to notifications for releases:
1. On the left sidebar, select **Project information**. 1. On the left sidebar, select **Project information**.
1. Click **Notification setting** (the bell icon). 1. Click **Notification setting** (the bell icon).
1. In the list, click **Custom**. 1. In the list, click **Custom**.
1. Select the **New release** check box. 1. Select the **New release** checkbox.
1. Close the dialog box to save. 1. Close the dialog box to save.
## Prevent unintentional releases by setting a deploy freeze ## Prevent unintentional releases by setting a deploy freeze
......
...@@ -40,7 +40,7 @@ To update the default branch name for an individual [project](../../index.md): ...@@ -40,7 +40,7 @@ To update the default branch name for an individual [project](../../index.md):
1. Sign in to GitLab as a user with the [Administrator](../../../permissions.md) role. 1. Sign in to GitLab as a user with the [Administrator](../../../permissions.md) role.
1. In the left navigation menu, go to **Settings > Repository**. 1. In the left navigation menu, go to **Settings > Repository**.
1. Expand **Default branch**, and select a new default branch. 1. Expand **Default branch**, and select a new default branch.
1. (Optional) Select the **Auto-close referenced issues on default branch** check box to close 1. (Optional) Select the **Auto-close referenced issues on default branch** checkbox to close
issues when a merge request issues when a merge request
[uses a closing pattern](../../issues/managing_issues.md#closing-issues-automatically). [uses a closing pattern](../../issues/managing_issues.md#closing-issues-automatically).
1. Select **Save changes**. 1. Select **Save changes**.
......
...@@ -62,8 +62,8 @@ For an existing project, you can set up push mirroring as follows: ...@@ -62,8 +62,8 @@ For an existing project, you can set up push mirroring as follows:
1. In the **Mirror direction** dropdown, select **Push**. 1. In the **Mirror direction** dropdown, select **Push**.
1. Select an authentication method from the **Authentication method** dropdown. 1. Select an authentication method from the **Authentication method** dropdown.
You can authenticate with either a password or an [SSH key](#ssh-authentication). You can authenticate with either a password or an [SSH key](#ssh-authentication).
1. Select the **Only mirror protected branches** check box, if necessary. 1. Select the **Only mirror protected branches** checkbox, if necessary.
1. Select the **Keep divergent refs** check box, if desired. 1. Select the **Keep divergent refs** checkbox, if desired.
1. Select **Mirror repository** to save the configuration. 1. Select **Mirror repository** to save the configuration.
When push mirroring is enabled, only push commits directly to the mirrored repository to prevent the When push mirroring is enabled, only push commits directly to the mirrored repository to prevent the
......
...@@ -214,7 +214,7 @@ When creating or uploading a new file or creating a new directory, you can ...@@ -214,7 +214,7 @@ When creating or uploading a new file or creating a new directory, you can
trigger a new merge request rather than committing directly to your default branch: trigger a new merge request rather than committing directly to your default branch:
1. Enter a new branch name in the **Target branch** field. 1. Enter a new branch name in the **Target branch** field.
1. GitLab displays the **Start a new merge request with these changes** check box. 1. GitLab displays the **Start a new merge request with these changes** checkbox.
1. Commit your changes, and GitLab redirects you to a new merge request form. 1. Commit your changes, and GitLab redirects you to a new merge request form.
![Start a new merge request with these changes](img/web_editor_start_new_merge_request.png) ![Start a new merge request with these changes](img/web_editor_start_new_merge_request.png)
......
...@@ -68,7 +68,7 @@ To edit a requirement: ...@@ -68,7 +68,7 @@ To edit a requirement:
1. From the requirements list, select the **Edit** icon (**{pencil}**). 1. From the requirements list, select the **Edit** icon (**{pencil}**).
1. Update the title and description in text input field. You can also mark a 1. Update the title and description in text input field. You can also mark a
requirement as satisfied in the edit form by using the check box **Satisfied**. requirement as satisfied in the edit form by using the checkbox **Satisfied**.
1. Select **Save changes**. 1. Select **Save changes**.
## Archive a requirement ## Archive a requirement
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment