Commit 882e00df authored by Marcel Amirault's avatar Marcel Amirault

Merge branch 'docs-fix-yaml-dev-docs' into 'master'

Update development docs yaml code blocks

See merge request gitlab-org/gitlab!41860
parents b4570697 d0974716
...@@ -23,9 +23,9 @@ For more information on the database review process, check the [database review ...@@ -23,9 +23,9 @@ For more information on the database review process, check the [database review
Team members are encouraged to self-identify as database domain experts and add it to their [team profile](https://gitlab.com/gitlab-com/www-gitlab-com/-/blob/master/data/team.yml) Team members are encouraged to self-identify as database domain experts and add it to their [team profile](https://gitlab.com/gitlab-com/www-gitlab-com/-/blob/master/data/team.yml)
```yaml ```yaml
projects: projects:
gitlab: gitlab:
- reviewer database - reviewer database
``` ```
Assign the MR which adds your expertise to the `team.yml` file to a database maintainer Assign the MR which adds your expertise to the `team.yml` file to a database maintainer
...@@ -70,9 +70,9 @@ they can update their [team profile](https://gitlab.com/gitlab-com/www-gitlab-co ...@@ -70,9 +70,9 @@ they can update their [team profile](https://gitlab.com/gitlab-com/www-gitlab-co
to a `trainee_maintainer database`: to a `trainee_maintainer database`:
```yaml ```yaml
projects: projects:
gitlab: gitlab:
- trainee_maintainer database - trainee_maintainer database
``` ```
The first step is to a create a [Trainee Database Maintainer Issue](https://gitlab.com/gitlab-com/www-gitlab-com/-/issues/new?issuable_template=trainee-database-maintainer). The first step is to a create a [Trainee Database Maintainer Issue](https://gitlab.com/gitlab-com/www-gitlab-com/-/issues/new?issuable_template=trainee-database-maintainer).
......
...@@ -2155,7 +2155,7 @@ We store our Table of Contents in the `default-nav.yaml` file, in the ...@@ -2155,7 +2155,7 @@ We store our Table of Contents in the `default-nav.yaml` file, in the
following line: following line:
```yaml ```yaml
- category_title: GraphQL - category_title: GraphQL
``` ```
Be aware that CI tests for that second MR will fail with a bad link until the Be aware that CI tests for that second MR will fail with a bad link until the
......
...@@ -147,7 +147,7 @@ request must also include the SHA256 sum of the file. An example JWT ...@@ -147,7 +147,7 @@ request must also include the SHA256 sum of the file. An example JWT
payload looks like: payload looks like:
```yaml ```yaml
{ "data": { sha256: "31806bb23580caab78040f8c45d329f5016b0115" }, iat: "1234567890" } {"data": {sha256: "31806bb23580caab78040f8c45d329f5016b0115"}, iat: "1234567890"}
``` ```
If the requested file matches the requested SHA256 sum, then the Geo If the requested file matches the requested SHA256 sum, then the Geo
......
...@@ -244,7 +244,7 @@ project_tree: ...@@ -244,7 +244,7 @@ project_tree:
- :push_event_payload - :push_event_payload
- issues: - issues:
- events: - events:
- ... # ...
``` ```
Only include the following attributes for the models specified: Only include the following attributes for the models specified:
...@@ -254,8 +254,7 @@ included_attributes: ...@@ -254,8 +254,7 @@ included_attributes:
user: user:
- :id - :id
- :email - :email
... # ...
``` ```
Do not include the following attributes for the models specified: Do not include the following attributes for the models specified:
......
...@@ -65,7 +65,7 @@ shell check: ...@@ -65,7 +65,7 @@ shell check:
before_script: before_script:
- shellcheck --version - shellcheck --version
script: script:
- shellcheck scripts/**/*.sh # path to your shell scripts - shellcheck scripts/**/*.sh # path to your shell scripts
``` ```
TIP: **Tip:** TIP: **Tip:**
...@@ -93,7 +93,7 @@ shfmt: ...@@ -93,7 +93,7 @@ shfmt:
before_script: before_script:
- shfmt -version - shfmt -version
script: script:
- shfmt -i 2 -ci -d scripts # path to your shell scripts - shfmt -i 2 -ci -d scripts # path to your shell scripts
``` ```
TIP: **Tip:** TIP: **Tip:**
......
...@@ -236,7 +236,7 @@ Implemented using Redis methods [PFADD](https://redis.io/commands/pfadd) and [PF ...@@ -236,7 +236,7 @@ Implemented using Redis methods [PFADD](https://redis.io/commands/pfadd) and [PF
- name: i_compliance_credential_inventory - name: i_compliance_credential_inventory
category: compliance category: compliance
redis_slot: compliance redis_slot: compliance
expiry: 42 # 6 weeks expiry: 42 # 6 weeks
aggregation: weekly aggregation: weekly
``` ```
......
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