Commit 6d951cef authored by Evan Read's avatar Evan Read

Merge branch 'vale-backtick-fences-rule' into 'master'

Add vale rule for codeblock fences

Closes #218321

See merge request gitlab-org/gitlab!32497
parents 632b3838 a571687e
# Ensures all codeblock fences use the full name for the language.
#
# For a list of all options, see https://errata-ai.github.io/vale/styles/
extends: existence
message: 'Syntax highlighting hint "%s" must be one of: yaml, ruby, plaintext, markdown, javascript, shell, golang, python, dockerfile, or typescript.'
link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#code-blocks
level: error
scope: raw
raw:
- '\`\`\`(yml|rb|text|md|bash|sh\n|js\n|go\n|py\n|docker\n|ts)'
...@@ -298,7 +298,7 @@ POST /groups/:id/members/:user_id/override ...@@ -298,7 +298,7 @@ POST /groups/:id/members/:user_id/override
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user | | `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user |
| `user_id` | integer | yes | The user ID of the member | | `user_id` | integer | yes | The user ID of the member |
```bash ```shell
curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/groups/:id/members/:user_id/override curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/groups/:id/members/:user_id/override
``` ```
...@@ -334,7 +334,7 @@ DELETE /groups/:id/members/:user_id/override ...@@ -334,7 +334,7 @@ DELETE /groups/:id/members/:user_id/override
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user | | `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user |
| `user_id` | integer | yes | The user ID of the member | | `user_id` | integer | yes | The user ID of the member |
```bash ```shell
curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/groups/:id/members/:user_id/override curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v4/groups/:id/members/:user_id/override
``` ```
......
...@@ -43,7 +43,7 @@ GET /projects/:id/vulnerabilities ...@@ -43,7 +43,7 @@ GET /projects/:id/vulnerabilities
| ------------- | -------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ------------- | -------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `id` | integer or string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user. | | `id` | integer or string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user. |
```bash ```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/4/vulnerabilities curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/4/vulnerabilities
``` ```
......
...@@ -260,7 +260,7 @@ easier to debug. ...@@ -260,7 +260,7 @@ easier to debug.
For example: For example:
```go ```golang
// Wrap the error // Wrap the error
return nil, fmt.Errorf("get cache %s: %w", f.Name, err) return nil, fmt.Errorf("get cache %s: %w", f.Name, err)
......
...@@ -21,7 +21,7 @@ Pinning tests help you ensure that you don't unintentionally change the output o ...@@ -21,7 +21,7 @@ Pinning tests help you ensure that you don't unintentionally change the output o
Leaving in the commits for adding and removing pins helps others checkout and verify the result of the test. Leaving in the commits for adding and removing pins helps others checkout and verify the result of the test.
```bash ```shell
AAAAAA Add pinning tests to funky_foo AAAAAA Add pinning tests to funky_foo
BBBBBB Refactor funky_foo into nice_foo BBBBBB Refactor funky_foo into nice_foo
CCCCCC Remove pinning tests for funky_foo CCCCCC Remove pinning tests for funky_foo
...@@ -31,13 +31,13 @@ Then you can leave a reviewer instructions on how to run the pinning test in you ...@@ -31,13 +31,13 @@ Then you can leave a reviewer instructions on how to run the pinning test in you
> First revert the commit which removes the pin. > First revert the commit which removes the pin.
> >
> ```bash > ```shell
> git revert --no-commit $(git log -1 --grep="Remove pinning test for funky_foo" --pretty=format:"%H") > git revert --no-commit $(git log -1 --grep="Remove pinning test for funky_foo" --pretty=format:"%H")
> ``` > ```
> >
> Then run the test > Then run the test
> >
> ```bash > ```shell
> yarn run jest path/to/funky_foo_pin_spec.js > yarn run jest path/to/funky_foo_pin_spec.js
> ``` > ```
......
...@@ -600,7 +600,7 @@ sudo cp -R /etc/ssh/* /etc/ssh_static ...@@ -600,7 +600,7 @@ sudo cp -R /etc/ssh/* /etc/ssh_static
In `/etc/ssh/sshd_config` update the following: In `/etc/ssh/sshd_config` update the following:
```bash ```shell
# HostKeys for protocol version 2 # HostKeys for protocol version 2
HostKey /etc/ssh_static/ssh_host_rsa_key HostKey /etc/ssh_static/ssh_host_rsa_key
HostKey /etc/ssh_static/ssh_host_dsa_key HostKey /etc/ssh_static/ssh_host_dsa_key
......
...@@ -24,7 +24,7 @@ Banners are shown on the top of a page and in Git remote responses. ...@@ -24,7 +24,7 @@ Banners are shown on the top of a page and in Git remote responses.
![Broadcast Message Banner](img/broadcast_messages_banner_v12_10.png) ![Broadcast Message Banner](img/broadcast_messages_banner_v12_10.png)
```bash ```shell
$ git push $ git push
... ...
remote: remote:
......
...@@ -543,23 +543,23 @@ ensure that it can reach your private repository. Here is an example configurati ...@@ -543,23 +543,23 @@ ensure that it can reach your private repository. Here is an example configurati
1. Update `setup.py` to create a `dependency_links` attribute pointing at your private repository for each 1. Update `setup.py` to create a `dependency_links` attribute pointing at your private repository for each
dependency in the `install_requires` list: dependency in the `install_requires` list:
```python ```python
install_requires=['pyparsing>=2.0.3'], install_requires=['pyparsing>=2.0.3'],
dependency_links=['https://pypi.example.com/simple/pyparsing'], dependency_links=['https://pypi.example.com/simple/pyparsing'],
``` ```
1. Fetch the certificate from your repository URL and add it to the project: 1. Fetch the certificate from your repository URL and add it to the project:
```bash ```shell
echo -n | openssl s_client -connect pypi.example.com:443 | sed -ne '/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p' > internal.crt echo -n | openssl s_client -connect pypi.example.com:443 | sed -ne '/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p' > internal.crt
``` ```
1. Point `setup.py` at the newly downloaded certificate: 1. Point `setup.py` at the newly downloaded certificate:
```python ```python
import setuptools.ssl_support import setuptools.ssl_support
setuptools.ssl_support.cert_paths = ['internal.crt'] setuptools.ssl_support.cert_paths = ['internal.crt']
``` ```
## Limitations ## Limitations
......
...@@ -1157,7 +1157,7 @@ GitLab provides [Invocation Metrics](../project/clusters/serverless/index.md#inv ...@@ -1157,7 +1157,7 @@ GitLab provides [Invocation Metrics](../project/clusters/serverless/index.md#inv
1. Knative and Prometheus managed applications installed on your cluster. 1. Knative and Prometheus managed applications installed on your cluster.
1. Manually applied the custom metrics on your cluster by running the following command: 1. Manually applied the custom metrics on your cluster by running the following command:
```bash ```shell
kubectl apply -f https://gitlab.com/gitlab-org/cluster-integration/cluster-applications/-/raw/02c8231e30ef5b6725e6ba368bc63863ceb3c07d/src/default-data/knative/istio-metrics.yaml kubectl apply -f https://gitlab.com/gitlab-org/cluster-integration/cluster-applications/-/raw/02c8231e30ef5b6725e6ba368bc63863ceb3c07d/src/default-data/knative/istio-metrics.yaml
``` ```
...@@ -1166,7 +1166,7 @@ GitLab provides [Invocation Metrics](../project/clusters/serverless/index.md#inv ...@@ -1166,7 +1166,7 @@ GitLab provides [Invocation Metrics](../project/clusters/serverless/index.md#inv
To uninstall Knative, you must first manually remove any custom metrics you have added To uninstall Knative, you must first manually remove any custom metrics you have added
by running the following command: by running the following command:
```bash ```shell
kubectl delete -f https://gitlab.com/gitlab-org/cluster-integration/cluster-applications/-/raw/02c8231e30ef5b6725e6ba368bc63863ceb3c07d/src/default-data/knative/istio-metrics.yaml kubectl delete -f https://gitlab.com/gitlab-org/cluster-integration/cluster-applications/-/raw/02c8231e30ef5b6725e6ba368bc63863ceb3c07d/src/default-data/knative/istio-metrics.yaml
``` ```
......
...@@ -339,7 +339,7 @@ setting to specify its location. ...@@ -339,7 +339,7 @@ setting to specify its location.
For example: For example:
```text ```plaintext
npmRegistryServer: "https://npm.example.com" npmRegistryServer: "https://npm.example.com"
``` ```
......
...@@ -44,7 +44,7 @@ terraform { ...@@ -44,7 +44,7 @@ terraform {
Finally, you need to run `terraform init` on your local machine and pass in the following options. The below example is using GitLab.com: Finally, you need to run `terraform init` on your local machine and pass in the following options. The below example is using GitLab.com:
```bash ```shell
terraform init \ terraform init \
-backend-config="address=https://gitlab.com/api/v4/projects/<YOUR-PROJECT-ID>/terraform/state/<YOUR-PROJECT-NAME>" \ -backend-config="address=https://gitlab.com/api/v4/projects/<YOUR-PROJECT-ID>/terraform/state/<YOUR-PROJECT-NAME>" \
-backend-config="lock_address=https://gitlab.com/api/v4/projects/<YOUR-PROJECT-ID>/terraform/state/<YOUR-PROJECT-NAME>/lock" \ -backend-config="lock_address=https://gitlab.com/api/v4/projects/<YOUR-PROJECT-ID>/terraform/state/<YOUR-PROJECT-NAME>/lock" \
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment