diff options
Diffstat (limited to 'doc')
28 files changed, 44 insertions, 43 deletions
diff --git a/doc/architecture/blueprints/gitlab_steps/data.drawio.png b/doc/architecture/blueprints/gitlab_steps/data.drawio.png Binary files differindex 59436093fb7..5ffe2964134 100644 --- a/doc/architecture/blueprints/gitlab_steps/data.drawio.png +++ b/doc/architecture/blueprints/gitlab_steps/data.drawio.png diff --git a/doc/architecture/blueprints/gitlab_steps/step-runner-sequence.drawio.png b/doc/architecture/blueprints/gitlab_steps/step-runner-sequence.drawio.png Binary files differindex 9f6a6dcad9f..57029733b3c 100644 --- a/doc/architecture/blueprints/gitlab_steps/step-runner-sequence.drawio.png +++ b/doc/architecture/blueprints/gitlab_steps/step-runner-sequence.drawio.png diff --git a/doc/ci/environments/img/kubernetes_summary_ui.png b/doc/ci/environments/img/kubernetes_summary_ui.png Binary files differindex ce51cd8e96f..f8eae88745e 100644 --- a/doc/ci/environments/img/kubernetes_summary_ui.png +++ b/doc/ci/environments/img/kubernetes_summary_ui.png diff --git a/doc/ci/testing/img/code_quality_inline_indicator_v16_7.png b/doc/ci/testing/img/code_quality_inline_indicator_v16_7.png Binary files differindex 0d7d5bb3062..91285493562 100644 --- a/doc/ci/testing/img/code_quality_inline_indicator_v16_7.png +++ b/doc/ci/testing/img/code_quality_inline_indicator_v16_7.png diff --git a/doc/development/api_graphql_styleguide.md b/doc/development/api_graphql_styleguide.md index cfe82fe9b81..606d8c77432 100644 --- a/doc/development/api_graphql_styleguide.md +++ b/doc/development/api_graphql_styleguide.md @@ -178,7 +178,7 @@ Breaking changes are: allowed so long as all scalar type fields of the object continue to serialize in the same way. - Raising the [complexity](#max-complexity) of a field or complexity multipliers in a resolver. - Changing a field from being _not_ nullable (`null: false`) to nullable (`null: true`), as -discussed in [Nullable fields](#nullable-fields). + discussed in [Nullable fields](#nullable-fields). - Changing an argument from being optional (`required: false`) to being required (`required: true`). - Changing the [max page size](#page-size-limit) of a connection. - Lowering the global limits for query complexity and depth. @@ -1515,8 +1515,8 @@ To find the parent object in your `Presenter` class: ``` 1. Declare your field's method in your Presenter class and have it accept the `parent` keyword argument. -This argument contains the parent **GraphQL context**, so you have to access the parent object with -`parent[:parent_object]` or whatever key you used in your `Resolver`: + This argument contains the parent **GraphQL context**, so you have to access the parent object with + `parent[:parent_object]` or whatever key you used in your `Resolver`: ```ruby # in ChildPresenter diff --git a/doc/development/permissions/custom_roles.md b/doc/development/permissions/custom_roles.md index 844c3546f06..7c2e847c2bb 100644 --- a/doc/development/permissions/custom_roles.md +++ b/doc/development/permissions/custom_roles.md @@ -34,7 +34,7 @@ Like static roles, custom roles are [inherited](../../user/project/members/index - A Group or project membership can be associated with any custom role that is defined on the root-level group of the group or project. - The `member_roles` table includes individual permissions and a `base_access_level` value. - The `base_access_level` must be a [valid access level](../../api/access_requests.md#valid-access-levels). -The `base_access_level` determines which abilities are included in the custom role. For example, if the `base_access_level` is `10`, the custom role will include any abilities that a static Guest role would receive, plus any additional abilities that are enabled by the `member_roles` record by setting an attribute, such as `read_code`, to true. + The `base_access_level` determines which abilities are included in the custom role. For example, if the `base_access_level` is `10`, the custom role will include any abilities that a static Guest role would receive, plus any additional abilities that are enabled by the `member_roles` record by setting an attribute, such as `read_code`, to true. - A custom role can enable additional abilities for a `base_access_level` but it cannot disable a permission. As a result, custom roles are "additive only". The rationale for this choice is [in this comment](https://gitlab.com/gitlab-org/gitlab/-/issues/352891#note_1059561579). - Custom role abilities are supported at project level and group level. diff --git a/doc/integration/advanced_search/elasticsearch.md b/doc/integration/advanced_search/elasticsearch.md index 0a456e6c73e..896ad18033b 100644 --- a/doc/integration/advanced_search/elasticsearch.md +++ b/doc/integration/advanced_search/elasticsearch.md @@ -997,7 +997,7 @@ To create both an indexing and a non-indexing Sidekiq process in one node: ``` 1. Save the file and [reconfigure GitLab](../../administration/restart_gitlab.md) -for the changes to take effect. + for the changes to take effect. 1. On all other Rails and Sidekiq nodes, ensure that `sidekiq['routing_rules']` is the same as above. 1. Run the Rake task to [migrate existing jobs](../../administration/sidekiq/sidekiq_job_migration.md): @@ -1029,7 +1029,7 @@ To handle these queue groups on two nodes: ``` 1. Save the file and [reconfigure GitLab](../../administration/restart_gitlab.md) -for the changes to take effect. + for the changes to take effect. 1. To set up the non-indexing Sidekiq process, on your non-indexing Sidekiq node, change the `/etc/gitlab/gitlab.rb` file to: @@ -1052,7 +1052,7 @@ for the changes to take effect. 1. On all other Rails and Sidekiq nodes, ensure that `sidekiq['routing_rules']` is the same as above. 1. Save the file and [reconfigure GitLab](../../administration/restart_gitlab.md) -for the changes to take effect. + for the changes to take effect. 1. Run the Rake task to [migrate existing jobs](../../administration/sidekiq/sidekiq_job_migration.md): ```shell diff --git a/doc/integration/partner_marketplace.md b/doc/integration/partner_marketplace.md index 36aef0a0a90..cbcb8f70164 100644 --- a/doc/integration/partner_marketplace.md +++ b/doc/integration/partner_marketplace.md @@ -124,8 +124,8 @@ curl \ To create a new customer subscription from a Marketplace partner client application, - Make an authorized POST request to the -[`/api/v1/marketplace/subscriptions`](https://customers.staging.gitlab.com/openapi_docs/marketplace#/marketplace/post_api_v1_marketplace_subscriptions) -endpoint in the Customers Portal with the following parameters in JSON format: + [`/api/v1/marketplace/subscriptions`](https://customers.staging.gitlab.com/openapi_docs/marketplace#/marketplace/post_api_v1_marketplace_subscriptions) + endpoint in the Customers Portal with the following parameters in JSON format: | Parameter | Type | Required | Description | |--------------------------|--------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -144,8 +144,8 @@ If the subscription creation is unsuccessful, the response body includes an erro To get the status of a given subscription, - Make an authorized GET request to the -[`/api/v1/marketplace/subscriptions/{external_subscription_id}`](https://customers.staging.gitlab.com/openapi_docs/marketplace#/marketplace/get_api_v1_marketplace_subscriptions__external_subscription_id_) -endpoint in the Customers Portal. + [`/api/v1/marketplace/subscriptions/{external_subscription_id}`](https://customers.staging.gitlab.com/openapi_docs/marketplace#/marketplace/get_api_v1_marketplace_subscriptions__external_subscription_id_) + endpoint in the Customers Portal. The request must include the Marketplace partner system ID of the subscription to fetch the status for. diff --git a/doc/integration/saml.md b/doc/integration/saml.md index 3423b1bde6d..ac831b98a90 100644 --- a/doc/integration/saml.md +++ b/doc/integration/saml.md @@ -666,10 +666,12 @@ IdPs, contact your provider's support. Prerequisites: - Make sure you have access to a -[Google Workspace Super Admin account](https://support.google.com/a/answer/2405986#super_admin). + [Google Workspace Super Admin account](https://support.google.com/a/answer/2405986#super_admin). + +To set up a Google Workspace: 1. Use the following information, and follow the instructions in -[Set up your own custom SAML application in Google Workspace](https://support.google.com/a/answer/6087519?hl=en). + [Set up your own custom SAML application in Google Workspace](https://support.google.com/a/answer/6087519?hl=en). | | Typical value | Description | |:-----------------|:---------------------------------------------------|:----------------------------------------------------------------------------------------------| diff --git a/doc/integration/sourcegraph.md b/doc/integration/sourcegraph.md index f6fb387f016..198dda7ec95 100644 --- a/doc/integration/sourcegraph.md +++ b/doc/integration/sourcegraph.md @@ -42,7 +42,7 @@ If you are using an HTTPS connection to GitLab, you must [configure HTTPS](https 1. Navigate to the site Admin Area in Sourcegraph. 1. [Configure your GitLab external service](https://docs.sourcegraph.com/admin/external_service/gitlab). -You can skip this step if you already have your GitLab repositories searchable in Sourcegraph. + You can skip this step if you already have your GitLab repositories searchable in Sourcegraph. 1. Validate that you can search your repositories from GitLab in your Sourcegraph instance by running a test query. 1. Add your GitLab instance URL to the [`corsOrigin` setting](https://docs.sourcegraph.com/admin/config/site_config#corsOrigin) in your site configuration. diff --git a/doc/user/analytics/img/enhanced_issue_analytics_v16_7.png b/doc/user/analytics/img/enhanced_issue_analytics_v16_7.png Binary files differindex 519e56acaa5..b253fe336ee 100644 --- a/doc/user/analytics/img/enhanced_issue_analytics_v16_7.png +++ b/doc/user/analytics/img/enhanced_issue_analytics_v16_7.png diff --git a/doc/user/application_security/policies/img/scan_results_evaluation_white-bg.png b/doc/user/application_security/policies/img/scan_results_evaluation_white-bg.png Binary files differindex d2f5466e383..ac3164842a4 100644 --- a/doc/user/application_security/policies/img/scan_results_evaluation_white-bg.png +++ b/doc/user/application_security/policies/img/scan_results_evaluation_white-bg.png diff --git a/doc/user/application_security/sast/img/sast_inline_indicator_v16_7.png b/doc/user/application_security/sast/img/sast_inline_indicator_v16_7.png Binary files differindex c86f536afc4..582e55f1d0a 100644 --- a/doc/user/application_security/sast/img/sast_inline_indicator_v16_7.png +++ b/doc/user/application_security/sast/img/sast_inline_indicator_v16_7.png diff --git a/doc/user/application_security/sast/img/sast_mr_widget_v16_7.png b/doc/user/application_security/sast/img/sast_mr_widget_v16_7.png Binary files differindex 199f8b6d322..b293989ae21 100644 --- a/doc/user/application_security/sast/img/sast_mr_widget_v16_7.png +++ b/doc/user/application_security/sast/img/sast_mr_widget_v16_7.png diff --git a/doc/user/emoji_reactions.md b/doc/user/emoji_reactions.md index 10385da7cdc..a72c15bb229 100644 --- a/doc/user/emoji_reactions.md +++ b/doc/user/emoji_reactions.md @@ -15,8 +15,7 @@ and thumbs-ups. React with emoji on: - [Issues](project/issues/index.md). - [Tasks](tasks.md). -- [Merge requests](project/merge_requests/index.md), -[snippets](snippets.md). +- [Merge requests](project/merge_requests/index.md), [snippets](snippets.md). - [Epics](../user/group/epics/index.md). - [Objectives and key results](okrs.md). - Anywhere else you can have a comment thread. diff --git a/doc/user/group/issues_analytics/img/enhanced_issue_analytics_v16_7.png b/doc/user/group/issues_analytics/img/enhanced_issue_analytics_v16_7.png Binary files differindex 519e56acaa5..b253fe336ee 100644 --- a/doc/user/group/issues_analytics/img/enhanced_issue_analytics_v16_7.png +++ b/doc/user/group/issues_analytics/img/enhanced_issue_analytics_v16_7.png diff --git a/doc/user/group/saml_sso/troubleshooting_scim.md b/doc/user/group/saml_sso/troubleshooting_scim.md index 3dcb2d93096..e5af37e7327 100644 --- a/doc/user/group/saml_sso/troubleshooting_scim.md +++ b/doc/user/group/saml_sso/troubleshooting_scim.md @@ -149,9 +149,9 @@ The first workaround is: 1. Have the end user [link SAML to their existing GitLab.com account](index.md#link-saml-to-your-existing-gitlabcom-account). 1. After the user has done this, initiate a SCIM sync from your identity provider. -If the SCIM sync completes without the same error, GitLab has -successfully linked the SCIM identity to the existing user account, and the user -should now be able to sign in using SAML SSO. + If the SCIM sync completes without the same error, GitLab has + successfully linked the SCIM identity to the existing user account, and the user + should now be able to sign in using SAML SSO. If the error persists, the user most likely already exists, has both a SAML and SCIM identity, and a SCIM identity that is set to `active: false`. To resolve @@ -166,7 +166,7 @@ this: If any of this information does not match, [contact GitLab Support](https://support.gitlab.com/). 1. Use the API to [update the SCIM provisioned user's `active` value to `true`](/ee/development/internal_api/index.md#update-a-single-scim-provisioned-user). 1. If the update returns a status code `204`, have the user attempt to sign in -using SAML SSO. + using SAML SSO. ## Azure Active Directory diff --git a/doc/user/okrs.md b/doc/user/okrs.md index e08b245f088..1bed94a302b 100644 --- a/doc/user/okrs.md +++ b/doc/user/okrs.md @@ -72,7 +72,7 @@ To view an objective: 1. On the left sidebar, select **Search or go to** and find your project. 1. Select **Plan > Issues**. 1. [Filter the list of issues](project/issues/managing_issues.md#filter-the-list-of-issues) -for `Type = objective`. + for `Type = objective`. 1. Select the title of an objective from the list. ## View a key result @@ -82,7 +82,7 @@ To view a key result: 1. On the left sidebar, select **Search or go to** and find your project. 1. Select **Plan > Issues**. 1. [Filter the list of issues](project/issues/managing_issues.md#filter-the-list-of-issues) -for `Type = key_result`. + for `Type = key_result`. 1. Select the title of a key result from the list. Alternatively, you can access a key result from the **Child objectives and key results** section in diff --git a/doc/user/project/changelogs.md b/doc/user/project/changelogs.md index a15bd39f1b7..df6df1653ac 100644 --- a/doc/user/project/changelogs.md +++ b/doc/user/project/changelogs.md @@ -15,7 +15,7 @@ commit author. Changelog formats [can be customized](#customize-the-changelog-ou Each section in the default changelog has a title containing the version number and release date, like this: -````markdown +```markdown ## 1.0.0 (2021-01-05) ### Features (4 changes) @@ -24,7 +24,7 @@ number and release date, like this: - [Feature 2](gitlab-org/gitlab@456abc) ([merge request](gitlab-org/gitlab!456)) - [Feature 3](gitlab-org/gitlab@234abc) by @steve - [Feature 4](gitlab-org/gitlab@456) -```` +``` The date format for sections can be customized, but the rest of the title cannot. When adding new sections, GitLab parses these titles to determine where to place @@ -121,11 +121,11 @@ these variables: `### Features`, `### Bug fixes`, and `### Performance improvements`: ```yaml - --- - categories: - feature: Features - bug: Bug fixes - performance: Performance improvements + --- + categories: + feature: Features + bug: Bug fixes + performance: Performance improvements ``` ### Custom templates diff --git a/doc/user/project/issue_board.md b/doc/user/project/issue_board.md index e6fd302e4f0..39353480908 100644 --- a/doc/user/project/issue_board.md +++ b/doc/user/project/issue_board.md @@ -101,7 +101,7 @@ For examples of using issue boards along with [epics](../group/epics/index.md), - [How to use GitLab for Agile portfolio planning and project management](https://about.gitlab.com/blog/2020/11/11/gitlab-for-agile-portfolio-planning-project-management/) blog post (November 2020) - <i class="fa fa-youtube-play youtube" aria-hidden="true"></i> -[Cross-project Agile work management with GitLab](https://www.youtube.com/watch?v=5J0bonGoECs) (15 min, July 2020) + [Cross-project Agile work management with GitLab](https://www.youtube.com/watch?v=5J0bonGoECs) (15 min, July 2020) ### Use cases for a single issue board diff --git a/doc/user/project/labels.md b/doc/user/project/labels.md index 2cc38e6a31c..f064d867e0f 100644 --- a/doc/user/project/labels.md +++ b/doc/user/project/labels.md @@ -14,7 +14,7 @@ you're interested in. Labels are a key part of [issue boards](issue_board.md). With labels you can: - Categorize [epics](../group/epics/index.md), issues, and merge requests using colors and descriptive titles like -`bug`, `feature request`, or `docs`. + `bug`, `feature request`, or `docs`. - Dynamically filter and manage [epics](../group/epics/index.md), issues, and merge requests. - Search lists of issues, merge requests, and epics, as well as issue boards. diff --git a/doc/user/project/merge_requests/approvals/img/group_access_example_01_v16_8.png b/doc/user/project/merge_requests/approvals/img/group_access_example_01_v16_8.png Binary files differindex dc2940f9492..0b5fbf7e075 100644 --- a/doc/user/project/merge_requests/approvals/img/group_access_example_01_v16_8.png +++ b/doc/user/project/merge_requests/approvals/img/group_access_example_01_v16_8.png diff --git a/doc/user/project/merge_requests/approvals/img/group_access_example_02_v16_8.png b/doc/user/project/merge_requests/approvals/img/group_access_example_02_v16_8.png Binary files differindex e1305ff845c..49df19f2c46 100644 --- a/doc/user/project/merge_requests/approvals/img/group_access_example_02_v16_8.png +++ b/doc/user/project/merge_requests/approvals/img/group_access_example_02_v16_8.png diff --git a/doc/user/project/releases/index.md b/doc/user/project/releases/index.md index 6c31b2ad5d3..1d721d71444 100644 --- a/doc/user/project/releases/index.md +++ b/doc/user/project/releases/index.md @@ -70,7 +70,7 @@ You should create a release as one of the last steps in your CI/CD pipeline. Prerequisites: - You must have at least the Developer role for a project. For more information, read -[Release permissions](#release-permissions). + [Release permissions](#release-permissions). To create a release in the Releases page: diff --git a/doc/user/project/repository/mirror/bidirectional.md b/doc/user/project/repository/mirror/bidirectional.md index d4ab550cb8a..dc789d28a4f 100644 --- a/doc/user/project/repository/mirror/bidirectional.md +++ b/doc/user/project/repository/mirror/bidirectional.md @@ -39,7 +39,7 @@ instance can help reduce race conditions by syncing changes more frequently. Prerequisites: - You have configured the [push](push.md#set-up-a-push-mirror-to-another-gitlab-instance-with-2fa-activated) -and [pull](pull.md#pull-from-a-remote-repository) mirrors in the upstream GitLab instance. + and [pull](pull.md#pull-from-a-remote-repository) mirrors in the upstream GitLab instance. To create the webhook in the downstream instance: diff --git a/doc/user/project/settings/import_export.md b/doc/user/project/settings/import_export.md index dea50ecc408..f2faa0676b5 100644 --- a/doc/user/project/settings/import_export.md +++ b/doc/user/project/settings/import_export.md @@ -347,7 +347,7 @@ Items that are **not** exported include: ### Preparation - To preserve the member list and their respective permissions on imported groups, review the users in these groups. Make -sure these users exist before importing the desired groups. + sure these users exist before importing the desired groups. - Users must set a public email in the source GitLab instance that matches their confirmed primary email in the destination GitLab instance. Most users receive an email asking them to confirm their email address. ### Enable export for a group @@ -407,11 +407,11 @@ Default [modified](https://gitlab.com/gitlab-org/gitlab/-/issues/251106) from 50 To help avoid abuse, by default, users are rate limited to: -| Request Type | Limit | -| ---------------- | ---------------------------------------- | -| Export | 6 groups per minute | -| Download export | 1 download per group per minute | -| Import | 6 groups per minute | +| Request Type | Limit | +|-----------------|-------| +| Export | 6 groups per minute | +| Download export | 1 download per group per minute | +| Import | 6 groups per minute | ## Related topics diff --git a/doc/user/storage_management_automation.md b/doc/user/storage_management_automation.md index f25ae8ba92d..e04a7f1bdee 100644 --- a/doc/user/storage_management_automation.md +++ b/doc/user/storage_management_automation.md @@ -78,7 +78,7 @@ For more information, see the [GitLab CLI endpoint documentation](../editor_exte The storage management and cleanup automation methods described in this page use: - The [`python-gitlab`](https://python-gitlab.readthedocs.io/en/stable/) library, which provides -a feature-rich programming interface. + a feature-rich programming interface. - The `get_all_projects_top_level_namespace_storage_analysis_cleanup_example.py` script in the [GitLab API with Python](https://gitlab.com/gitlab-de/use-cases/gitlab-api/gitlab-api-python/) project. For more information about use cases for the `python-gitlab` library, diff --git a/doc/user/usage_quotas.md b/doc/user/usage_quotas.md index 973ad9d0b07..2dc5c1ef819 100644 --- a/doc/user/usage_quotas.md +++ b/doc/user/usage_quotas.md @@ -163,11 +163,11 @@ Storage limits are included in GitLab subscription terms but do not apply. At le GitLab will notify you of namespaces that exceed, or are close to exceeding, the storage limit. - In the command-line interface, a notification displays after each `git push` -action when your namespace has reached between 95% and 100% of your namespace storage quota. + action when your namespace has reached between 95% and 100% of your namespace storage quota. - In the GitLab UI, a notification displays when your namespace has reached between -75% and 100% of your namespace storage quota. + 75% and 100% of your namespace storage quota. - GitLab sends an email to members with the Owner role to notify them when namespace -storage usage is at 70%, 85%, 95%, and 100%. + storage usage is at 70%, 85%, 95%, and 100%. ## Manage storage usage |
