diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-05-20 03:08:04 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-05-20 03:08:04 +0000 |
commit | 25f414893f8f1dde029f60e781d195e426e514a1 (patch) | |
tree | 48d9a313a60d4bc78093829f5ce91e438afab183 | |
parent | 59accb4c4780f194554b86c7be3c4a916fb70737 (diff) | |
download | gitlab-ce-25f414893f8f1dde029f60e781d195e426e514a1.tar.gz |
Add latest changes from gitlab-org/gitlab@master
73 files changed, 201 insertions, 173 deletions
diff --git a/doc/.vale/gitlab/Substitutions.yml b/doc/.vale/gitlab/Substitutions.yml index e3bf125f912..b9c0dbecf31 100644 --- a/doc/.vale/gitlab/Substitutions.yml +++ b/doc/.vale/gitlab/Substitutions.yml @@ -20,5 +20,6 @@ swap: rspec: RSpec self hosted: self-managed self-hosted: self-managed + styleguide: style guide x509: X.509 yaml: YAML diff --git a/doc/administration/auth/smartcard.md b/doc/administration/auth/smartcard.md index 8986a9866e7..7131fd7571f 100644 --- a/doc/administration/auth/smartcard.md +++ b/doc/administration/auth/smartcard.md @@ -37,7 +37,7 @@ To use a smartcard with an X.509 certificate to authenticate against a local database with GitLab, `CN` and `emailAddress` must be defined in the certificate. For example: -```text +```plaintext Certificate: Data: Version: 1 (0x0) @@ -73,7 +73,7 @@ database with GitLab, in: For example: -```text +```plaintext Certificate: Data: Version: 1 (0x0) diff --git a/doc/administration/gitaly/reference.md b/doc/administration/gitaly/reference.md index 051128c7aff..e718d8953ca 100644 --- a/doc/administration/gitaly/reference.md +++ b/doc/administration/gitaly/reference.md @@ -149,7 +149,7 @@ before and after. If the hit ratio does not improve, the higher limit is probably not making a meaningful difference. Here is an example Prometheus query to see the hit rate: -```text +```plaintext sum(rate(gitaly_catfile_cache_total{type="hit"}[5m])) / sum(rate(gitaly_catfile_cache_total{type=~"(hit)|(miss)"}[5m])) ``` diff --git a/doc/administration/high_availability/nfs_host_client_setup.md b/doc/administration/high_availability/nfs_host_client_setup.md index 6823c1d9abe..7519ebf028d 100644 --- a/doc/administration/high_availability/nfs_host_client_setup.md +++ b/doc/administration/high_availability/nfs_host_client_setup.md @@ -36,7 +36,7 @@ apt-get install nfs-kernel-server In this setup we will share the home directory on the host with the client. Edit the exports file as below to share the host's home directory with the client. If you have multiple clients running GitLab you must enter the client IP addresses in line in the `/etc/exports` file. -```text +```plaintext #/etc/exports for one client /home <client-ip-address>(rw,sync,no_root_squash,no_subtree_check) @@ -96,7 +96,7 @@ NFS version 4. NFSv3 also supports locking as long as Linux Kernel 2.6.5+ is use We recommend using version 4 and do not specifically test NFSv3. See [NFS documentation](nfs.md#nfs-client-mount-options) for guidance on mount options. -```text +```plaintext #/etc/fstab 10.0.0.1:/nfs/home /nfs/home nfs4 defaults,hard,vers=4.1,rsize=1048576,wsize=1048576,noatime,nofail,lookupcache=positive 0 2 ``` @@ -111,7 +111,7 @@ default file locations in `gitlab.rb` on the client allows you to have one main point and have all the required locations as subdirectories to use the NFS mount for `git-data`. -```text +```plaintext git_data_dirs({"default" => {"path" => "/nfs/home/var/opt/gitlab-data/git-data"}}) gitlab_rails['uploads_directory'] = '/nfs/home/var/opt/gitlab-data/uploads' gitlab_rails['shared_path'] = '/nfs/home/var/opt/gitlab-data/shared' diff --git a/doc/administration/integration/plantuml.md b/doc/administration/integration/plantuml.md index 682e47adc21..3372d05bd6b 100644 --- a/doc/administration/integration/plantuml.md +++ b/doc/administration/integration/plantuml.md @@ -70,7 +70,7 @@ sudo service tomcat8 restart Once the Tomcat service restarts the PlantUML service will be ready and listening for requests on port 8080: -```text +```plaintext http://localhost:8080/plantuml ``` @@ -144,7 +144,7 @@ our AsciiDoc snippets, wikis, and repositories using delimited blocks: - **AsciiDoc** - ```text + ```plaintext [plantuml, format="png", id="myDiagram", width="200px"] ---- Bob->Alice : hello @@ -154,7 +154,7 @@ our AsciiDoc snippets, wikis, and repositories using delimited blocks: - **reStructuredText** - ```text + ```plaintext .. plantuml:: :caption: Caption with **bold** and *italic* diff --git a/doc/administration/libravatar.md b/doc/administration/libravatar.md index c28e701dc25..e1c38b3409f 100644 --- a/doc/administration/libravatar.md +++ b/doc/administration/libravatar.md @@ -19,7 +19,7 @@ the configuration options as follows: ### For HTTP -```yml +```yaml gravatar: enabled: true # gravatar URLs: possible placeholders: %{hash} %{size} %{email} %{username} @@ -28,7 +28,7 @@ the configuration options as follows: ### For HTTPS -```yml +```yaml gravatar: enabled: true # gravatar URLs: possible placeholders: %{hash} %{size} %{email} %{username} diff --git a/doc/administration/monitoring/gitlab_self_monitoring_project/index.md b/doc/administration/monitoring/gitlab_self_monitoring_project/index.md index 35c41dbd7ef..091da46f316 100644 --- a/doc/administration/monitoring/gitlab_self_monitoring_project/index.md +++ b/doc/administration/monitoring/gitlab_self_monitoring_project/index.md @@ -74,7 +74,7 @@ project creation to fail with the following error (which appears in the log file when the first admin user is an [external user](../../../user/permissions.md#external-users-core-only): -```text +```plaintext Could not create instance administrators group. Errors: ["You don’t have permission to create groups."] ``` diff --git a/doc/administration/packages/container_registry.md b/doc/administration/packages/container_registry.md index 1e7166da38f..503e5fb4a2a 100644 --- a/doc/administration/packages/container_registry.md +++ b/doc/administration/packages/container_registry.md @@ -460,7 +460,7 @@ However, this behavior is undesirable for registries used by internal hosts that 1. Add the `redirect` flag to your registry configuration YML file: - ```yml + ```yaml storage: s3: accesskey: 'AKIAKIAKI' diff --git a/doc/administration/timezone.md b/doc/administration/timezone.md index 26bac560322..d6112c45141 100644 --- a/doc/administration/timezone.md +++ b/doc/administration/timezone.md @@ -2,7 +2,7 @@ The global time zone configuration parameter can be changed in `config/gitlab.yml`: -```text +```plaintext # time_zone: 'UTC' ``` diff --git a/doc/api/applications.md b/doc/api/applications.md index eb0d130fd3c..5d4a8b3a99f 100644 --- a/doc/api/applications.md +++ b/doc/api/applications.md @@ -16,7 +16,7 @@ Create an application by posting a JSON payload. Returns `200` if the request succeeds. -```text +```plaintext POST /applications ``` @@ -52,7 +52,7 @@ Example response: List all registered applications. -```text +```plaintext GET /applications ``` @@ -85,7 +85,7 @@ Delete a specific application. Returns `204` if the request succeeds. -```text +```plaintext DELETE /applications/:id ``` diff --git a/doc/api/avatar.md b/doc/api/avatar.md index 55d5f1e613a..308c0de25f4 100644 --- a/doc/api/avatar.md +++ b/doc/api/avatar.md @@ -15,7 +15,7 @@ If: NOTE: **Note:** This endpoint can be accessed without authentication. -```text +```plaintext GET /avatar?email=admin@example.com ``` diff --git a/doc/api/award_emoji.md b/doc/api/award_emoji.md index 7fb96f4f1c0..37b3cd32f89 100644 --- a/doc/api/award_emoji.md +++ b/doc/api/award_emoji.md @@ -20,7 +20,7 @@ See [Award Emoji on Comments](#award-emoji-on-comments) for information on using Get a list of all award emoji for a specified awardable. -```text +```plaintext GET /projects/:id/issues/:issue_iid/award_emoji GET /projects/:id/merge_requests/:merge_request_iid/award_emoji GET /projects/:id/snippets/:snippet_id/award_emoji @@ -82,7 +82,7 @@ Example response: Get a single award emoji from an issue, snippet, or merge request. -```text +```plaintext GET /projects/:id/issues/:issue_iid/award_emoji/:award_id GET /projects/:id/merge_requests/:merge_request_iid/award_emoji/:award_id GET /projects/:id/snippets/:snippet_id/award_emoji/:award_id @@ -127,7 +127,7 @@ Example response: Create an award emoji on the specified awardable. -```text +```plaintext POST /projects/:id/issues/:issue_iid/award_emoji POST /projects/:id/merge_requests/:merge_request_iid/award_emoji POST /projects/:id/snippets/:snippet_id/award_emoji @@ -173,7 +173,7 @@ Sometimes it's just not meant to be and you'll have to remove the award. NOTE: **Note:** Only available to administrators or the author of the award. -```text +```plaintext DELETE /projects/:id/issues/:issue_iid/award_emoji/:award_id DELETE /projects/:id/merge_requests/:merge_request_iid/award_emoji/:award_id DELETE /projects/:id/snippets/:snippet_id/award_emoji/:award_id @@ -204,7 +204,7 @@ easily adapted for comments on a merge request or on a snippet. Therefore, you h Get all award emoji for a comment (note). -```text +```plaintext GET /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji ``` @@ -249,7 +249,7 @@ Example response: Get a single award emoji for a comment (note). -```text +```plaintext GET /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji/:award_id ``` @@ -293,7 +293,7 @@ Example response: Create an award emoji on the specified comment (note). -```text +```plaintext POST /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji ``` @@ -340,7 +340,7 @@ Sometimes it's just not meant to be and you'll have to remove the award. NOTE: **Note:** Only available to administrators or the author of the award. -```text +```plaintext DELETE /projects/:id/issues/:issue_iid/notes/:note_id/award_emoji/:award_id ``` diff --git a/doc/api/branches.md b/doc/api/branches.md index f9c87222f9a..7d14a3d54b9 100644 --- a/doc/api/branches.md +++ b/doc/api/branches.md @@ -12,7 +12,7 @@ Get a list of repository branches from a project, sorted by name alphabetically. NOTE: **Note:** This endpoint can be accessed without authentication if the repository is publicly accessible. -```text +```plaintext GET /projects/:id/repository/branches ``` @@ -69,7 +69,7 @@ Get a single project repository branch. NOTE: **Note:** This endpoint can be accessed without authentication if the repository is publicly accessible. -```text +```plaintext GET /projects/:id/repository/branches/:branch ``` @@ -130,7 +130,7 @@ for information on unprotecting repository branches. Create a new branch in the repository. -```text +```plaintext POST /projects/:id/repository/branches ``` @@ -185,7 +185,7 @@ Delete a branch from the repository. NOTE: **Note:** In the case of an error, an explanation message is provided. -```text +```plaintext DELETE /projects/:id/repository/branches/:branch ``` @@ -209,7 +209,7 @@ Will delete all branches that are merged into the project's default branch. NOTE: **Note:** [Protected branches](../user/project/protected_branches.md) will not be deleted as part of this operation. -```text +```plaintext DELETE /projects/:id/repository/merged_branches ``` diff --git a/doc/api/broadcast_messages.md b/doc/api/broadcast_messages.md index 1ff40103750..db2198dc162 100644 --- a/doc/api/broadcast_messages.md +++ b/doc/api/broadcast_messages.md @@ -13,7 +13,7 @@ As of GitLab 12.8, GET requests do not require authentication. All other broadca List all broadcast messages. -```text +```plaintext GET /broadcast_messages ``` @@ -46,7 +46,7 @@ Example response: Get a specific broadcast message. -```text +```plaintext GET /broadcast_messages/:id ``` @@ -83,7 +83,7 @@ Example response: Create a new broadcast message. -```text +```plaintext POST /broadcast_messages ``` @@ -127,7 +127,7 @@ Example response: Update an existing broadcast message. -```text +```plaintext PUT /broadcast_messages/:id ``` diff --git a/doc/api/graphql/getting_started.md b/doc/api/graphql/getting_started.md index 07147340ab4..901bf85ff40 100644 --- a/doc/api/graphql/getting_started.md +++ b/doc/api/graphql/getting_started.md @@ -2,7 +2,7 @@ This guide demonstrates basic usage of GitLab's GraphQL API. -See the [GraphQL API StyleGuide](../../development/api_graphql_styleguide.md) for implementation details +See the [GraphQL API style guide](../../development/api_graphql_styleguide.md) for implementation details aimed at developers who wish to work on developing the API itself. ## Running examples diff --git a/doc/api/group_import_export.md b/doc/api/group_import_export.md index a69dd054faf..355ecbfb98f 100644 --- a/doc/api/group_import_export.md +++ b/doc/api/group_import_export.md @@ -41,7 +41,7 @@ curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab Download the finished export. -```text +```plaintext GET /groups/:id/export/download ``` @@ -66,7 +66,7 @@ returns either: ## Import a file -```text +```plaintext POST /groups/import ``` diff --git a/doc/api/keys.md b/doc/api/keys.md index d4eb1161a97..81ebd70be52 100644 --- a/doc/api/keys.md +++ b/doc/api/keys.md @@ -4,7 +4,7 @@ Get SSH key with user by ID of an SSH key. Note only administrators can lookup SSH key with user by ID of an SSH key. -```text +```plaintext GET /keys/:id ``` @@ -63,7 +63,7 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" 'https://gitlab.example.com/a You can search for a user that owns a specific SSH key. Note only administrators can lookup SSH key with the fingerprint of an SSH key. -```text +```plaintext GET /keys ``` diff --git a/doc/api/pages.md b/doc/api/pages.md index 627c1b284f4..db39ab04d9d 100644 --- a/doc/api/pages.md +++ b/doc/api/pages.md @@ -8,7 +8,7 @@ The GitLab Pages feature must be enabled to use these endpoints. Find out more a Remove pages. The user must have admin privileges. -```text +```plaintext DELETE /projects/:id/pages ``` diff --git a/doc/api/pages_domains.md b/doc/api/pages_domains.md index 8a047afc3b0..43bb5a9b774 100644 --- a/doc/api/pages_domains.md +++ b/doc/api/pages_domains.md @@ -8,7 +8,7 @@ The GitLab Pages feature must be enabled to use these endpoints. Find out more a Get a list of all pages domains. The user must have admin permissions. -```text +```plaintext GET /pages/domains ``` @@ -35,7 +35,7 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/ap Get a list of project pages domains. The user must have permissions to view pages domains. -```text +```plaintext GET /projects/:id/pages/domains ``` @@ -71,7 +71,7 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/ap Get a single project pages domain. The user must have permissions to view pages domains. -```text +```plaintext GET /projects/:id/pages/domains/:domain ``` @@ -113,7 +113,7 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/ap Creates a new pages domain. The user must have permissions to create new pages domains. -```text +```plaintext POST /projects/:id/pages/domains ``` @@ -155,7 +155,7 @@ curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --form "domain Updates an existing project pages domain. The user must have permissions to change an existing pages domains. -```text +```plaintext PUT /projects/:id/pages/domains/:domain ``` @@ -225,7 +225,7 @@ curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" --form "certifi Deletes an existing project pages domain. -```text +```plaintext DELETE /projects/:id/pages/domains/:domain ``` diff --git a/doc/api/pipeline_schedules.md b/doc/api/pipeline_schedules.md index 6faaa95116d..36a18411ceb 100644 --- a/doc/api/pipeline_schedules.md +++ b/doc/api/pipeline_schedules.md @@ -286,7 +286,7 @@ curl --request DELETE --header "PRIVATE-TOKEN: k5ESFgWY2Qf5xEvDcFxZ" "https://gi Trigger a new scheduled pipeline, which runs immediately. The next scheduled run of this pipeline is not affected. -```text +```plaintext POST /projects/:id/pipeline_schedules/:pipeline_schedule_id/play ``` diff --git a/doc/api/project_import_export.md b/doc/api/project_import_export.md index cee01828410..ae2fbcec0ff 100644 --- a/doc/api/project_import_export.md +++ b/doc/api/project_import_export.md @@ -18,7 +18,7 @@ data file uploads to the final server. From GitLab 10.7, the `upload[url]` parameter is required if the `upload` parameter is present. -```text +```plaintext POST /projects/:id/export ``` @@ -49,7 +49,7 @@ The upload request will be sent with `Content-Type: application/gzip` header. En Get the status of export. -```text +```plaintext GET /projects/:id/export ``` @@ -102,7 +102,7 @@ an email notifying the user to download the file, uploading the exported file to Download the finished export. -```text +```plaintext GET /projects/:id/export/download ``` @@ -121,7 +121,7 @@ ls *export.tar.gz ## Import a file -```text +```plaintext POST /projects/import ``` @@ -185,7 +185,7 @@ requests.post(url, headers=headers, data=data, files=files) Get the status of an import. -```text +```plaintext GET /projects/:id/import ``` diff --git a/doc/api/project_repository_storage_moves.md b/doc/api/project_repository_storage_moves.md index d3d2f109b02..8df472f193f 100644 --- a/doc/api/project_repository_storage_moves.md +++ b/doc/api/project_repository_storage_moves.md @@ -6,7 +6,7 @@ Project repository storage can be moved. To retrieve project repository storage ## Retrieve all project repository storage moves -```text +```plaintext GET /project_repository_storage_moves ``` @@ -43,7 +43,7 @@ Example response: ## Get a single project repository storage move -```text +```plaintext GET /project_repository_storage_moves/:id ``` diff --git a/doc/api/remote_mirrors.md b/doc/api/remote_mirrors.md index 12b453007b0..e46a890cbd4 100644 --- a/doc/api/remote_mirrors.md +++ b/doc/api/remote_mirrors.md @@ -11,7 +11,7 @@ outlined below. Returns an Array of remote mirrors and their statuses: -```text +```plaintext GET /projects/:id/remote_mirrors ``` @@ -50,7 +50,7 @@ and password information. Create a remote mirror for a project. The mirror will be disabled by default. You can enable it by including the optional parameter `enabled` when creating it: -```text +```plaintext POST /projects/:id/remote_mirrors ``` @@ -91,7 +91,7 @@ Example response: Toggle a remote mirror on or off, or change which types of branches are mirrored: -```text +```plaintext PUT /projects/:id/remote_mirrors/:mirror_id ``` diff --git a/doc/api/repository_files.md b/doc/api/repository_files.md index 62a87b658a9..a8b58d90c34 100644 --- a/doc/api/repository_files.md +++ b/doc/api/repository_files.md @@ -65,7 +65,7 @@ curl --head --header 'PRIVATE-TOKEN: <your_access_token>' 'https://gitlab.exampl Example response: -```text +```plaintext HTTP/1.1 200 OK ... X-Gitlab-Blob-Id: 79f7bbd25901e8334750839545a9bd021f0e4c83 @@ -134,7 +134,7 @@ curl --head --header 'PRIVATE-TOKEN: <your_access_token>' 'https://gitlab.exampl Example response: -```text +```plaintext HTTP/1.1 200 OK ... X-Gitlab-Blob-Id: 79f7bbd25901e8334750839545a9bd021f0e4c83 diff --git a/doc/api/scim.md b/doc/api/scim.md index 3daa243908a..4300c9efa3d 100644 --- a/doc/api/scim.md +++ b/doc/api/scim.md @@ -16,7 +16,7 @@ NOTE: **Note:** This endpoint is used as part of the SCIM syncing mechanism and it only returns a single user based on a unique ID which should match the `extern_uid` of the user. -```text +```plaintext GET /api/scim/v2/groups/:group_path/Users ``` @@ -72,7 +72,7 @@ Example response: ## Get a single SAML user -```text +```plaintext GET /api/scim/v2/groups/:group_path/Users/:id ``` @@ -113,7 +113,7 @@ Example response: ## Create a SAML user -```text +```plaintext POST /api/scim/v2/groups/:group_path/Users/ ``` @@ -169,7 +169,7 @@ Fields that can be updated are: | `active` | Identity removal if `active` = `false` | | `userName` | `username` | -```text +```plaintext PATCH /api/scim/v2/groups/:group_path/Users/:id ``` @@ -193,7 +193,7 @@ Returns an empty response with a `204` status code if successful. Removes the user's SSO identity and group membership. -```text +```plaintext DELETE /api/scim/v2/groups/:group_path/Users/:id ``` diff --git a/doc/api/snippets.md b/doc/api/snippets.md index 8b56484fdfd..e2e39de412b 100644 --- a/doc/api/snippets.md +++ b/doc/api/snippets.md @@ -21,7 +21,7 @@ Valid values for snippet visibility levels are: Get a list of the current user's snippets. -```text +```plaintext GET /snippets ``` @@ -82,7 +82,7 @@ Example response: Get a single snippet. -```text +```plaintext GET /snippets/:id ``` @@ -128,7 +128,7 @@ Example response: Get a single snippet's raw contents. -```text +```plaintext GET /snippets/:id/raw ``` @@ -146,7 +146,7 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/ap Example response: -```text +```plaintext Hello World snippet ``` @@ -157,7 +157,7 @@ Create a new snippet. NOTE: **Note:** The user must have permission to create new snippets. -```text +```plaintext POST /snippets ``` @@ -214,7 +214,7 @@ Update an existing snippet. NOTE: **Note:** The user must have permission to change an existing snippet. -```text +```plaintext PUT /snippets/:id ``` @@ -269,7 +269,7 @@ Example response: Delete an existing snippet. -```text +```plaintext DELETE /snippets/:id ``` @@ -296,7 +296,7 @@ The following are possible return codes: List all public snippets. -```text +```plaintext GET /snippets/public ``` @@ -364,7 +364,7 @@ Example response: NOTE: **Note:** Available only for administrators. -```text +```plaintext GET /snippets/:id/user_agent_detail ``` diff --git a/doc/ci/ci_cd_for_external_repos/bitbucket_integration.md b/doc/ci/ci_cd_for_external_repos/bitbucket_integration.md index 3437f867cb8..2836f9932c6 100644 --- a/doc/ci/ci_cd_for_external_repos/bitbucket_integration.md +++ b/doc/ci/ci_cd_for_external_repos/bitbucket_integration.md @@ -29,7 +29,7 @@ To use GitLab CI/CD with a Bitbucket Cloud repository: The web hook URL should be set to the GitLab API to trigger pull mirroring, using the Personal Access Token we just generated for authentication. - ```text + ```plaintext https://gitlab.com/api/v4/projects/<PROJECT_ID>/mirror/pull?private_token=<PERSONAL_ACCESS_TOKEN> ``` diff --git a/doc/ci/cloud_deployment/index.md b/doc/ci/cloud_deployment/index.md index f70998a5f49..8883ad5dfd6 100644 --- a/doc/ci/cloud_deployment/index.md +++ b/doc/ci/cloud_deployment/index.md @@ -1,4 +1,7 @@ --- +stage: Release +group: Progressive Delivery +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers type: howto --- @@ -36,7 +39,7 @@ Some credentials are required to be able to run `aws` commands: 1. You can now use `aws` commands in the `.gitlab-ci.yml` file of this project: - ```yml + ```yaml deploy: stage: deploy image: registry.gitlab.com/gitlab-org/cloud-deploy/aws-base:latest # see the note below diff --git a/doc/ci/docker/using_docker_build.md b/doc/ci/docker/using_docker_build.md index 427f61deb29..f992af6c8a5 100644 --- a/doc/ci/docker/using_docker_build.md +++ b/doc/ci/docker/using_docker_build.md @@ -476,7 +476,7 @@ which can be avoided if a different driver is used, for example `overlay2`. On Ubuntu systems, this is done by editing `/etc/modules`. Just add the following line into it: - ```text + ```plaintext overlay ``` diff --git a/doc/ci/environments/environments_dashboard.md b/doc/ci/environments/environments_dashboard.md index f82728cd587..4a72c0d6d62 100644 --- a/doc/ci/environments/environments_dashboard.md +++ b/doc/ci/environments/environments_dashboard.md @@ -1,4 +1,7 @@ --- +stage: Release +group: Release Management +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers type: reference --- diff --git a/doc/ci/environments/incremental_rollouts.md b/doc/ci/environments/incremental_rollouts.md index 0fa0af6a9fb..016a6ac7cad 100644 --- a/doc/ci/environments/incremental_rollouts.md +++ b/doc/ci/environments/incremental_rollouts.md @@ -46,7 +46,7 @@ application will be deployed to a single pod while the remaining 9 will present First we [define the template as manual](https://gitlab.com/gl-release/incremental-rollout-example/blob/master/.gitlab-ci.yml#L100-103): -```yml +```yaml .manual_rollout_template: &manual_rollout_template <<: *rollout_template stage: production @@ -55,7 +55,7 @@ First we [define the template as manual](https://gitlab.com/gl-release/increment Then we [define the rollout amount for each step](https://gitlab.com/gl-release/incremental-rollout-example/blob/master/.gitlab-ci.yml#L152-155): -```yml +```yaml rollout 10%: <<: *manual_rollout_template variables: @@ -86,7 +86,7 @@ countdown and then deploy. First we [define the template as timed](https://gitlab.com/gl-release/timed-rollout-example/blob/master/.gitlab-ci.yml#L86-89): -```yml +```yaml .timed_rollout_template: &timed_rollout_template <<: *rollout_template when: delayed @@ -95,13 +95,13 @@ First we [define the template as timed](https://gitlab.com/gl-release/timed-roll We can define the delay period using the `start_in` key: -```yml +```yaml start_in: 1 minutes ``` Then we [define the rollout amount for each step](https://gitlab.com/gl-release/timed-rollout-example/blob/master/.gitlab-ci.yml#L97-101): -```yml +```yaml timed rollout 30%: <<: *timed_rollout_template stage: timed rollout 30% diff --git a/doc/ci/environments/index.md b/doc/ci/environments/index.md index f16f92edc29..b6ec30b5571 100644 --- a/doc/ci/environments/index.md +++ b/doc/ci/environments/index.md @@ -1,4 +1,7 @@ --- +stage: Release +group: Release Management +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers type: reference disqus_identifier: 'https://docs.gitlab.com/ee/ci/environments.html' --- @@ -902,7 +905,7 @@ knowing the state of your current environments is only a `git fetch` away. In your Git configuration, append the `[remote "<your-remote>"]` block with an extra fetch line: -```text +```plaintext fetch = +refs/environments/*:refs/remotes/origin/environments/* ``` diff --git a/doc/ci/environments/protected_environments.md b/doc/ci/environments/protected_environments.md index e51a58e8e61..43ac42ea0c7 100644 --- a/doc/ci/environments/protected_environments.md +++ b/doc/ci/environments/protected_environments.md @@ -1,4 +1,7 @@ --- +stage: Release +group: Release Management +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers type: concepts, howto --- diff --git a/doc/ci/examples/devops_and_game_dev_with_gitlab_ci_cd/index.md b/doc/ci/examples/devops_and_game_dev_with_gitlab_ci_cd/index.md index 2fcbce79eac..610220a6bff 100644 --- a/doc/ci/examples/devops_and_game_dev_with_gitlab_ci_cd/index.md +++ b/doc/ci/examples/devops_and_game_dev_with_gitlab_ci_cd/index.md @@ -269,7 +269,7 @@ we know we will need to access everything in the `built` folder, given by GitLab We'll also cache `node_modules` to avoid having to do a full re-pull of those dependencies: just pack them up in the cache. Here is the full `build` job: -```yml +```yaml build: stage: build script: @@ -296,7 +296,7 @@ the previous job. Lastly, by convention, we let GitLab CI/CD know this needs to the `build` job by giving it a `test` [stage](../../../ci/yaml/README.md#stages). Following the YAML structure, the `test` job should look like this: -```yml +```yaml test: stage: test script: @@ -318,7 +318,7 @@ we've added test artifacts and a test stage to our GitLab CI/CD pipeline using ` allowing us to run our tests by every push. Our entire `.gitlab-ci.yml` file should now look like this: -```yml +```yaml image: node:10 build: @@ -440,7 +440,7 @@ we add directives to ensure deployment `only` happens on pushes to `master`. Thi single branch still runs through CI, and only merging (or committing directly) to master will trigger the `deploy` job of our pipeline. Put these together to get the following: -```yml +```yaml deploy: stage: deploy variables: @@ -459,7 +459,7 @@ deploy: Be sure to update the region and S3 URL in that last script command to fit your setup. Our final configuration file `.gitlab-ci.yml` looks like: -```yml +```yaml image: node:10 build: diff --git a/doc/ci/introduction/index.md b/doc/ci/introduction/index.md index 7f578ffd5bf..b7f1837d83e 100644 --- a/doc/ci/introduction/index.md +++ b/doc/ci/introduction/index.md @@ -108,7 +108,7 @@ The scripts are grouped into **jobs**, and together they compose a **pipeline**. A minimalist example of `.gitlab-ci.yml` file could contain: -```yml +```yaml before_script: - apt-get install rubygems ruby-dev -y diff --git a/doc/ci/pipelines/index.md b/doc/ci/pipelines/index.md index f4f751338e1..731cb196eaa 100644 --- a/doc/ci/pipelines/index.md +++ b/doc/ci/pipelines/index.md @@ -222,7 +222,7 @@ In the example: Visually, it can be viewed as: -```text +```plaintext 0 1 2 3 4 5 6 7 AAAAAAA BBBBBBB @@ -231,7 +231,7 @@ Visually, it can be viewed as: The union of A, B, and C is (1, 4) and (6, 7). Therefore, the total running time is: -```text +```plaintext (4 - 1) + (7 - 6) => 4 ``` diff --git a/doc/ci/pipelines/settings.md b/doc/ci/pipelines/settings.md index ae4406742d4..0a859b5b68f 100644 --- a/doc/ci/pipelines/settings.md +++ b/doc/ci/pipelines/settings.md @@ -250,7 +250,7 @@ Depending on the status of your job, a badge can have the following values: You can access a pipeline status badge image using the following link: -```text +```plaintext https://example.gitlab.com/<namespace>/<project>/badges/<branch>/pipeline.svg ``` @@ -262,7 +262,7 @@ pipeline can have the test coverage percentage value defined. The test coverage badge can be accessed using following link: -```text +```plaintext https://example.gitlab.com/<namespace>/<project>/badges/<branch>/coverage.svg ``` @@ -281,7 +281,7 @@ Pipeline badges can be rendered in different styles by adding the `style=style_n #### Flat (default) -```text +```plaintext https://example.gitlab.com/<namespace>/<project>/badges/<branch>/coverage.svg?style=flat ``` @@ -291,7 +291,7 @@ https://example.gitlab.com/<namespace>/<project>/badges/<branch>/coverage.svg?st > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/issues/30120) in GitLab 11.8. -```text +```plaintext https://example.gitlab.com/<namespace>/<project>/badges/<branch>/coverage.svg?style=flat-square ``` diff --git a/doc/ci/review_apps/index.md b/doc/ci/review_apps/index.md index ed34b555c98..ad0a4270f43 100644 --- a/doc/ci/review_apps/index.md +++ b/doc/ci/review_apps/index.md @@ -1,4 +1,7 @@ --- +stage: Release +group: Progressive Delivery +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers type: reference --- diff --git a/doc/ci/yaml/README.md b/doc/ci/yaml/README.md index 913e1c63d6d..c40580cbfb7 100644 --- a/doc/ci/yaml/README.md +++ b/doc/ci/yaml/README.md @@ -715,7 +715,7 @@ For example, the following are equivalent configuration: - Configured in order: - ```yml + ```yaml stages: - .pre - a @@ -725,7 +725,7 @@ For example, the following are equivalent configuration: - Configured out of order: - ```yml + ```yaml stages: - a - .pre @@ -735,7 +735,7 @@ For example, the following are equivalent configuration: - Not explicitly configured: - ```yml + ```yaml stages: - a - b @@ -2554,7 +2554,7 @@ in the [merge request](../../user/project/merge_requests/index.md) UI. For example, to match a single file: -```yml +```yaml test: script: [ 'echo 1' ] artifacts: @@ -2567,7 +2567,7 @@ that points to `file1.txt`. An example that will match an entire directory: -```yml +```yaml test: script: [ 'echo 1' ] artifacts: @@ -3534,7 +3534,7 @@ specific directory (Go projects, for example). In that case, you can specify the `GIT_CLONE_PATH` variable to tell the Runner in which directory to clone the repository: -```yml +```yaml variables: GIT_CLONE_PATH: $CI_BUILDS_DIR/project-name @@ -3564,7 +3564,7 @@ exposes two additional variables that provide a unique `ID` of concurrency: The most stable configuration that should work well in any scenario and on any executor is to use `$CI_CONCURRENT_ID` in the `GIT_CLONE_PATH`. For example: -```yml +```yaml variables: GIT_CLONE_PATH: $CI_BUILDS_DIR/$CI_CONCURRENT_ID/project-name @@ -3576,7 +3576,7 @@ test: The `$CI_CONCURRENT_PROJECT_ID` should be used in conjunction with `$CI_PROJECT_PATH` as the `$CI_PROJECT_PATH` provides a path of a repository. That is, `group/subgroup/project`. For example: -```yml +```yaml variables: GIT_CLONE_PATH: $CI_BUILDS_DIR/$CI_CONCURRENT_ID/$CI_PROJECT_PATH @@ -3593,7 +3593,7 @@ within is not supported. For example, you define both the variables below in your `.gitlab-ci.yml` file: -```yml +```yaml variables: GOPATH: $CI_BUILDS_DIR/go GIT_CLONE_PATH: $GOPATH/src/namespace/project diff --git a/doc/development/README.md b/doc/development/README.md index 499c7e2e6fa..22cc21e12b9 100644 --- a/doc/development/README.md +++ b/doc/development/README.md @@ -57,8 +57,8 @@ Complementary reads: - [GitLab utilities](utilities.md) - [Issuable-like Rails models](issuable-like-models.md) - [Logging](logging.md) -- [API styleguide](api_styleguide.md) for contributing to the API -- [GraphQL API styleguide](api_graphql_styleguide.md) for contributing to the [GraphQL API](../api/graphql/index.md) +- [API style guide](api_styleguide.md) for contributing to the API +- [GraphQL API style guide](api_graphql_styleguide.md) for contributing to the [GraphQL API](../api/graphql/index.md) - [Sidekiq guidelines](sidekiq_style_guide.md) for working with Sidekiq workers - [Working with Gitaly](gitaly.md) - [Manage feature flags](feature_flags/index.md) @@ -177,7 +177,7 @@ Complementary reads: ## Documentation guides - [Writing documentation](documentation/index.md) -- [Documentation styleguide](documentation/styleguide.md) +- [Documentation style guide](documentation/styleguide.md) - [Markdown](../user/markdown.md) ## Internationalization (i18n) guides diff --git a/doc/development/api_graphql_styleguide.md b/doc/development/api_graphql_styleguide.md index 68da6b01aab..6d3c0cf0eac 100644 --- a/doc/development/api_graphql_styleguide.md +++ b/doc/development/api_graphql_styleguide.md @@ -1,6 +1,6 @@ -# GraphQL API +# GraphQL API style guide -This document outlines the styleguide for GitLab's [GraphQL API](../api/graphql/index.md). +This document outlines the style guide for GitLab's [GraphQL API](../api/graphql/index.md). ## How GitLab implements GraphQL @@ -365,7 +365,7 @@ field :token, GraphQL::STRING_TYPE, null: true, The original `description:` of the field should be maintained, and should _not_ be updated to mention the deprecation. -### Deprecation reason styleguide +### Deprecation reason style guide Where the reason for deprecation is due to the field being replaced with another field, the `reason` must be: @@ -446,7 +446,7 @@ Descriptions of fields and arguments are viewable to users through: - The [GraphiQL explorer](#graphiql). - The [static GraphQL API reference](../api/graphql/#reference). -### Description styleguide +### Description style guide To ensure consistency, the following should be followed whenever adding or updating descriptions: diff --git a/doc/development/api_styleguide.md b/doc/development/api_styleguide.md index 25c8cbd3fde..e9a41e7ec58 100644 --- a/doc/development/api_styleguide.md +++ b/doc/development/api_styleguide.md @@ -1,6 +1,6 @@ -# API styleguide +# API style guide -This styleguide recommends best practices for API development. +This style guide recommends best practices for API development. ## Instance variables diff --git a/doc/development/changelog.md b/doc/development/changelog.md index 2007c26403c..a0e9f9d3be3 100644 --- a/doc/development/changelog.md +++ b/doc/development/changelog.md @@ -101,20 +101,20 @@ automatically. Its simplest usage is to provide the value for `title`: -```text +```plaintext bin/changelog 'Hey DZ, I added a feature to GitLab!' ``` If you want to generate a changelog entry for GitLab EE, you will need to pass the `--ee` option: -```text +```plaintext bin/changelog --ee 'Hey DZ, I added a feature to GitLab!' ``` At this point the script would ask you to select the category of the change (mapped to the `type` field in the entry): -```text +```plaintext >> Please specify the category of your change: 1. New feature 2. Bug fix @@ -132,7 +132,7 @@ the command above on a branch called `feature/hey-dz`, it will generate a The command will output the path of the generated file and its contents: -```text +```plaintext create changelogs/unreleased/my-feature.yml --- title: Hey DZ, I added a feature to GitLab! @@ -162,7 +162,7 @@ If you use **`--amend`** and don't provide a title, it will automatically use the "subject" of the previous commit, which is the first line of the commit message: -```text +```plaintext $ git show --oneline ab88683 Added an awesome new feature to GitLab @@ -180,7 +180,7 @@ type: Use **`--force`** or **`-f`** to overwrite an existing changelog entry if it already exists. -```text +```plaintext $ bin/changelog 'Hey DZ, I added a feature to GitLab!' error changelogs/unreleased/feature-hey-dz.yml already exists! Use `--force` to overwrite. @@ -198,7 +198,7 @@ type: Use the **`--merge-request`** or **`-m`** argument to provide the `merge_request` value: -```text +```plaintext $ bin/changelog 'Hey DZ, I added a feature to GitLab!' -m 1983 create changelogs/unreleased/feature-hey-dz.yml --- @@ -213,7 +213,7 @@ type: Use the **`--dry-run`** or **`-n`** argument to prevent actually writing or committing anything: -```text +```plaintext $ bin/changelog --amend --dry-run create changelogs/unreleased/feature-hey-dz.yml --- @@ -230,7 +230,7 @@ $ ls changelogs/unreleased/ Use the **`--git-username`** or **`-u`** argument to automatically fill in the `author` value with your configured Git `user.name` value: -```text +```plaintext $ git config user.name Jane Doe @@ -247,7 +247,7 @@ type: Use the **`--type`** or **`-t`** argument to provide the `type` value: -```text +```plaintext $ bin/changelog 'Hey DZ, I added a feature to GitLab!' -t added create changelogs/unreleased/feature-hey-dz.yml --- diff --git a/doc/development/contributing/merge_request_workflow.md b/doc/development/contributing/merge_request_workflow.md index ed32ef2d6f6..a70fadfe8a9 100644 --- a/doc/development/contributing/merge_request_workflow.md +++ b/doc/development/contributing/merge_request_workflow.md @@ -138,7 +138,7 @@ For more information see [How to Write a Git Commit Message](https://chris.beams Example commit message template that can be used on your machine that embodies the above (guide for [how to apply template](https://codeinthehole.com/tips/a-useful-template-for-commit-messages/)): -```text +```plaintext # (If applied, this commit will...) <subject> (Max 50 char) # |<---- Using a Maximum Of 50 Characters ---->| diff --git a/doc/development/contributing/style_guides.md b/doc/development/contributing/style_guides.md index 9a0b654f47f..9e4870eadc4 100644 --- a/doc/development/contributing/style_guides.md +++ b/doc/development/contributing/style_guides.md @@ -53,7 +53,7 @@ should enable all RuboCop rules to avoid style-related discussions/nitpicking/back-and-forth in reviews. Additionally, we have a dedicated -[newlines styleguide](../newlines_styleguide.md), as well as dedicated +[newlines style guide](../newlines_styleguide.md), as well as dedicated [test-specific style guides and best practices](../testing_guide/index.md). ## Database migrations diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md index 22c1d790b07..6d146051e13 100644 --- a/doc/development/documentation/styleguide.md +++ b/doc/development/documentation/styleguide.md @@ -541,7 +541,7 @@ In unordered lists (using `-`), this means two spaces for each level of indentat - Unordered list item 3 - ```text + ```plaintext a codeblock that will next inside list item 3 ``` @@ -564,7 +564,7 @@ For ordered lists, use three spaces for each level of indentation: 1. Ordered list item 3 - ```text + ```plaintext a codeblock that will next inside list item 3 ``` @@ -1529,7 +1529,7 @@ The following can be used as a template to get started: One or two sentence description of what endpoint does. -```text +```plaintext METHOD /endpoint ``` diff --git a/doc/development/newlines_styleguide.md b/doc/development/newlines_styleguide.md index a13adc2f13e..e298ba1d935 100644 --- a/doc/development/newlines_styleguide.md +++ b/doc/development/newlines_styleguide.md @@ -1,4 +1,4 @@ -# Newlines styleguide +# Newlines style guide This style guide recommends best practices for newlines in Ruby code. diff --git a/doc/development/testing_guide/index.md b/doc/development/testing_guide/index.md index 31ec09b2c8e..f0fb06910f8 100644 --- a/doc/development/testing_guide/index.md +++ b/doc/development/testing_guide/index.md @@ -4,7 +4,7 @@ This document describes various guidelines and best practices for automated testing of the GitLab project. It is meant to be an _extension_ of the [thoughtbot testing -styleguide](https://github.com/thoughtbot/guides/tree/master/style/testing). If +style guide](https://github.com/thoughtbot/guides/tree/master/style/testing). If this guide defines a rule that contradicts the thoughtbot guide, this guide takes precedence. Some guidelines may be repeated verbatim to stress their importance. diff --git a/doc/gitlab-basics/create-project.md b/doc/gitlab-basics/create-project.md index 1febe8337bc..152fb24699e 100644 --- a/doc/gitlab-basics/create-project.md +++ b/doc/gitlab-basics/create-project.md @@ -145,7 +145,7 @@ git push --set-upstream https://gitlab.example.com/namespace/nonexistent-project Once the push finishes successfully, a remote message will indicate the command to set the remote and the URL to the new project: -```text +```plaintext remote: remote: The private project namespace/nonexistent-project was created. remote: diff --git a/doc/integration/vault.md b/doc/integration/vault.md index c29df9a24dc..0a6ced42925 100644 --- a/doc/integration/vault.md +++ b/doc/integration/vault.md @@ -1,4 +1,7 @@ --- +stage: Release +group: Release Management +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers type: reference, howto --- diff --git a/doc/security/asset_proxy.md b/doc/security/asset_proxy.md index d042fb3efe7..91a35c2f2a9 100644 --- a/doc/security/asset_proxy.md +++ b/doc/security/asset_proxy.md @@ -63,6 +63,6 @@ For example, the following is a link to an image in Markdown: The following is an example of a source link that could result: -```text +```plaintext http://proxy.gitlab.example.com/f9dd2b40157757eb82afeedbf1290ffb67a3aeeb/68747470733a2f2f61626f75742e6769746c61622e636f6d2f696d616765732f70726573732f6c6f676f2f6a70672f6769746c61622d69636f6e2d7267622e6a7067 ``` diff --git a/doc/security/webhooks.md b/doc/security/webhooks.md index bd05cbff05e..27f79dbdf66 100644 --- a/doc/security/webhooks.md +++ b/doc/security/webhooks.md @@ -78,7 +78,7 @@ will whitelist all ports on all IPs in that range. Example: -```text +```plaintext example.com;gitlab.example.com 127.0.0.1,1:0:0:0:0:0:0:1 127.0.0.0/8 1:0:0:0:0:0:0:0/124 diff --git a/doc/topics/autodevops/index.md b/doc/topics/autodevops/index.md index a4d433ec264..e7165136cf0 100644 --- a/doc/topics/autodevops/index.md +++ b/doc/topics/autodevops/index.md @@ -263,7 +263,7 @@ and replaced with `KUBE_INGRESS_BASE_DOMAIN`, and removed in Auto DevOps requires a wildcard DNS A record matching the base domain(s). For a base domain of `example.com`, you'd need a DNS entry like: -```text +```plaintext *.example.com 3600 A 1.2.3.4 ``` diff --git a/doc/topics/git/troubleshooting_git.md b/doc/topics/git/troubleshooting_git.md index f8d812d37e6..010a811bd33 100644 --- a/doc/topics/git/troubleshooting_git.md +++ b/doc/topics/git/troubleshooting_git.md @@ -13,7 +13,7 @@ with Git. 'Broken pipe' errors can occur when attempting to push to a remote repository. When pushing you will usually see: -```text +```plaintext Write failed: Broken pipe fatal: The remote end hung up unexpectedly ``` @@ -56,7 +56,7 @@ Configuring *both* the client and the server is unnecessary. - On UNIX, edit `~/.ssh/config` (create the file if it doesn’t exist) and add or edit: - ```text + ```plaintext Host your-gitlab-instance-url.com ServerAliveInterval 60 ServerAliveCountMax 5 @@ -68,7 +68,7 @@ Configuring *both* the client and the server is unnecessary. **To configure SSH on the server side**, edit `/etc/ssh/sshd_config` and add: -```text +```plaintext ClientAliveInterval 60 ClientAliveCountMax 5 ``` @@ -93,7 +93,7 @@ to >= 2.9 (see [Broken pipe when pushing to Git repository](https://stackoverflo Users may experience the following error when attempting to push or pull using Git over SSH: -```text +```plaintext Please make sure you have the correct access rights and the repository exists. ... @@ -103,7 +103,7 @@ fatal: Could not read from remote repository. or -```text +```plaintext ssh_exchange_identification: Connection closed by remote host fatal: The remote end hung up unexpectedly ``` @@ -117,7 +117,7 @@ beginning. The default value is `10`. Increase `MaxStartups` on the GitLab server by adding or modifying the value in `/etc/ssh/sshd_config`: -```text +```plaintext MaxStartups 100:30:200 ``` @@ -140,7 +140,7 @@ If pulling/pushing from/to your repository ends up taking more than 50 seconds, a timeout will be issued with a log of the number of operations performed and their respective timings, like the example below: -```text +```plaintext remote: Running checks for branch: master remote: Scanning for LFS objects... (153ms) remote: Calculating new repository size... (cancelled after 729ms) @@ -153,7 +153,7 @@ and provide GitLab with more information on how to improve the service. If the buffer size is lower than what is allowed in the request, the action will fail with an error similar to the one below: -```text +```plaintext error: RPC failed; curl 18 transfer closed with outstanding read data remaining fatal: The remote end hung up unexpectedly fatal: early EOF diff --git a/doc/topics/git/useful_git_commands.md b/doc/topics/git/useful_git_commands.md index 63defb24eaf..711567dbd06 100644 --- a/doc/topics/git/useful_git_commands.md +++ b/doc/topics/git/useful_git_commands.md @@ -116,7 +116,7 @@ git log <file> If you get this error message: -```text +```plaintext fatal: ambiguous argument <file_name>: unknown revision or path not in the working tree. Use '--' to separate paths from revisions, like this: ``` diff --git a/doc/user/admin_area/abuse_reports.md b/doc/user/admin_area/abuse_reports.md index 36de817a29b..77f4a84cf6f 100644 --- a/doc/user/admin_area/abuse_reports.md +++ b/doc/user/admin_area/abuse_reports.md @@ -46,7 +46,7 @@ Blocking a user: The user will be notified with the [following message](https://gitlab.com/gitlab-org/gitlab/blob/master/app/workers/email_receiver_worker.rb#L38): -```text +```plaintext Your account has been blocked. If you believe this is in error, contact a staff member. ``` diff --git a/doc/user/admin_area/monitoring/health_check.md b/doc/user/admin_area/monitoring/health_check.md index d3c8e6e7ad4..91e29118e3e 100644 --- a/doc/user/admin_area/monitoring/health_check.md +++ b/doc/user/admin_area/monitoring/health_check.md @@ -25,15 +25,15 @@ For details, see [how to add IPs to a whitelist for the monitoring endpoints](.. With default whitelist settings, the probes can be accessed from localhost using the following URLs: -```text +```plaintext GET http://localhost/-/health ``` -```text +```plaintext GET http://localhost/-/readiness ``` -```text +```plaintext GET http://localhost/-/liveness ``` @@ -45,7 +45,7 @@ are running. This endpoint circumvents Rails Controllers and is implemented as additional middleware `BasicHealthCheck` very early into the request processing lifecycle. -```text +```plaintext GET /-/health ``` @@ -57,7 +57,7 @@ curl 'https://gitlab.example.com/-/health' Example response: -```text +```plaintext GitLab OK ``` @@ -71,7 +71,7 @@ If the `all=1` parameter is specified, the check will also validate the dependent services (Database, Redis, Gitaly etc.) and gives a status for each. -```text +```plaintext GET /-/readiness GET /-/readiness?all=1 ``` @@ -111,7 +111,7 @@ Checks whether the application server is running. This probe is used to know if Rails Controllers are not deadlocked due to a multi-threading. -```text +```plaintext GET /-/liveness ``` @@ -148,7 +148,7 @@ accepted token can be found under the **Admin Area > Monitoring > Health check** The access token can be passed as a URL parameter: -```text +```plaintext https://gitlab.example.com/-/readiness?token=ACCESS_TOKEN ``` diff --git a/doc/user/admin_area/settings/instance_template_repository.md b/doc/user/admin_area/settings/instance_template_repository.md index b297d48cb0a..bef4e31259f 100644 --- a/doc/user/admin_area/settings/instance_template_repository.md +++ b/doc/user/admin_area/settings/instance_template_repository.md @@ -40,7 +40,7 @@ are supported: Each template must go in its respective subdirectory, have the correct extension and not be empty. So, the hierarchy should look like this: -```text +```plaintext |-- README.md |-- Dockerfile |-- custom_dockerfile.dockerfile diff --git a/doc/user/application_security/container_scanning/index.md b/doc/user/application_security/container_scanning/index.md index 19cc1e76d21..6e52d7dbdcf 100644 --- a/doc/user/application_security/container_scanning/index.md +++ b/doc/user/application_security/container_scanning/index.md @@ -59,7 +59,7 @@ To enable Container Scanning in your pipeline, you need: [predefined environment variables](../../../ci/variables/predefined_variables.md) as defined below: - ```text + ```plaintext $CI_REGISTRY_IMAGE/$CI_COMMIT_REF_SLUG:$CI_COMMIT_SHA ``` @@ -479,7 +479,7 @@ When the GitLab Runner uses the Docker executor and NFS is used (for example, `/var/lib/docker` is on an NFS mount), Container Scanning might fail with an error like the following: -```text +```plaintext docker: Error response from daemon: failed to copy xattrs: failed to set xattr "security.selinux" on /path/to/file: operation not supported. ``` diff --git a/doc/user/application_security/dast/index.md b/doc/user/application_security/dast/index.md index 893007d830e..1d5f96d96bb 100644 --- a/doc/user/application_security/dast/index.md +++ b/doc/user/application_security/dast/index.md @@ -315,7 +315,7 @@ API scans support OpenAPI V2 and OpenAPI V3 specifications. You can define these If your API specification is accessible at a URL, you can pass that URL in directly as the target. The specification does not have to be hosted on the same host as the API being tested. -```yml +```yaml include: - template: DAST.gitlab-ci.yml diff --git a/doc/user/application_security/dependency_scanning/index.md b/doc/user/application_security/dependency_scanning/index.md index 7ceb5fdd4b5..53462cf232e 100644 --- a/doc/user/application_security/dependency_scanning/index.md +++ b/doc/user/application_security/dependency_scanning/index.md @@ -570,7 +570,7 @@ doesn't support dependency references made with [local paths](https://docs.npmjs in the `package.json` of JavaScript projects. The dependency scan outputs the following error for such references: -```text +```plaintext ERROR: Could not find dependencies: <dependency-name>. You may need to run npm install ``` diff --git a/doc/user/clusters/applications.md b/doc/user/clusters/applications.md index be3c9ee3e6d..9ede9d9fdef 100644 --- a/doc/user/clusters/applications.md +++ b/doc/user/clusters/applications.md @@ -1232,7 +1232,7 @@ epic](https://gitlab.com/groups/gitlab-org/-/epics/1201). Applications can fail with the following error: -```text +```plaintext Error: remote error: tls: bad certificate ``` diff --git a/doc/user/compliance/license_compliance/index.md b/doc/user/compliance/license_compliance/index.md index 010eea8f45e..cbabed00283 100644 --- a/doc/user/compliance/license_compliance/index.md +++ b/doc/user/compliance/license_compliance/index.md @@ -284,7 +284,7 @@ license_scanning: The [`pip.conf`](https://pip.pypa.io/en/stable/reference/pip/) allows you to specify a list of [trusted hosts](https://pip.pypa.io/en/stable/reference/pip/#cmdoption-trusted-host): -```text +```plaintext [global] trusted-host = pypi.example.com ``` @@ -308,7 +308,7 @@ setting to specify its location. For example: -```text +```plaintext registry = https://npm.example.com ``` @@ -322,7 +322,7 @@ setting. For example: -```text +```plaintext strict-ssl = false ``` @@ -385,7 +385,7 @@ license_scanning: If you use the `license_management` artifact in GitLab 13.0 or later, the License Compliance job generates this error: -```text +```plaintext WARNING: Uploading artifacts to coordinator... failed id=:id responseStatus=400 Bad Request status=400 Bad Request token=:sha FATAL: invalid_argument diff --git a/doc/user/packages/conan_repository/index.md b/doc/user/packages/conan_repository/index.md index 5f84d9a5ba8..a56a67d4959 100644 --- a/doc/user/packages/conan_repository/index.md +++ b/doc/user/packages/conan_repository/index.md @@ -279,7 +279,7 @@ To work with Conan commands within [GitLab CI/CD](./../../../ci/README.md), you It is easiest to provide the `CONAN_LOGIN_USERNAME` and `CONAN_PASSWORD` with each Conan command in your `.gitlab-ci.yml` file: -```yml +```yaml image: conanio/gcc7 create_package: diff --git a/doc/user/packages/container_registry/index.md b/doc/user/packages/container_registry/index.md index 154c6e3e52f..5e642e1e21c 100644 --- a/doc/user/packages/container_registry/index.md +++ b/doc/user/packages/container_registry/index.md @@ -154,14 +154,14 @@ docker push registry.example.com/group/project/image Your image will be named after the following scheme: -```text +```plaintext <registry URL>/<namespace>/<project>/<image> ``` GitLab supports up to three levels of image repository names. The following examples of image tags are valid: -```text +```plaintext registry.example.com/group/project:some-tag registry.example.com/group/project/image:latest registry.example.com/group/project/my/image:rc1 diff --git a/doc/user/packages/npm_registry/index.md b/doc/user/packages/npm_registry/index.md index d19dfa51741..b909646431b 100644 --- a/doc/user/packages/npm_registry/index.md +++ b/doc/user/packages/npm_registry/index.md @@ -291,7 +291,7 @@ To work with NPM commands within [GitLab CI/CD](./../../../ci/README.md), you ca A simple example `.gitlab-ci.yml` file for publishing NPM packages: -```yml +```yaml image: node:latest stages: @@ -326,7 +326,7 @@ info Visit https://classic.yarnpkg.com/en/docs/cli/install for documentation abo In this case, try adding this to your `.npmrc` file (and replace `<your_token>` with your personal access token or deploy token): -```text +```plaintext //gitlab.com/api/v4/projects/:_authToken=<your_token> ``` diff --git a/doc/user/project/clusters/index.md b/doc/user/project/clusters/index.md index ddf6dd42ba6..1298a24fcac 100644 --- a/doc/user/project/clusters/index.md +++ b/doc/user/project/clusters/index.md @@ -338,7 +338,7 @@ the deployment job: However, sometimes GitLab can not create them. In such instances, your job will fail with the message: -```text +```plaintext This job failed because the necessary resources were not successfully created. ``` diff --git a/doc/user/project/index.md b/doc/user/project/index.md index 585c45e35df..50272f0e007 100644 --- a/doc/user/project/index.md +++ b/doc/user/project/index.md @@ -242,7 +242,7 @@ field. For example: -```text +```plaintext machine example.gitlab.com login <gitlab_user_name> password <personal_access_token> diff --git a/doc/user/project/integrations/slack.md b/doc/user/project/integrations/slack.md index ba2a8f55d84..419340c14ef 100644 --- a/doc/user/project/integrations/slack.md +++ b/doc/user/project/integrations/slack.md @@ -41,7 +41,7 @@ an error message and keep troubleshooting from there. You may see an entry similar to the following in your Sidekiq log: -```text +```plaintext 2019-01-10_13:22:08.42572 2019-01-10T13:22:08.425Z 6877 TID-abcdefg ProjectServiceWorker JID-3bade5fb3dd47a85db6d78c5 ERROR: {:class=>"ProjectServiceWorker", :service_class=>"SlackService", :message=>"SSL_connect returned=1 errno=0 state=error: certificate verify failed"} ``` diff --git a/doc/user/project/operations/feature_flags.md b/doc/user/project/operations/feature_flags.md index ec35a4dfdce..8716d5feb4a 100644 --- a/doc/user/project/operations/feature_flags.md +++ b/doc/user/project/operations/feature_flags.md @@ -1,3 +1,9 @@ +--- +stage: Release +group: Progressive Delivery +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers +--- + # Feature Flags **(PREMIUM)** > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/7433) in GitLab 11.4. diff --git a/doc/user/project/pages/getting_started_part_four.md b/doc/user/project/pages/getting_started_part_four.md index 172c1ec8b36..4e95b5d5a69 100644 --- a/doc/user/project/pages/getting_started_part_four.md +++ b/doc/user/project/pages/getting_started_part_four.md @@ -367,7 +367,7 @@ from Jekyll `_config.yml` file, otherwise Jekyll will understand it as a regular directory to build together with the site: -```yml +```yaml exclude: - vendor ``` diff --git a/doc/user/project/releases/index.md b/doc/user/project/releases/index.md index 3c7a64a38e5..bdb99d16625 100644 --- a/doc/user/project/releases/index.md +++ b/doc/user/project/releases/index.md @@ -1,5 +1,8 @@ --- type: reference, howto +stage: Release +group: Release Management +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers --- # Releases diff --git a/doc/user/project/status_page/index.md b/doc/user/project/status_page/index.md index 95beb4e1bb2..8ebfb638894 100644 --- a/doc/user/project/status_page/index.md +++ b/doc/user/project/status_page/index.md @@ -4,9 +4,9 @@ group: Health info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers --- -# GitLab Status Page +# GitLab Status Page **(ULTIMATE)** -> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2479) in GitLab 12.10. +> [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/2479) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 12.10. GitLab Status Page allows you to create and deploy a static website to communicate efficiently to users during an incident. |