diff --git a/.vale.ini b/.vale.ini index 13b198b9148..3c6e0d38b52 100644 --- a/.vale.ini +++ b/.vale.ini @@ -7,3 +7,6 @@ MinAlertLevel = suggestion [*.md] BasedOnStyles = gitlab + +# Ignore SVG markup +TokenIgnores = (\*\*\{\w*\}\*\*) diff --git a/doc/administration/consul.md b/doc/administration/consul.md index 5bddadcabed..5b577443c7c 100644 --- a/doc/administration/consul.md +++ b/doc/administration/consul.md @@ -77,7 +77,7 @@ Identify any existing health issues in the cluster by running the following comm within each node. The command will return an empty array if the cluster is healthy: ```shell -curl http://127.0.0.1:8500/v1/health/state/critical +curl "http://127.0.0.1:8500/v1/health/state/critical" ``` Consul nodes communicate using the raft protocol. If the current leader goes diff --git a/doc/administration/geo/setup/database.md b/doc/administration/geo/setup/database.md index adaf92a74b0..9778e08a30b 100644 --- a/doc/administration/geo/setup/database.md +++ b/doc/administration/geo/setup/database.md @@ -151,7 +151,7 @@ There is an [issue where support is being discussed](https://gitlab.com/gitlab-o ## ## Public address ## - echo "External address: $(curl --silent ipinfo.io/ip)" + echo "External address: $(curl --silent "ipinfo.io/ip")" ``` In most cases, the following addresses will be used to configure GitLab diff --git a/doc/administration/invalidate_markdown_cache.md b/doc/administration/invalidate_markdown_cache.md index df4a5f9e8c2..75bee6e0c9a 100644 --- a/doc/administration/invalidate_markdown_cache.md +++ b/doc/administration/invalidate_markdown_cache.md @@ -19,5 +19,5 @@ be done by [changing the application settings through the API](../api/settings.md#change-application-settings): ```shell -curl --request PUT --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/application/settings?local_markdown_version= +curl --request PUT --header "PRIVATE-TOKEN: " "https://gitlab.example.com/api/v4/application/settings?local_markdown_version=" ``` diff --git a/doc/administration/operations/fast_ssh_key_lookup.md b/doc/administration/operations/fast_ssh_key_lookup.md index 71b84e02db1..55852ebf11a 100644 --- a/doc/administration/operations/fast_ssh_key_lookup.md +++ b/doc/administration/operations/fast_ssh_key_lookup.md @@ -139,7 +139,7 @@ the database. The following instructions can be used to build OpenSSH 7.5: ```shell sudo su - cd /tmp - curl --remote-name https://cdn.openbsd.org/pub/OpenBSD/OpenSSH/portable/openssh-7.5p1.tar.gz + curl --remote-name "https://cdn.openbsd.org/pub/OpenBSD/OpenSSH/portable/openssh-7.5p1.tar.gz" tar xzvf openssh-7.5p1.tar.gz yum install rpm-build gcc make wget openssl-devel krb5-devel pam-devel libX11-devel xmkmf libXt-devel ``` diff --git a/doc/administration/packages/container_registry.md b/doc/administration/packages/container_registry.md index ec3b19503fd..4a4c08ebffd 100644 --- a/doc/administration/packages/container_registry.md +++ b/doc/administration/packages/container_registry.md @@ -1155,8 +1155,8 @@ After adding the setting, [reconfigure GitLab](../restart_gitlab.md#omnibus-gitl Use curl to request debug output from the debug server: ```shell -curl localhost:5001/debug/health -curl localhost:5001/debug/vars +curl "localhost:5001/debug/health" +curl "localhost:5001/debug/vars" ``` ### Advanced Troubleshooting @@ -1236,7 +1236,7 @@ mitmproxy --port 9000 This command runs mitmproxy on port `9000`. In another window, run: ```shell -curl --proxy http://localhost:9000 https://httpbin.org/status/200 +curl --proxy "http://localhost:9000" "https://httpbin.org/status/200" ``` If everything is set up correctly, information is displayed on the mitmproxy window and diff --git a/doc/administration/reference_architectures/troubleshooting.md b/doc/administration/reference_architectures/troubleshooting.md index fa43749cde9..406ff57c66d 100644 --- a/doc/administration/reference_architectures/troubleshooting.md +++ b/doc/administration/reference_architectures/troubleshooting.md @@ -434,13 +434,13 @@ If the monitoring node is not receiving any data, check that the exporters are capturing data. ```shell -curl http[s]://localhost:/metric +curl "http[s]://localhost:/metric" ``` or ```shell -curl http[s]://localhost:/-/metric +curl "http[s]://localhost:/-/metric" ``` ## Troubleshooting PgBouncer diff --git a/doc/administration/snippets/index.md b/doc/administration/snippets/index.md index 9bc9ebc8473..0bf0eb3b1ed 100644 --- a/doc/administration/snippets/index.md +++ b/doc/administration/snippets/index.md @@ -64,11 +64,11 @@ The process to set the snippets size limit through the Application Settings API exactly the same as you would do to [update any other setting](../../api/settings.md#change-application-settings). ```shell -curl --request PUT --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/application/settings?snippet_size_limit=52428800 +curl --request PUT --header "PRIVATE-TOKEN: " "https://gitlab.example.com/api/v4/application/settings?snippet_size_limit=52428800" ``` You can also use the API to [retrieve the current value](../../api/settings.md#get-current-application-settings). ```shell -curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/application/settings +curl --header "PRIVATE-TOKEN: " "https://gitlab.example.com/api/v4/application/settings" ``` diff --git a/doc/administration/troubleshooting/linux_cheat_sheet.md b/doc/administration/troubleshooting/linux_cheat_sheet.md index c3b83ec2458..5a7d0113c19 100644 --- a/doc/administration/troubleshooting/linux_cheat_sheet.md +++ b/doc/administration/troubleshooting/linux_cheat_sheet.md @@ -303,7 +303,7 @@ nslookup example.com 1.1.1.1 whois | grep -i "orgname\|netname" # Curl headers with redirect -curl --head --location https://example.com +curl --head --location "https://example.com" ``` ## Package Management diff --git a/doc/administration/troubleshooting/ssl.md b/doc/administration/troubleshooting/ssl.md index e9da3a4f803..d7bfd537eca 100644 --- a/doc/administration/troubleshooting/ssl.md +++ b/doc/administration/troubleshooting/ssl.md @@ -24,7 +24,7 @@ following issues: - `curl` fails: ```shell - curl https://gitlab.domain.tld + curl "https://gitlab.domain.tld" curl: (60) SSL certificate problem: unable to get local issuer certificate More details here: https://curl.haxx.se/docs/sslcerts.html ``` @@ -125,7 +125,7 @@ The cause of the issue can be confirmed by checking if: - `curl` fails: ```shell - $ curl https://gitlab.domain.tld + $ curl "https://gitlab.domain.tld" curl: (60) SSL certificate problem: self signed certificate More details here: https://curl.haxx.se/docs/sslcerts.html ``` diff --git a/doc/administration/troubleshooting/test_environments.md b/doc/administration/troubleshooting/test_environments.md index 655ffd00d19..53e51bbfe80 100644 --- a/doc/administration/troubleshooting/test_environments.md +++ b/doc/administration/troubleshooting/test_environments.md @@ -103,7 +103,7 @@ docker run -d --name elasticsearch \ docker.elastic.co/elasticsearch/elasticsearch:5.5.1 ``` -Then confirm it works in the browser at `curl http://:9200/_cat/health`. +Then confirm it works in the browser at `curl "http://:9200/_cat/health"`. Elasticsearch's default username is `elastic` and password is `changeme`. ### Kroki diff --git a/doc/administration/troubleshooting/tracing_correlation_id.md b/doc/administration/troubleshooting/tracing_correlation_id.md index 9dee5ef2cfb..a83f913b40b 100644 --- a/doc/administration/troubleshooting/tracing_correlation_id.md +++ b/doc/administration/troubleshooting/tracing_correlation_id.md @@ -59,7 +59,7 @@ interested in. If you're using `curl` then you can use the verbose option to show request and response headers, as well as other debug info. ```shell -➜ ~ curl --verbose https://gitlab.example.com/api/v4/projects +➜ ~ curl --verbose "https://gitlab.example.com/api/v4/projects" # look for a line that looks like this < x-request-id: 4rAMkV3gof4 ``` diff --git a/doc/administration/wikis/index.md b/doc/administration/wikis/index.md index c1330fe973b..026f9b6f471 100644 --- a/doc/administration/wikis/index.md +++ b/doc/administration/wikis/index.md @@ -65,11 +65,11 @@ The process to set the wiki page size limit through the Application Settings API exactly the same as you would do to [update any other setting](../../api/settings.md#change-application-settings). ```shell -curl --request PUT --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/application/settings?wiki_page_max_content_bytes=52428800 +curl --request PUT --header "PRIVATE-TOKEN: " "https://gitlab.example.com/api/v4/application/settings?wiki_page_max_content_bytes=52428800" ``` You can also use the API to [retrieve the current value](../../api/settings.md#get-current-application-settings). ```shell -curl --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/application/settings +curl --header "PRIVATE-TOKEN: " "https://gitlab.example.com/api/v4/application/settings" ``` diff --git a/doc/api/freeze_periods.md b/doc/api/freeze_periods.md index ae640e254d1..a4f6b03964f 100644 --- a/doc/api/freeze_periods.md +++ b/doc/api/freeze_periods.md @@ -138,7 +138,7 @@ Example request: ```shell curl --header 'Content-Type: application/json' --header "PRIVATE-TOKEN: " \ --data '{ "freeze_end": "0 8 * * 1" }' \ - --request PUT https://gitlab.example.com/api/v4/projects/19/freeze_periods/1 + --request PUT "https://gitlab.example.com/api/v4/projects/19/freeze_periods/1" ``` Example response: diff --git a/doc/api/metrics_user_starred_dashboards.md b/doc/api/metrics_user_starred_dashboards.md index aca04c6a926..79040333148 100644 --- a/doc/api/metrics_user_starred_dashboards.md +++ b/doc/api/metrics_user_starred_dashboards.md @@ -26,7 +26,7 @@ Parameters: | `dashboard_path` | string | yes | URL-encoded path to file defining the dashboard which should be marked as favorite. | ```shell -curl --header 'Private-Token: ' https://gitlab.example.com/api/v4/projects/20/metrics/user_starred_dashboards \ +curl --header 'Private-Token: ' "https://gitlab.example.com/api/v4/projects/20/metrics/user_starred_dashboards" \ --data-urlencode "dashboard_path=config/prometheus/dashboards/common_metrics.yml" ``` @@ -57,7 +57,7 @@ Parameters: | `dashboard_path` | string | no | URL-encoded path to file defining the dashboard which should no longer be marked as favorite. When not supplied, all dashboards within given projects are removed from favorites. | ```shell -curl --request DELETE --header 'Private-Token: ' https://gitlab.example.com/api/v4/projects/20/metrics/user_starred_dashboards \ +curl --request DELETE --header 'Private-Token: ' "https://gitlab.example.com/api/v4/projects/20/metrics/user_starred_dashboards" \ --data-urlencode "dashboard_path=config/prometheus/dashboards/common_metrics.yml" ``` 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 25ac9bcf8fc..cdfb3059181 100644 --- a/doc/ci/ci_cd_for_external_repos/bitbucket_integration.md +++ b/doc/ci/ci_cd_for_external_repos/bitbucket_integration.md @@ -110,7 +110,7 @@ To use GitLab CI/CD with a Bitbucket Cloud repository: esac echo "Pushing status to $BITBUCKET_STATUS_API..." - curl --request POST $BITBUCKET_STATUS_API \ + curl --request POST "$BITBUCKET_STATUS_API" \ --user $BITBUCKET_USERNAME:$BITBUCKET_ACCESS_TOKEN \ --header "Content-Type:application/json" \ --silent \ diff --git a/doc/ci/examples/laravel_with_gitlab_and_envoy/index.md b/doc/ci/examples/laravel_with_gitlab_and_envoy/index.md index 7213849b8f9..490fb857942 100644 --- a/doc/ci/examples/laravel_with_gitlab_and_envoy/index.md +++ b/doc/ci/examples/laravel_with_gitlab_and_envoy/index.md @@ -417,7 +417,7 @@ RUN apt-get clean RUN docker-php-ext-install mcrypt pdo_mysql zip # Install Composer -RUN curl --silent --show-error https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer +RUN curl --silent --show-error "https://getcomposer.org/installer" | php -- --install-dir=/usr/local/bin --filename=composer # Install Laravel Envoy RUN composer global require "laravel/envoy=~1.0" diff --git a/doc/ci/examples/php.md b/doc/ci/examples/php.md index 42f42c5608a..31f0cc76023 100644 --- a/doc/ci/examples/php.md +++ b/doc/ci/examples/php.md @@ -56,7 +56,7 @@ apt-get update -yqq apt-get install git -yqq # Install phpunit, the tool that we will use for testing -curl --location --output /usr/local/bin/phpunit https://phar.phpunit.de/phpunit.phar +curl --location --output /usr/local/bin/phpunit "https://phar.phpunit.de/phpunit.phar" chmod +x /usr/local/bin/phpunit # Install mysql driver diff --git a/doc/ci/triggers/README.md b/doc/ci/triggers/README.md index 35dec43dbb4..47f3a59759d 100644 --- a/doc/ci/triggers/README.md +++ b/doc/ci/triggers/README.md @@ -56,7 +56,7 @@ and it creates a dependent pipeline relation visible on the build_docs: stage: deploy script: - - curl --request POST --form "token=$CI_JOB_TOKEN" --form ref=master https://gitlab.example.com/api/v4/projects/9/trigger/pipeline + - curl --request POST --form "token=$CI_JOB_TOKEN" --form ref=master "https://gitlab.example.com/api/v4/projects/9/trigger/pipeline" only: - tags ``` @@ -143,7 +143,7 @@ By using cURL you can trigger a pipeline rerun with minimal effort, for example: curl --request POST \ --form token=TOKEN \ --form ref=master \ - https://gitlab.example.com/api/v4/projects/9/trigger/pipeline + "https://gitlab.example.com/api/v4/projects/9/trigger/pipeline" ``` In this case, the project with ID `9` gets rebuilt on `master` branch. @@ -244,7 +244,7 @@ curl --request POST \ --form token=TOKEN \ --form ref=master \ --form "variables[UPLOAD_TO_S3]=true" \ - https://gitlab.example.com/api/v4/projects/9/trigger/pipeline + "https://gitlab.example.com/api/v4/projects/9/trigger/pipeline" ``` Trigger variables have the [highest priority](../variables/README.md#priority-of-environment-variables) @@ -257,7 +257,7 @@ in conjunction with cron. The example below triggers a job on the `master` branch of project with ID `9` every night at `00:30`: ```shell -30 0 * * * curl --request POST --form token=TOKEN --form ref=master https://gitlab.example.com/api/v4/projects/9/trigger/pipeline +30 0 * * * curl --request POST --form token=TOKEN --form ref=master "https://gitlab.example.com/api/v4/projects/9/trigger/pipeline" ``` This behavior can also be achieved through GitLab's UI with diff --git a/doc/ci/yaml/README.md b/doc/ci/yaml/README.md index 3588efe4376..c6fa5db20f1 100644 --- a/doc/ci/yaml/README.md +++ b/doc/ci/yaml/README.md @@ -4257,7 +4257,7 @@ job_name: - *some-script-before script: - *some-script - before_script: + after_script: - *some-script-after ``` diff --git a/doc/development/chaos_endpoints.md b/doc/development/chaos_endpoints.md index b3e655e8873..76b9f184478 100644 --- a/doc/development/chaos_endpoints.md +++ b/doc/development/chaos_endpoints.md @@ -66,8 +66,8 @@ GET /-/chaos/leakmem?memory_mb=1024&duration_s=50&async=true | `async` | boolean | no | Set to true to leak memory in a Sidekiq background worker process | ```shell -curl http://localhost:3000/-/chaos/leakmem?memory_mb=1024&duration_s=10 --header 'X-Chaos-Secret: secret' -curl http://localhost:3000/-/chaos/leakmem?memory_mb=1024&duration_s=10&token=secret +curl "http://localhost:3000/-/chaos/leakmem?memory_mb=1024&duration_s=10" --header 'X-Chaos-Secret: secret' +curl "http://localhost:3000/-/chaos/leakmem?memory_mb=1024&duration_s=10&token=secret" ``` ## CPU spin @@ -89,8 +89,8 @@ GET /-/chaos/cpu_spin?duration_s=50&async=true | `async` | boolean | no | Set to true to consume CPU in a Sidekiq background worker process | ```shell -curl http://localhost:3000/-/chaos/cpu_spin?duration_s=60 --header 'X-Chaos-Secret: secret' -curl http://localhost:3000/-/chaos/cpu_spin?duration_s=60&token=secret +curl "http://localhost:3000/-/chaos/cpu_spin?duration_s=60" --header 'X-Chaos-Secret: secret' +curl "http://localhost:3000/-/chaos/cpu_spin?duration_s=60&token=secret" ``` ## DB spin @@ -114,8 +114,8 @@ GET /-/chaos/db_spin?duration_s=50&async=true | `async` | boolean | no | Set to true to perform the operation in a Sidekiq background worker process | ```shell -curl http://localhost:3000/-/chaos/db_spin?interval_s=1&duration_s=60 --header 'X-Chaos-Secret: secret' -curl http://localhost:3000/-/chaos/db_spin?interval_s=1&duration_s=60&token=secret +curl "http://localhost:3000/-/chaos/db_spin?interval_s=1&duration_s=60" --header 'X-Chaos-Secret: secret' +curl "http://localhost:3000/-/chaos/db_spin?interval_s=1&duration_s=60&token=secret" ``` ## Sleep @@ -136,8 +136,8 @@ GET /-/chaos/sleep?duration_s=50&async=true | `async` | boolean | no | Set to true to sleep in a Sidekiq background worker process | ```shell -curl http://localhost:3000/-/chaos/sleep?duration_s=60 --header 'X-Chaos-Secret: secret' -curl http://localhost:3000/-/chaos/sleep?duration_s=60&token=secret +curl "http://localhost:3000/-/chaos/sleep?duration_s=60" --header 'X-Chaos-Secret: secret' +curl "http://localhost:3000/-/chaos/sleep?duration_s=60&token=secret" ``` ## Kill @@ -157,6 +157,6 @@ GET /-/chaos/kill?async=true | `async` | boolean | no | Set to true to kill a Sidekiq background worker process | ```shell -curl http://localhost:3000/-/chaos/kill --header 'X-Chaos-Secret: secret' -curl http://localhost:3000/-/chaos/kill?token=secret +curl "http://localhost:3000/-/chaos/kill" --header 'X-Chaos-Secret: secret' +curl "http://localhost:3000/-/chaos/kill?token=secret" ``` diff --git a/doc/development/gitaly.md b/doc/development/gitaly.md index 965284e5ae3..b885b8459e4 100644 --- a/doc/development/gitaly.md +++ b/doc/development/gitaly.md @@ -345,7 +345,7 @@ the integration by using GDK: 1. Check that the list of current metrics has the new counter for the feature flag: ```shell - curl --silent http://localhost:9236/metrics | grep go_find_all_tags + curl --silent "http://localhost:9236/metrics" | grep go_find_all_tags ``` 1. Once you observe the metrics for the new feature flag and it increments, you @@ -375,5 +375,5 @@ the integration by using GDK: 1. Verify the feature is on by observing the metrics for it: ```shell - curl --silent http://localhost:9236/metrics | grep go_find_all_tags + curl --silent "http://localhost:9236/metrics" | grep go_find_all_tags ``` diff --git a/doc/development/internal_api.md b/doc/development/internal_api.md index 8a955d539e0..4971e4d629d 100644 --- a/doc/development/internal_api.md +++ b/doc/development/internal_api.md @@ -60,7 +60,7 @@ POST /internal/allowed Example request: ```shell -curl --request POST --header "Gitlab-Shared-Secret: " --data "key_id=11&project=gnuwget/wget2&action=git-upload-pack&protocol=ssh" http://localhost:3001/api/v4/internal/allowed +curl --request POST --header "Gitlab-Shared-Secret: " --data "key_id=11&project=gnuwget/wget2&action=git-upload-pack&protocol=ssh" "http://localhost:3001/api/v4/internal/allowed" ``` Example response: @@ -108,7 +108,7 @@ information for LFS clients when the repository is accessed over SSH. Example request: ```shell -curl --request POST --header "Gitlab-Shared-Secret: " --data "key_id=11&project=gnuwget/wget2" http://localhost:3001/api/v4/internal/lfs_authenticate +curl --request POST --header "Gitlab-Shared-Secret: " --data "key_id=11&project=gnuwget/wget2" "http://localhost:3001/api/v4/internal/lfs_authenticate" ``` ```json @@ -141,7 +141,7 @@ GET /internal/authorized_keys Example request: ```shell -curl --request GET --header "Gitlab-Shared-Secret: ""http://localhost:3001/api/v4/internal/authorized_keys?key=" +curl --request GET --header "Gitlab-Shared-Secret: " "http://localhost:3001/api/v4/internal/authorized_keys?key=" ``` Example response: @@ -242,7 +242,7 @@ GET /internal/two_factor_recovery_codes Example request: ```shell -curl --request POST --header "Gitlab-Shared-Secret: " --data "key_id=7" http://localhost:3001/api/v4/internal/two_factor_recovery_codes +curl --request POST --header "Gitlab-Shared-Secret: " --data "key_id=7" "http://localhost:3001/api/v4/internal/two_factor_recovery_codes" ``` Example response: @@ -289,7 +289,7 @@ POST /internal/personal_access_token Example request: ```shell -curl --request POST --header "Gitlab-Shared-Secret: " --data "user_id=29&name=mytokenname&scopes[]=read_user&scopes[]=read_repository&expires_at=2020-07-24" http://localhost:3001/api/v4/internal/personal_access_token +curl --request POST --header "Gitlab-Shared-Secret: " --data "user_id=29&name=mytokenname&scopes[]=read_user&scopes[]=read_repository&expires_at=2020-07-24" "http://localhost:3001/api/v4/internal/personal_access_token" ``` Example response: @@ -323,7 +323,7 @@ POST /internal/pre_receive Example request: ```shell -curl --request POST --header "Gitlab-Shared-Secret: " --data "gl_repository=project-7" http://localhost:3001/api/v4/internal/pre_receive +curl --request POST --header "Gitlab-Shared-Secret: " --data "gl_repository=project-7" "http://localhost:3001/api/v4/internal/pre_receive" ``` Example response: @@ -355,7 +355,7 @@ POST /internal/post_receive Example Request: ```shell -curl --request POST --header "Gitlab-Shared-Secret: " --data "gl_repository=project-7" --data "identifier=user-1" --data "changes=0000000000000000000000000000000000000000 fd9e76b9136bdd9fe217061b497745792fe5a5ee gh-pages\n" http://localhost:3001/api/v4/internal/post_receive +curl --request POST --header "Gitlab-Shared-Secret: " --data "gl_repository=project-7" --data "identifier=user-1" --data "changes=0000000000000000000000000000000000000000 fd9e76b9136bdd9fe217061b497745792fe5a5ee gh-pages\n" "http://localhost:3001/api/v4/internal/post_receive" ``` Example response: diff --git a/doc/development/python_guide/index.md b/doc/development/python_guide/index.md index dc33db24980..adb73edd352 100644 --- a/doc/development/python_guide/index.md +++ b/doc/development/python_guide/index.md @@ -30,7 +30,7 @@ brew install pyenv To install `pyenv` on Linux, you can run the command below: ```shell -curl https://pyenv.run | bash +curl "https://pyenv.run" | bash ``` Alternatively, you may find `pyenv` available as a system package via your distro package manager. diff --git a/doc/install/installation.md b/doc/install/installation.md index c8148e29374..6bfd83fcddf 100644 --- a/doc/install/installation.md +++ b/doc/install/installation.md @@ -215,7 +215,7 @@ Download Ruby and compile it: ```shell mkdir /tmp/ruby && cd /tmp/ruby -curl --remote-name --progress https://cache.ruby-lang.org/pub/ruby/2.7/ruby-2.7.2.tar.gz +curl --remote-name --progress "https://cache.ruby-lang.org/pub/ruby/2.7/ruby-2.7.2.tar.gz" echo 'cb9731a17487e0ad84037490a6baf8bfa31a09e8 ruby-2.7.2.tar.gz' | shasum -c - && tar xzf ruby-2.7.2.tar.gz cd ruby-2.7.2 @@ -235,7 +235,7 @@ page](https://golang.org/dl). # Remove former Go installation folder sudo rm -rf /usr/local/go -curl --remote-name --progress https://dl.google.com/go/go1.13.5.linux-amd64.tar.gz +curl --remote-name --progress "https://dl.google.com/go/go1.13.5.linux-amd64.tar.gz" echo '512103d7ad296467814a6e3f635631bd35574cab3369a97a323c9a585ccaa569 go1.13.5.linux-amd64.tar.gz' | shasum -a256 -c - && \ sudo tar -C /usr/local -xzf go1.13.5.linux-amd64.tar.gz sudo ln -sf /usr/local/go/bin/{go,godoc,gofmt} /usr/local/bin/ @@ -257,10 +257,10 @@ we need to install through the following commands: ```shell # install node v12.x -curl --location https://deb.nodesource.com/setup_12.x | sudo bash - +curl --location "https://deb.nodesource.com/setup_12.x" | sudo bash - sudo apt-get install -y nodejs -curl --silent --show-error https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add - +curl --silent --show-error "https://dl.yarnpkg.com/debian/pubkey.gpg" | sudo apt-key add - echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list sudo apt-get update sudo apt-get install yarn diff --git a/doc/migrate_ci_to_ce/README.md b/doc/migrate_ci_to_ce/README.md index 4c1683670f8..16d3604cfa4 100644 --- a/doc/migrate_ci_to_ce/README.md +++ b/doc/migrate_ci_to_ce/README.md @@ -324,8 +324,8 @@ properly forward the requests.** You should also make sure that you can: -1. `curl https://YOUR_GITLAB_SERVER_FQDN/` from your previous GitLab CI server. -1. `curl https://YOUR_CI_SERVER_FQDN/` from your GitLab CE (or EE) server. +1. `curl "https://YOUR_GITLAB_SERVER_FQDN/"` from your previous GitLab CI server. +1. `curl "https://YOUR_CI_SERVER_FQDN/"` from your GitLab CE (or EE) server. ### 2. Check NGINX configuration diff --git a/doc/topics/autodevops/customize.md b/doc/topics/autodevops/customize.md index 0e662e84f7a..210ee8a7248 100644 --- a/doc/topics/autodevops/customize.md +++ b/doc/topics/autodevops/customize.md @@ -662,5 +662,5 @@ The banner can be disabled for: - Through the REST API with an admin access token: ```shell - curl --data "value=true" --header "PRIVATE-TOKEN: " https://gitlab.example.com/api/v4/features/auto_devops_banner_disabled + curl --data "value=true" --header "PRIVATE-TOKEN: " "https://gitlab.example.com/api/v4/features/auto_devops_banner_disabled" ``` diff --git a/doc/topics/web_application_firewall/quick_start_guide.md b/doc/topics/web_application_firewall/quick_start_guide.md index 03b252a0700..d9f8b3e7bdc 100644 --- a/doc/topics/web_application_firewall/quick_start_guide.md +++ b/doc/topics/web_application_firewall/quick_start_guide.md @@ -201,7 +201,7 @@ your cluster either using [Cloud Shell](https://cloud.google.com/shell/) or the NAME HOSTS PORTS production-auto-deploy fjdiaz-auto-devv-2.34.68.60.207.nip.io,le-16730183.34.68.60.207.nip.io 80, 443 - $ curl --location --insecure fjdiaz-auto-devv-2.34.68.60.207.nip.io | grep 'Rails!' --after 2 --before 2 + $ curl --location --insecure "fjdiaz-auto-devv-2.34.68.60.207.nip.io" | grep 'Rails!' --after 2 --before 2

You're on Rails!

@@ -216,7 +216,7 @@ Now let's send a potentially malicious request, as if we were a scanner, checking for vulnerabilities within our application and examine the ModSecurity logs: ```shell -$ curl --location --insecure fjdiaz-auto-devv-2.34.68.60.207.nip.io --header "User-Agent: absinthe" | grep 'Rails!' --after 2 --before 2 +$ curl --location --insecure "fjdiaz-auto-devv-2.34.68.60.207.nip.io" --header "User-Agent: absinthe" | grep 'Rails!' --after 2 --before 2

You're on Rails!

diff --git a/doc/update/upgrading_from_source.md b/doc/update/upgrading_from_source.md index 2c8a8c3dda4..eb3a85a257f 100644 --- a/doc/update/upgrading_from_source.md +++ b/doc/update/upgrading_from_source.md @@ -70,7 +70,7 @@ Download Ruby and compile it: ```shell mkdir /tmp/ruby && cd /tmp/ruby -curl --remote-name --progress https://cache.ruby-lang.org/pub/ruby/2.7/ruby-2.7.2.tar.gz +curl --remote-name --progress "https://cache.ruby-lang.org/pub/ruby/2.7/ruby-2.7.2.tar.gz" echo 'cb9731a17487e0ad84037490a6baf8bfa31a09e8 ruby-2.7.2.tar.gz' | shasum -c - && tar xzf ruby-2.7.2.tar.gz cd ruby-2.7.2 @@ -89,7 +89,7 @@ dependencies. In Debian or Ubuntu: ```shell -curl --silent --show-error https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add - +curl --silent --show-error "https://dl.yarnpkg.com/debian/pubkey.gpg" | sudo apt-key add - echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list sudo apt-get update sudo apt-get install yarn @@ -109,7 +109,7 @@ Download and install Go (for Linux, 64-bit): # Remove former Go installation folder sudo rm -rf /usr/local/go -curl --remote-name --progress https://dl.google.com/go/go1.13.5.linux-amd64.tar.gz +curl --remote-name --progress "https://dl.google.com/go/go1.13.5.linux-amd64.tar.gz" echo '512103d7ad296467814a6e3f635631bd35574cab3369a97a323c9a585ccaa569 go1.13.5.linux-amd64.tar.gz' | shasum -a256 -c - && \ sudo tar -C /usr/local -xzf go1.13.5.linux-amd64.tar.gz sudo ln -sf /usr/local/go/bin/{go,godoc,gofmt} /usr/local/bin/ @@ -139,7 +139,7 @@ sudo apt-get remove git-core sudo apt-get install -y libcurl4-openssl-dev libexpat1-dev gettext libz-dev libssl-dev build-essential # Download and compile pcre2 from source -curl --silent --show-error --location https://ftp.pcre.org/pub/pcre/pcre2-10.33.tar.gz --output pcre2.tar.gz +curl --silent --show-error --location "https://ftp.pcre.org/pub/pcre/pcre2-10.33.tar.gz" --output pcre2.tar.gz tar -xzf pcre2.tar.gz cd pcre2-10.33 chmod +x configure @@ -149,7 +149,7 @@ make install # Download and compile from source cd /tmp -curl --remote-name --location --progress https://www.kernel.org/pub/software/scm/git/git-2.29.0.tar.gz +curl --remote-name --location --progress "https://www.kernel.org/pub/software/scm/git/git-2.29.0.tar.gz" echo 'fa08dc8424ef80c0f9bf307877f9e2e49f1a6049e873530d6747c2be770742ff git-2.29.0.tar.gz' | shasum -a256 -c - && tar -xzf git-2.29.0.tar.gz cd git-2.29.0/ ./configure --with-libpcre diff --git a/doc/user/admin_area/license.md b/doc/user/admin_area/license.md index 1e2fb51dfed..d7710c362e5 100644 --- a/doc/user/admin_area/license.md +++ b/doc/user/admin_area/license.md @@ -32,7 +32,7 @@ is locked. ## Uploading your license -The very first time you visit your GitLab EE installation signed in as an admin, +The very first time you visit your GitLab EE installation signed in as an administrator, you should see a note urging you to upload a license with a link that takes you to **Admin Area > License**. @@ -94,13 +94,13 @@ You can review the license details at any time in the **License** section of the ## Notification before the license expires One month before the license expires, a message informing about the expiration -date is displayed to GitLab admins. Make sure that you update your +date is displayed to GitLab administrators. Make sure that you update your license, otherwise you miss all the paid features if your license expires. ## What happens when your license expires In case your license expires, GitLab locks down some features like Git pushes, -and issue creation, and displays a message to all admins to inform of the expired license. +and issue creation, and displays a message to all administrators to inform of the expired license. To get back all the previous functionality, you must upload a new license. To fall back to having only the Core features active, you must delete the diff --git a/doc/user/admin_area/monitoring/health_check.md b/doc/user/admin_area/monitoring/health_check.md index 01a172fc0d1..3c08a330b13 100644 --- a/doc/user/admin_area/monitoring/health_check.md +++ b/doc/user/admin_area/monitoring/health_check.md @@ -55,7 +55,7 @@ GET /-/health Example request: ```shell -curl 'https://gitlab.example.com/-/health' +curl "https://gitlab.example.com/-/health" ``` Example response: @@ -82,7 +82,7 @@ GET /-/readiness?all=1 Example request: ```shell -curl 'https://gitlab.example.com/-/readiness' +curl "https://gitlab.example.com/-/readiness" ``` Example response: @@ -121,7 +121,7 @@ GET /-/liveness Example request: ```shell -curl 'https://gitlab.example.com/-/liveness' +curl "https://gitlab.example.com/-/liveness" ``` Example response: diff --git a/doc/user/packages/container_registry/index.md b/doc/user/packages/container_registry/index.md index 3e794de22ae..7bef737aeed 100644 --- a/doc/user/packages/container_registry/index.md +++ b/doc/user/packages/container_registry/index.md @@ -577,7 +577,7 @@ Examples: - Select all tags, keep at least 1 tag per image, clean up any tag older than 14 days, run once a month, preserve any images with the name `master` and the policy is enabled: ```shell - curl --request PUT --header 'Content-Type: application/json;charset=UTF-8' --header "PRIVATE-TOKEN: " --data-binary '{"container_expiration_policy_attributes":{"cadence":"1month","enabled":true,"keep_n":1,"older_than":"14d","name_regex":"","name_regex_delete":".*","name_regex_keep":".*-master"}}' 'https://gitlab.example.com/api/v4/projects/2' + curl --request PUT --header 'Content-Type: application/json;charset=UTF-8' --header "PRIVATE-TOKEN: " --data-binary '{"container_expiration_policy_attributes":{"cadence":"1month","enabled":true,"keep_n":1,"older_than":"14d","name_regex":"","name_regex_delete":".*","name_regex_keep":".*-master"}}' "https://gitlab.example.com/api/v4/projects/2" ``` See the API documentation for further details: [Edit project](../../../api/projects.md#edit-project). diff --git a/doc/user/packages/generic_packages/index.md b/doc/user/packages/generic_packages/index.md index 480d1d2f20d..e934356e01d 100644 --- a/doc/user/packages/generic_packages/index.md +++ b/doc/user/packages/generic_packages/index.md @@ -49,7 +49,7 @@ Example request: ```shell curl --header "PRIVATE-TOKEN: " \ --upload-file path/to/file.txt \ - https://gitlab.example.com/api/v4/projects/24/packages/generic/my_package/0.0.1/file.txt + "https://gitlab.example.com/api/v4/projects/24/packages/generic/my_package/0.0.1/file.txt" ``` Example response: @@ -85,7 +85,7 @@ Example request that uses a personal access token: ```shell curl --header "PRIVATE-TOKEN: " \ - https://gitlab.example.com/api/v4/projects/24/packages/generic/my_package/0.0.1/file.txt + "https://gitlab.example.com/api/v4/projects/24/packages/generic/my_package/0.0.1/file.txt" ``` ## Publish a generic package by using CI/CD @@ -105,7 +105,7 @@ stages: upload: stage: upload script: - - 'curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file path/to/file.txt ${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/generic/my_package/0.0.1/file.txt' + - 'curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file path/to/file.txt "${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/generic/my_package/0.0.1/file.txt"' download: stage: download diff --git a/doc/user/project/clusters/serverless/aws.md b/doc/user/project/clusters/serverless/aws.md index 6406d1fb7e4..a52d3400aa2 100644 --- a/doc/user/project/clusters/serverless/aws.md +++ b/doc/user/project/clusters/serverless/aws.md @@ -157,7 +157,7 @@ Running the following `curl` command should trigger your function. Your URL should be the one retrieved from the GitLab deploy stage log: ```shell -curl https://u768nzby1j.execute-api.us-east-1.amazonaws.com/production/hello +curl "https://u768nzby1j.execute-api.us-east-1.amazonaws.com/production/hello" ``` That should output: @@ -200,7 +200,7 @@ The `serverless-offline` plugin allows to run your code locally. To run your cod Running the following `curl` command should trigger your function. ```shell -curl http://localhost:3000/hello +curl "http://localhost:3000/hello" ``` It should output: @@ -444,7 +444,7 @@ To test the application you deployed, please go to the build log and follow the 1. Use curl to test the API. For example: ```shell - curl https://py4rg7qtlg.execute-api.us-east-1.amazonaws.com/Prod/hello/ + curl "https://py4rg7qtlg.execute-api.us-east-1.amazonaws.com/Prod/hello/" ``` Output should be: @@ -496,7 +496,7 @@ listening on `localhost:3000`. Call the `hello` API by running: ```shell -curl http://127.0.0.1:3000/hello +curl "http://127.0.0.1:3000/hello" ``` Output again should be: diff --git a/doc/user/project/clusters/serverless/index.md b/doc/user/project/clusters/serverless/index.md index a7314d544e1..8a87e5cb697 100644 --- a/doc/user/project/clusters/serverless/index.md +++ b/doc/user/project/clusters/serverless/index.md @@ -376,7 +376,7 @@ The sample function can now be triggered from any HTTP client using a simple `PO --header "Content-Type: application/json" \ --request POST \ --data '{"GitLab":"FaaS"}' \ - http://functions-echo.functions-1.functions.example.com/ + "http://functions-echo.functions-1.functions.example.com/" ``` 1. Using a web-based tool (such as Postman or Restlet) @@ -443,7 +443,7 @@ To run a function locally: 1. Invoke your function: ```shell - curl http://localhost:8080 + curl "http://localhost:8080" ``` ## Deploying Serverless applications