diff options
Diffstat (limited to 'doc')
42 files changed, 106 insertions, 84 deletions
diff --git a/doc/administration/auth/index.md b/doc/administration/auth/index.md index 95268f6f39b..dd7f9cec77e 100644 --- a/doc/administration/auth/index.md +++ b/doc/administration/auth/index.md @@ -1,6 +1,7 @@ --- stage: Govern group: Authentication +description: Third-party authentication providers. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- diff --git a/doc/administration/configure.md b/doc/administration/configure.md index 8b4f8a9abc6..7ae088cd783 100644 --- a/doc/administration/configure.md +++ b/doc/administration/configure.md @@ -1,6 +1,7 @@ --- stage: Systems group: Distribution +description: Installation settings. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- diff --git a/doc/administration/dedicated/index.md b/doc/administration/dedicated/index.md index 05a241b65dc..c43169250f0 100644 --- a/doc/administration/dedicated/index.md +++ b/doc/administration/dedicated/index.md @@ -1,8 +1,8 @@ --- stage: SaaS Platforms group: GitLab Dedicated -info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments" -description: 'Learn how to configure your GitLab Dedicated instance.' +description: IP allowlists, SAML, maintenance. +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- # Configure GitLab Dedicated **(ULTIMATE)** diff --git a/doc/administration/license.md b/doc/administration/license.md index 1e77d83825d..9b95af28eed 100644 --- a/doc/administration/license.md +++ b/doc/administration/license.md @@ -40,7 +40,7 @@ The subscription is activated. You can use one activation code or license key for multiple self-managed instances if the users on these instances are the same or are a subset of your licensed production instance. This means that if -you have a licensed production instance of GitLab, and other instances with the same list of users, the +you have a licensed production instance of GitLab, and other instances with the same list of users, the production activation code applies, even if these users are configured in different groups and projects. ### Uploading licenses for scaled architectures diff --git a/doc/administration/operations/index.md b/doc/administration/operations/index.md index 33f407b2dbf..d1ec818a2a5 100644 --- a/doc/administration/operations/index.md +++ b/doc/administration/operations/index.md @@ -1,6 +1,7 @@ --- stage: Systems group: Distribution +description: Backup and restore, move repos, maintenance tasks. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- diff --git a/doc/administration/reference_architectures/index.md b/doc/administration/reference_architectures/index.md index a9e3f2c1109..7e4e929f80d 100644 --- a/doc/administration/reference_architectures/index.md +++ b/doc/administration/reference_architectures/index.md @@ -1,6 +1,7 @@ --- stage: Systems group: Distribution +description: Recommended deployments at scale. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- diff --git a/doc/administration/settings/index.md b/doc/administration/settings/index.md index 531073887c5..2df9d1cd52d 100644 --- a/doc/administration/settings/index.md +++ b/doc/administration/settings/index.md @@ -1,6 +1,7 @@ --- stage: none group: unassigned +description: Product settings. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- diff --git a/doc/api/runners.md b/doc/api/runners.md index ac854a477d3..373fc4e4344 100644 --- a/doc/api/runners.md +++ b/doc/api/runners.md @@ -14,6 +14,7 @@ This page describes endpoints for runners registered to an instance. To create a GET /runners GET /runners/all GET /runners/:id/jobs +GET /runners/:id/managers/:system_id/jobs GET /projects/:id/runners GET /groups/:id/runners ``` @@ -367,7 +368,7 @@ NOTE: The `active` form attribute was deprecated [in GitLab 14.8](https://gitlab.com/gitlab-org/gitlab/-/issues/347211). and will be removed in [a future version of the REST API](https://gitlab.com/gitlab-org/gitlab/-/issues/351109). It is replaced by the `paused` attribute. -## List runner's jobs +## List jobs processed by a runner > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/15432) in GitLab 10.3. @@ -378,12 +379,13 @@ to projects where the user has at least the Reporter role. GET /runners/:id/jobs ``` -| Attribute | Type | Required | Description | -|-----------|---------|----------|---------------------| -| `id` | integer | yes | The ID of a runner | -| `status` | string | no | Status of the job; one of: `running`, `success`, `failed`, `canceled` | -| `order_by`| string | no | Order jobs by `id` | -| `sort` | string | no | Sort jobs in `asc` or `desc` order (default: `desc`). Specify `order_by` as well, including for `id`. | +| Attribute | Type | Required | Description | +|-------------|---------|----------|---------------------| +| `id` | integer | yes | The ID of a runner | +| `system_id` | string | no | System ID of the machine where the runner manager is running | +| `status` | string | no | Status of the job; one of: `running`, `success`, `failed`, `canceled` | +| `order_by` | string | no | Order jobs by `id` | +| `sort` | string | no | Sort jobs in `asc` or `desc` order (default: `desc`). If `sort` is specified, `order_by` must be specified as well | ```shell curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/runners/1/jobs?status=running" diff --git a/doc/architecture/blueprints/cells/routing-service.md b/doc/architecture/blueprints/cells/routing-service.md index 2b4fa88f187..bd5570b68f4 100644 --- a/doc/architecture/blueprints/cells/routing-service.md +++ b/doc/architecture/blueprints/cells/routing-service.md @@ -378,7 +378,7 @@ Each Cell does implement classification endpoint: requests for sharding keys that are not found. - The cached response is for time defined by `expiry` and `refresh`. - The `expiry` defines when the item is removed from cache unless used. - - The `refresh` defines when the item needs to be reclassified if used. + - The `refresh` defines when the item needs to be reclassified if used. - The refresh is done asynchronously as the request should be served without a delay if they were classified. The refresh is done to ensure that cache is always hot and up-to date. For the above example: diff --git a/doc/architecture/blueprints/runner_admission_controller/index.md b/doc/architecture/blueprints/runner_admission_controller/index.md index 21dc1d53303..0a62b271901 100644 --- a/doc/architecture/blueprints/runner_admission_controller/index.md +++ b/doc/architecture/blueprints/runner_admission_controller/index.md @@ -140,7 +140,7 @@ Each runner has a tag identifier unique to that runner, e.g. `DiscoveryOne`, `tu 1. The `preparing` state will wait for a response from the webhook or until timeout. 1. The UI should be updated with the current status of the job prerequisites and admission 1. For jobs where the webhook times out (1 hour) their status should be set as though the admission was denied with a timeout reasoning. This should -be rare in typical circumstances. + be rare in typical circumstances. 1. Jobs with denied admission can be retried. Retried jobs will be resent to the admission controller without tag mutations or runner filtering reset. 1. [`allow_failure`](../../../ci/yaml/index.md#allow_failure) should be updated to support jobs that fail on denied admissions, for example: diff --git a/doc/architecture/blueprints/runner_tokens/index.md b/doc/architecture/blueprints/runner_tokens/index.md index f2e9d624d20..c667a460f5c 100644 --- a/doc/architecture/blueprints/runner_tokens/index.md +++ b/doc/architecture/blueprints/runner_tokens/index.md @@ -284,11 +284,11 @@ not an issue per-se. New records are created in 2 situations: -- when the runner calls the `POST /api/v4/runners/verify` endpoint as part of the -`gitlab-runner register` command, if the specified runner token is prefixed with `glrt-`. -This allows the frontend to determine whether the user has successfully completed the registration and take an -appropriate action; -- when GitLab is pinged for new jobs and a record matching the `token`+`system_id` does not already exist. +- When the runner calls the `POST /api/v4/runners/verify` endpoint as part of the + `gitlab-runner register` command, if the specified runner token is prefixed with `glrt-`. + This allows the frontend to determine whether the user has successfully completed the registration and take an + appropriate action; +- When GitLab is pinged for new jobs and a record matching the `token`+`system_id` does not already exist. Due to the time-decaying nature of the `ci_runner_machines` records, they are automatically cleaned after 7 days after the last contact from the respective runner. diff --git a/doc/architecture/blueprints/secret_manager/index.md b/doc/architecture/blueprints/secret_manager/index.md index ac30f3399d8..3a538f58dde 100644 --- a/doc/architecture/blueprints/secret_manager/index.md +++ b/doc/architecture/blueprints/secret_manager/index.md @@ -114,10 +114,10 @@ the data keys mentioned above. ### Further investigations required 1. Management of identities stored in GCP Key Management. -We need to investigate how we can correlate and de-multiplex GitLab identities into -GCP identities that are used to allow access to cryptographic operations on GCP Key Management. + We need to investigate how we can correlate and de-multiplex GitLab identities into + GCP identities that are used to allow access to cryptographic operations on GCP Key Management. 1. Authentication of clients. Clients to the Secrets Manager could be GitLab Runner or external clients. -For each of these, we need a secure and reliable method to authenticate requests to decrypt a secret. + For each of these, we need a secure and reliable method to authenticate requests to decrypt a secret. 1. Assignment of GCP backed private keys to each identity. ### Availability on SaaS and Self-Managed diff --git a/doc/ci/runners/runner_fleet_dashboard.md b/doc/ci/runners/runner_fleet_dashboard.md index 08579f6ff92..ce487ff7386 100644 --- a/doc/ci/runners/runner_fleet_dashboard.md +++ b/doc/ci/runners/runner_fleet_dashboard.md @@ -17,6 +17,8 @@ The Runner Fleet Dashboard shows: - Number of concurrent jobs executed on most busy runners. - Histogram of job queue times [(available only with ClickHouse)](#enable-more-ci-analytics-features-with-clickhouse). +Support for usage and cost analysis are proposed in [epic 11183](https://gitlab.com/groups/gitlab-org/-/epics/11183). +  ## View the Runner Fleet Dashboard @@ -32,7 +34,7 @@ To view the runner fleet dashboard: 1. Click **Fleet dashboard**. Most of the dashboard works without any additional actions, with the -exception of **Wait time to pick a job** chart and [proposed features](#whats-next). +exception of **Wait time to pick a job** chart and features proposed in [epic 11183](https://gitlab.com/groups/gitlab-org/-/epics/11183). These features require [setting up an additional infrastructure](#enable-more-ci-analytics-features-with-clickhouse). ## Enable more CI analytics features with ClickHouse **(ULTIMATE EXPERIMENT)** @@ -41,7 +43,7 @@ These features require [setting up an additional infrastructure](#enable-more-ci This feature is an [Experiment](../../policy/experiment-beta-support.md). To test it, we have launched an early adopters program. -To join the list of users testing this feature, contact us in +To join the list of users testing this feature, see [epic 11180](https://gitlab.com/groups/gitlab-org/-/epics/11180). ### Enable ClickHouse integration and features @@ -53,17 +55,12 @@ To enable additional CI analytics features: | Feature flag name | Purpose | |------------------------------------|---------------------------------------------------------------------------| - | `ci_data_ingestion_to_click_house` | Enables synchronization of new finished CI builds to Clickhouse database. | + | `ci_data_ingestion_to_click_house` | Enables synchronization of new finished CI builds to ClickHouse database. | | `clickhouse_ci_analytics` | Enables the **Wait time to pick a job** chart. | <i class="fa fa-youtube-play youtube" aria-hidden="true"></i> For a video walkthrough, see [Setting up Runner Fleet Dashboard with ClickHouse](https://www.youtube.com/watch?v=YpGV95Ctbpk). -### What's next - -Support for usage and cost analysis are proposed in -[epic 11183](https://gitlab.com/groups/gitlab-org/-/epics/11183). - ## Feedback To help us improve the Runner Fleet Dashboard, you can provide feedback in diff --git a/doc/development/code_review.md b/doc/development/code_review.md index 84d2537d058..cad71d4b843 100644 --- a/doc/development/code_review.md +++ b/doc/development/code_review.md @@ -376,7 +376,7 @@ Avoid: [_explain why, not what_](https://blog.codinghorror.com/code-tells-you-how-comments-tell-you-why/). - Requesting maintainer reviews of merge requests with failed tests. If the tests are failing and you have to request a review, ensure you leave a comment with an explanation. - Excessively mentioning maintainers through email or Slack (if the maintainer is reachable -through Slack). If you can't add a reviewer for a merge request, `@` mentioning a maintainer in a comment is acceptable and in all other cases adding a reviewer is sufficient. + through Slack). If you can't add a reviewer for a merge request, `@` mentioning a maintainer in a comment is acceptable and in all other cases adding a reviewer is sufficient. This saves reviewers time and helps authors catch mistakes earlier. @@ -412,7 +412,7 @@ that it meets all requirements, you should: - Select **Approve**. - `@` mention the author to generate a to-do notification, and advise them that their merge request has been reviewed and approved. - Request a review from a maintainer. Default to requests for a maintainer with [domain expertise](#domain-experts), -however, if one isn't available or you think the merge request doesn't need a review by a [domain expert](#domain-experts), feel free to follow the [Reviewer roulette](#reviewer-roulette) suggestion. + however, if one isn't available or you think the merge request doesn't need a review by a [domain expert](#domain-experts), feel free to follow the [Reviewer roulette](#reviewer-roulette) suggestion. - Remove yourself as a reviewer. ### The responsibility of the maintainer @@ -580,7 +580,7 @@ experience, refactors the existing code). Then: optionally resolve within the merge request or follow-up at a later stage. - There's a [Chrome/Firefox add-on](https://gitlab.com/conventionalcomments/conventional-comments-button) which you can use to apply [Conventional Comment](https://conventionalcomments.org/) prefixes. - Ensure there are no open dependencies. Check [linked issues](../user/project/issues/related_issues.md) for blockers. Clarify with the authors -if necessary. If blocked by one or more open MRs, set an [MR dependency](../user/project/merge_requests/dependencies.md). + if necessary. If blocked by one or more open MRs, set an [MR dependency](../user/project/merge_requests/dependencies.md). - After a round of line notes, it can be helpful to post a summary note such as "Looks good to me", or "Just a couple things to address." - Let the author know if changes are required following your review. diff --git a/doc/development/contributing/design.md b/doc/development/contributing/design.md index a0888006937..c6027e27310 100644 --- a/doc/development/contributing/design.md +++ b/doc/development/contributing/design.md @@ -19,12 +19,12 @@ with additions and improvements. As a merge request (MR) author, you must: - Include _Before_ and _After_ -screenshots (or videos) of your changes in the description, as explained in our -[MR workflow](merge_request_workflow.md). These screenshots/videos are very helpful -for all reviewers and can speed up the review process, especially if the changes -are small. + screenshots (or videos) of your changes in the description, as explained in our + [MR workflow](merge_request_workflow.md). These screenshots/videos are very helpful + for all reviewers and can speed up the review process, especially if the changes + are small. - Attach the ~UX label to any merge request that has any user facing changes. This will trigger our -Reviewer Roulette to suggest a UX [reviewer](https://about.gitlab.com/handbook/product/ux/product-designer/mr-reviews/#stage-group-mrs). + Reviewer Roulette to suggest a UX [reviewer](https://about.gitlab.com/handbook/product/ux/product-designer/mr-reviews/#stage-group-mrs). If you are a **team member**: We recommend assigning the Product Designer suggested by the [Reviewer Roulette](../code_review.md#reviewer-roulette) as reviewer. [This helps us](https://about.gitlab.com/handbook/product/ux/product-designer/mr-reviews/#benefits) spread work evenly, improve communication, and make our UI more diff --git a/doc/development/documentation/site_architecture/global_nav.md b/doc/development/documentation/site_architecture/global_nav.md index f5edbec88e1..be10688766f 100644 --- a/doc/development/documentation/site_architecture/global_nav.md +++ b/doc/development/documentation/site_architecture/global_nav.md @@ -52,7 +52,7 @@ the consent of one of the technical writers. To add a topic to the global navigation: 1. In the [`navigation.yaml`](https://gitlab.com/gitlab-org/gitlab-docs/blob/main/content/_data/navigation.yaml) -file, add the item. + file, add the item. 1. Assign the MR to a technical writer for review and merge. ### Where to add diff --git a/doc/development/documentation/styleguide/index.md b/doc/development/documentation/styleguide/index.md index 03a4b3eec94..c7783157575 100644 --- a/doc/development/documentation/styleguide/index.md +++ b/doc/development/documentation/styleguide/index.md @@ -1140,7 +1140,7 @@ When you take screenshots: Reduce the size of your browser window as much as possible to keep elements close together and reduce empty space. Try to keep the screenshot dimensions as small as possible. - **Review how the image renders on the page.** Preview the image locally or use the -review app in the merge request. Make sure the image isn't blurry or overwhelming. + review app in the merge request. Make sure the image isn't blurry or overwhelming. - **Be consistent.** Coordinate screenshots with the other screenshots already on a documentation page for a consistent reading experience. Ensure your navigation theme is **Indigo** and the syntax highlighting theme is **Light**. These are the default preferences. diff --git a/doc/development/documentation/styleguide/word_list.md b/doc/development/documentation/styleguide/word_list.md index dfc18cf4139..fed295b8ec9 100644 --- a/doc/development/documentation/styleguide/word_list.md +++ b/doc/development/documentation/styleguide/word_list.md @@ -1595,7 +1595,7 @@ Searching is different from [filtering](#filter). When referring to the subscription billing model: - For GitLab SaaS, use **seats**. Customers purchase seats. Users occupy seats when they are invited -to a group, with some [exceptions](../../../subscriptions/gitlab_com/index.md#how-seat-usage-is-determined). + to a group, with some [exceptions](../../../subscriptions/gitlab_com/index.md#how-seat-usage-is-determined). - For GitLab self-managed, use **users**. Customers purchase subscriptions for a specified number of **users**. ## section diff --git a/doc/development/documentation/topic_types/troubleshooting.md b/doc/development/documentation/topic_types/troubleshooting.md index aee5bd1377c..f970b58e4fc 100644 --- a/doc/development/documentation/topic_types/troubleshooting.md +++ b/doc/development/documentation/topic_types/troubleshooting.md @@ -64,7 +64,7 @@ The workaround is... If multiple causes or solutions exist, consider putting them into a table format. If you use the exact error message, surround it in backticks so it's styled as code. -For more guidance on solution types, see [workaround](../../documentation/styleguide/word_list.md#workaround) and [resolution, resolve](../../documentation/styleguide/word_list.md#resolution-resolve). +For more guidance on solution types, see [workaround](../../documentation/styleguide/word_list.md#workaround) and [resolution, resolve](../../documentation/styleguide/word_list.md#resolution-resolve). ## Troubleshooting topic titles diff --git a/doc/development/ee_features.md b/doc/development/ee_features.md index 08045675295..78177612aa9 100644 --- a/doc/development/ee_features.md +++ b/doc/development/ee_features.md @@ -200,7 +200,7 @@ To guard your licensed feature: ``` 1. Optional. If your global feature is also available to namespaces with a paid plan, combine two -feature identifiers to allow both administrators and group users. For example: + feature identifiers to allow both administrators and group users. For example: ```ruby License.feature_available?(:my_feature_name) || group.licensed_feature_available?(:my_feature_name_for_namespace) # Both admins and group members can see this EE feature diff --git a/doc/development/go_guide/index.md b/doc/development/go_guide/index.md index a9f4b22c778..c6471d9720c 100644 --- a/doc/development/go_guide/index.md +++ b/doc/development/go_guide/index.md @@ -26,7 +26,7 @@ can still have specifics. They are described in their respective The Go upgrade documentation [provides an overview](go_upgrade.md#overview) of how GitLab manages and ships Go binary support. -If a GitLab component requires a newer version of Go, +If a GitLab component requires a newer version of Go, follow the [upgrade process](go_upgrade.md#updating-go-version) to ensure no customer, team, or component is adversely impacted. Sometimes, individual projects must also [manage builds with multiple versions of Go](go_upgrade.md#supporting-multiple-go-versions). diff --git a/doc/development/i18n/translation.md b/doc/development/i18n/translation.md index 7149d431c30..ed3afb8efa6 100644 --- a/doc/development/i18n/translation.md +++ b/doc/development/i18n/translation.md @@ -96,7 +96,7 @@ For example, in German, the word _user_ can be translated into _Benutzer_ (male) ### Updating the glossary -To propose additions to the glossary, +To propose additions to the glossary, [open an issue](https://gitlab.com/gitlab-org/gitlab/-/issues?scope=all&utf8=✓&state=all&label_name[]=Category%3AInternationalization). ## French translation guidelines diff --git a/doc/development/migration_style_guide.md b/doc/development/migration_style_guide.md index 30f598ef736..be76680c44c 100644 --- a/doc/development/migration_style_guide.md +++ b/doc/development/migration_style_guide.md @@ -723,7 +723,7 @@ The `with_lock_retries` method **cannot** be used within the `change` method, yo 1. For each iteration, set a pre-configured `lock_timeout`. 1. Try to execute the given block. (`remove_column`). 1. If `LockWaitTimeout` error is raised, sleep for the pre-configured `sleep_time` -and retry the block. + and retry the block. 1. If no error is raised, the current iteration has successfully executed the block. For more information check the [`Gitlab::Database::WithLockRetries`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/database/with_lock_retries.rb) class. The `with_lock_retries` helper method is implemented in the [`Gitlab::Database::MigrationHelpers`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/database/migration_helpers.rb) module. @@ -733,7 +733,7 @@ In a worst-case scenario, the method: - Executes the block for a maximum of 50 times over 40 minutes. - Most of the time is spent in a pre-configured sleep period after each iteration. - After the 50th retry, the block is executed without `lock_timeout`, just -like a standard migration invocation. + like a standard migration invocation. - If a lock cannot be acquired, the migration fails with `statement timeout` error. The migration might fail if there is a very long running transaction (40+ minutes) diff --git a/doc/development/sec/analyzer_development_guide.md b/doc/development/sec/analyzer_development_guide.md index eb59d8fcaf5..843f41300a2 100644 --- a/doc/development/sec/analyzer_development_guide.md +++ b/doc/development/sec/analyzer_development_guide.md @@ -128,7 +128,7 @@ To use Docker with `replace` in the `go.mod` file: 1. Copy the contents of `command` into the directory of the analyzer. `cp -r /path/to/command path/to/analyzer/command`. 1. Add a copy statement in the analyzer's `Dockerfile`: `COPY command /command`. 1. Update the `replace` statement to make sure it matches the destination of the `COPY` statement in the step above: -`replace gitlab.com/gitlab-org/security-products/analyzers/command/v3 => /command` + `replace gitlab.com/gitlab-org/security-products/analyzers/command/v3 => /command` ## Analyzer scripts @@ -189,11 +189,11 @@ are integrated with the existing application, iteration should not be blocked by 1. Ensure that the release source (typically the `master` or `main` branch) has a passing pipeline. 1. Create a new release for the analyzer project by selecting the **Deployments** menu on the left-hand side of the project window, then selecting the **Releases** sub-menu. 1. Select **New release** to open the **New Release** page. - 1. In the **Tag name** drop down, enter the same version used in the `CHANGELOG.md`, for example `v2.4.2`, and select the option to create the tag (`Create tag v2.4.2` here). - 1. In the **Release title** text box enter the same version used above, for example `v2.4.2`. - 1. In the `Release notes` text box, copy and paste the notes from the corresponding version in the `CHANGELOG.md`. - 1. Leave all other settings as the default values. - 1. Select **Create release**. + 1. In the **Tag name** drop down, enter the same version used in the `CHANGELOG.md`, for example `v2.4.2`, and select the option to create the tag (`Create tag v2.4.2` here). + 1. In the **Release title** text box enter the same version used above, for example `v2.4.2`. + 1. In the `Release notes` text box, copy and paste the notes from the corresponding version in the `CHANGELOG.md`. + 1. Leave all other settings as the default values. + 1. Select **Create release**. After following the above process and creating a new release, a new Git tag is created with the `Tag name` provided above. This triggers a new pipeline with the given tag version and a new analyzer Docker image is built. @@ -229,7 +229,7 @@ After the above steps have been completed, the automatic release process execute 1. After a new version of the analyzer Docker image has been tagged and deployed, test it with the corresponding test project. 1. Announce the release on the relevant group Slack channel. Example message: - > FYI I've just released `ANALYZER_NAME` `ANALYZER_VERSION`. `LINK_TO_RELEASE` + > FYI I've just released `ANALYZER_NAME` `ANALYZER_VERSION`. `LINK_TO_RELEASE` **Never delete a Git tag that has been pushed** as there is a good chance that the tag will be used and/or cached by the Go package registry. diff --git a/doc/development/secure_coding_guidelines.md b/doc/development/secure_coding_guidelines.md index a575d1ff890..d8fad6deb9c 100644 --- a/doc/development/secure_coding_guidelines.md +++ b/doc/development/secure_coding_guidelines.md @@ -182,7 +182,7 @@ For other regular expressions, here are a few guidelines: - If there's a clean non-regex solution, such as `String#start_with?`, consider using it - Ruby supports some advanced regex features like [atomic groups](https://www.regular-expressions.info/atomic.html) -and [possessive quantifiers](https://www.regular-expressions.info/possessive.html) that eliminate backtracking + and [possessive quantifiers](https://www.regular-expressions.info/possessive.html) that eliminate backtracking - Avoid nested quantifiers if possible (for example `(a+)+`) - Try to be as precise as possible in your regex and avoid the `.` if there's an alternative - For example, Use `_[^_]+_` instead of `_.*_` to match `_text here_` diff --git a/doc/development/testing_guide/end_to_end/feature_flags.md b/doc/development/testing_guide/end_to_end/feature_flags.md index e11119d2c0b..189b21ea607 100644 --- a/doc/development/testing_guide/end_to_end/feature_flags.md +++ b/doc/development/testing_guide/end_to_end/feature_flags.md @@ -24,14 +24,14 @@ Be sure to include the `feature_flag` tag so that the test can be skipped on the - Format: `feature_flag: { name: 'feature_flag_name' }` - Used only for informational purposes at this time. It should be included to help quickly determine what -feature flag is under test. + feature flag is under test. `scope` - Format: `feature_flag: { name: 'feature_flag_name', scope: :project }` - When `scope` is set to `:global`, the test will be **skipped on all live .com environments**. This is to avoid issues with feature flag changes affecting other tests or users on that environment. - When `scope` is set to any other value (such as `:project`, `:group` or `:user`), or if no `scope` is specified, the test will only be **skipped on canary, production, and pre-production**. -This is due to the fact that administrator access is not available there. + This is due to the fact that administrator access is not available there. **WARNING:** You are strongly advised to first try and [enable feature flags only for a group, project, user](../../feature_flags/index.md#feature-actors), or [feature group](../../feature_flags/index.md#feature-groups). diff --git a/doc/development/testing_guide/flaky_tests.md b/doc/development/testing_guide/flaky_tests.md index 1895b9bdb39..4d6fac57c06 100644 --- a/doc/development/testing_guide/flaky_tests.md +++ b/doc/development/testing_guide/flaky_tests.md @@ -119,7 +119,7 @@ Adding a delay in API or controller could help reproducing the issue. - [Example 2](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/101728/diffs): A CSS selector only appears after a GraphQL requests has finished, and the UI has updated. - [Example 3](https://gitlab.com/gitlab-org/gitlab/-/issues/408215): A false-positive test, Capybara immediately returns true after -page visit and page is not fully loaded, or if the element is not detectable by webdriver (such as being rendered outside the viewport or behind other elements). + page visit and page is not fully loaded, or if the element is not detectable by webdriver (such as being rendered outside the viewport or behind other elements). ### Datetime-sensitive diff --git a/doc/install/cloud_providers.md b/doc/install/cloud_providers.md index 318895b6d89..407c2152569 100644 --- a/doc/install/cloud_providers.md +++ b/doc/install/cloud_providers.md @@ -1,8 +1,8 @@ --- stage: Systems group: Distribution +description: AWS, Google Cloud Platform, Azure. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments -description: Install GitLab on a cloud provider. --- # Installing GitLab on a cloud provider **(FREE SELF)** diff --git a/doc/install/install_methods.md b/doc/install/install_methods.md index b40d89e957a..99be2709564 100644 --- a/doc/install/install_methods.md +++ b/doc/install/install_methods.md @@ -1,8 +1,8 @@ --- stage: Systems group: Distribution +description: Linux, Helm, Docker, Operator, source, or scripts. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments -description: Read through the GitLab installation methods. --- # Installation methods **(FREE SELF)** diff --git a/doc/install/requirements.md b/doc/install/requirements.md index fa6be957d99..e3905dd4882 100644 --- a/doc/install/requirements.md +++ b/doc/install/requirements.md @@ -1,6 +1,7 @@ --- stage: Systems group: Distribution +description: Prerequisites for installation. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- diff --git a/doc/security/index.md b/doc/security/index.md index 01f227efbf9..ffc436e4286 100644 --- a/doc/security/index.md +++ b/doc/security/index.md @@ -1,6 +1,7 @@ --- stage: Govern group: Authentication +description: SSH key limits, 2FA, tokens, hardening. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- diff --git a/doc/subscriptions/gitlab_com/index.md b/doc/subscriptions/gitlab_com/index.md index 76b6c59c9fe..74ecf1701a4 100644 --- a/doc/subscriptions/gitlab_com/index.md +++ b/doc/subscriptions/gitlab_com/index.md @@ -232,13 +232,13 @@ After you dismiss the alert, it doesn't display until another seat is used. The alert displays based on the following seat usage. You cannot configure the amounts at which the alert displays. -| Seats in subscription | Seat usage | -|-----------------------|------------------------------------------------------------------------| -| 0-15 | One seat remaining in the subscription. | -| 16-25 | Two seats remaining in the subscription. | -| 26-99 | 10% of seats have been used. | -| 100-999 | 8% of seats have been used. | -| 1000+ | 5% of seats have been used | +| Seats in subscription | Seat usage | +|-----------------------|------------| +| 0-15 | One seat remaining in the subscription. | +| 16-25 | Two seats remaining in the subscription. | +| 26-99 | 10% of seats have been used. | +| 100-999 | 8% of seats have been used. | +| 1000+ | 5% of seats have been used | ## Change the linked namespace @@ -324,8 +324,8 @@ You can only renew your subscription 15 days before it is due to expire. To renew your subscription: 1. Sign in to the [Customers Portal](https://customers.gitlab.com/customers/sign_in) and beneath your existing subscription, select **Renew**. -The **Renew** button displays only 15 days before a subscription expires. If there are more than 15 days before -the subscription expires, select **Subscription actions** (**{ellipsis_v}**), then select **Renew subscription** to view the date when you can renew. + The **Renew** button displays only 15 days before a subscription expires. If there are more than 15 days before + the subscription expires, select **Subscription actions** (**{ellipsis_v}**), then select **Renew subscription** to view the date when you can renew. 1. Review your renewal details and complete the payment process. 1. Select **Confirm purchase**. diff --git a/doc/topics/offline/index.md b/doc/topics/offline/index.md index b29a06463ba..b463abc79d3 100644 --- a/doc/topics/offline/index.md +++ b/doc/topics/offline/index.md @@ -1,6 +1,7 @@ --- stage: Systems group: Distribution +description: Isolated installation. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- diff --git a/doc/update/versions/gitlab_16_changes.md b/doc/update/versions/gitlab_16_changes.md index 3bf01e9143e..8efa056e70d 100644 --- a/doc/update/versions/gitlab_16_changes.md +++ b/doc/update/versions/gitlab_16_changes.md @@ -81,7 +81,7 @@ Specific information applies to Linux package installations: - PostgreSQL version 14 is the default for fresh installations of GitLab 16.7 and later. However, due to an [issue](https://gitlab.com/gitlab-org/omnibus-gitlab/-/issues/7768#note_1652076255), existing Geo secondary sites cannot be upgraded to PostgreSQL version 14. All Geo sites must run the same version of PostgreSQL. If you are adding a new Geo secondary site based on GitLab 16.7 you must take one of the following actions based on your configuration: - You are adding your first Geo secondary site: [Upgrade the Primary site to PostgreSQL 14](https://docs.gitlab.com/omnibus/settings/database.html#upgrade-packaged-postgresql-server) before setting up the new Geo secondary site. No special action is required if your primary site is already running PostgreSQL 14. - - You are adding a new Geo secondary site to a deployment that already has one or more Geo secondaries: + - You are adding a new Geo secondary site to a deployment that already has one or more Geo secondaries: - All sites are running PostgreSQL 13: Install the new Geo secondary site with [pinned PostgreSQL version 13](https://docs.gitlab.com/omnibus/settings/database.html#pin-the-packaged-postgresql-version-fresh-installs-only). - All sites are running PostgreSQL 14: No special action is required. diff --git a/doc/user/application_security/container_scanning/index.md b/doc/user/application_security/container_scanning/index.md index a3f12d157f9..d8eab5f9da8 100644 --- a/doc/user/application_security/container_scanning/index.md +++ b/doc/user/application_security/container_scanning/index.md @@ -128,10 +128,6 @@ Setting `CS_DEFAULT_BRANCH_IMAGE` avoids duplicate vulnerability findings when a The value of `CS_DEFAULT_BRANCH_IMAGE` indicates the name of the scanned image as it appears on the default branch. For more details on how this deduplication is achieved, see [Setting the default branch image](#setting-the-default-branch-image). -## Running jobs in merge request pipelines - -See [Use security scanning tools with merge request pipelines](../index.md#use-security-scanning-tools-with-merge-request-pipelines) - ### Customizing the container scanning settings There may be cases where you want to customize how GitLab scans your containers. For example, you @@ -243,6 +239,10 @@ if [Dependency Scanning](../dependency_scanning/index.md) is enabled for your project. This happens because GitLab can't automatically deduplicate findings across different types of scanning tools. To understand which types of dependencies are likely to be duplicated, see [Dependency Scanning compared to Container Scanning](../comparison_dependency_and_container_scanning.md). +#### Running jobs in merge request pipelines + +See [Use security scanning tools with merge request pipelines](../index.md#use-security-scanning-tools-with-merge-request-pipelines). + #### Available CI/CD variables You can [configure](#customizing-the-container-scanning-settings) analyzers by using the following CI/CD variables. diff --git a/doc/user/application_security/dependency_scanning/troubleshooting_dependency_scanning.md b/doc/user/application_security/dependency_scanning/troubleshooting_dependency_scanning.md index dae72e1a555..83004459051 100644 --- a/doc/user/application_security/dependency_scanning/troubleshooting_dependency_scanning.md +++ b/doc/user/application_security/dependency_scanning/troubleshooting_dependency_scanning.md @@ -125,7 +125,7 @@ The lock file is cached during the build phase and passed to the dependency scan scan occurs. Because the cache is downloaded before the analyzer run occurs, the existence of a lock file in the `CI_BUILDS_DIR` directory triggers the dependency scanning job. -To prevent this warning, lock files should be committed. +To prevent this warning, lock files should be committed. ## You no longer get the latest Docker image after setting `DS_MAJOR_VERSION` or `DS_ANALYZER_IMAGE` diff --git a/doc/user/application_security/sast/index.md b/doc/user/application_security/sast/index.md index f309b0f11fb..b626bdef929 100644 --- a/doc/user/application_security/sast/index.md +++ b/doc/user/application_security/sast/index.md @@ -318,10 +318,6 @@ When downloading, you always receive the most recent SAST artifact available. You can enable and configure SAST by using the UI, either with the default settings or with customizations. The method you can use depends on your GitLab license tier. -### Running jobs in merge request pipelines - -See [Use security scanning tools with merge request pipelines](../index.md#use-security-scanning-tools-with-merge-request-pipelines) - #### Configure SAST with customizations **(ULTIMATE ALL)** > [Removed](https://gitlab.com/gitlab-org/gitlab/-/issues/410013) individual SAST analyzers configuration options from the UI in GitLab 16.2. @@ -520,6 +516,10 @@ spotbugs-sast: sast: gl-sast-report.json ``` +### Running jobs in merge request pipelines + +See [Use security scanning tools with merge request pipelines](../index.md#use-security-scanning-tools-with-merge-request-pipelines). + ### Available CI/CD variables SAST can be configured using the [`variables`](../../../ci/yaml/index.md#variables) parameter in diff --git a/doc/user/application_security/secret_detection/index.md b/doc/user/application_security/secret_detection/index.md index 0eb79bfbe5a..9e2d67237d3 100644 --- a/doc/user/application_security/secret_detection/index.md +++ b/doc/user/application_security/secret_detection/index.md @@ -110,10 +110,6 @@ Secret Detection can detect if a secret was added in one commit and removed in a [merge request pipelines](../../../ci/pipelines/merge_request_pipelines.md). Secret Detection's results are only available after the pipeline is completed. -## Running jobs in merge request pipelines - -See [Use security scanning tools with merge request pipelines](../index.md#use-security-scanning-tools-with-merge-request-pipelines) - ## Enable Secret Detection Prerequisites: @@ -265,6 +261,10 @@ For example: "A personal token for GitLab will look like glpat-JUST20LETTERSANDNUMB" #gitleaks:allow ``` +### Running jobs in merge request pipelines + +See [Use security scanning tools with merge request pipelines](../index.md#use-security-scanning-tools-with-merge-request-pipelines). + ### Available CI/CD variables Secret Detection can be customized by defining available CI/CD variables: diff --git a/doc/user/feature_flags.md b/doc/user/feature_flags.md index 83e2926e8e3..ccce9e9f9b4 100644 --- a/doc/user/feature_flags.md +++ b/doc/user/feature_flags.md @@ -1,8 +1,8 @@ --- stage: none group: unassigned -info: "See the Technical Writers assigned to Development Guidelines: https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-development-guidelines" -description: "View a list of all the flags available in the GitLab application." +description: Complete list of flags. +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments layout: 'feature_flags' --- diff --git a/doc/user/organization/index.md b/doc/user/organization/index.md index c4fff4178f1..ecc62b0d510 100644 --- a/doc/user/organization/index.md +++ b/doc/user/organization/index.md @@ -44,6 +44,8 @@ To view the organizations you have access to: 1. On the left sidebar, at the top, select **Create new** (**{plus}**) and **New organization**. 1. In the **Organization name** text box, enter a name for the organization. 1. In the **Organization URL** text box, enter a path for the organization. +1. In the **Organization description** text box, enter a description for the organization. Supports a [limited subset of Markdown](#supported-markdown-for-organization-description). +1. In the **Organization avatar** field, select **Upload** or drag and drop an avatar. 1. Select **Create organization**. ## Edit an organization's name @@ -51,6 +53,10 @@ To view the organizations you have access to: 1. On the left sidebar, select **Organizations** (**{organization}**) and find the organization you want to edit. 1. Select **Settings > General**. 1. In the **Organization name** text box, edit the name. +1. In the **Organization description** text box, edit the description. Supports a [limited subset of Markdown](#supported-markdown-for-organization-description). +1. In the **Organization avatar** field, if an avatar is: + - Selected, select **Remove avatar** to remove. + - Not selected, select **Upload** or drag and drop an avatar. 1. Select **Save changes**. ## Change an organization's URL @@ -72,6 +78,14 @@ To view the organizations you have access to: 1. On the left sidebar, select **Organizations** (**{organization}**) and find the organization you want to manage. 1. Select **Manage > Users**. +## Supported Markdown for Organization description + +The Organization description field supports a limited subset of [GitLab Flavored Markdown](../markdown.md), including: + +- [Emphasis](../markdown.md#emphasis) +- [Links](../markdown.md#links) +- [Superscripts / Subscripts](../markdown.md#superscripts--subscripts) + ## Related topics - [Organization developer documentation](../../development/organization/index.md) diff --git a/doc/user/profile/account/create_accounts.md b/doc/user/profile/account/create_accounts.md index 6c78152fa70..4611b3a6a40 100644 --- a/doc/user/profile/account/create_accounts.md +++ b/doc/user/profile/account/create_accounts.md @@ -1,6 +1,7 @@ --- stage: Govern group: Authentication +description: Passwords, user moderation, broadcast messages. info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- diff --git a/doc/user/project/repository/code_suggestions/self_managed.md b/doc/user/project/repository/code_suggestions/self_managed.md index 5688985ab49..8cd499c13d0 100644 --- a/doc/user/project/repository/code_suggestions/self_managed.md +++ b/doc/user/project/repository/code_suggestions/self_managed.md @@ -139,7 +139,7 @@ In GitLab 16.3 and later, GitLab is enforcing the cloud licensing requirement fo If you have a GitLab Free subscription and upgrade to GitLab 16.3 or later, to continue having early access to Code Suggestions, you must: -1. Have a [subscription that supports cloud licensing](https://about.gitlab.com/pricing/). +1. Have a [subscription that supports cloud licensing](https://about.gitlab.com/pricing/licensing-faq/cloud-licensing/). 1. Make sure you have the latest version of your [IDE extension](index.md#supported-editor-extensions). 1. [Manually synchronize your subscription](#manually-synchronize-your-subscription). |