From b3bb796191a5e5e1987a773fc3c2a8140abaf96c Mon Sep 17 00:00:00 2001
From: Evan Read <eread@gitlab.com>
Date: Wed, 6 May 2020 15:08:18 +1000
Subject: [PATCH] Enforce capitalization of TOML and YAML
---
.markdownlint.json | 2 ++
doc/ci/large_repositories/index.md | 6 +++---
doc/development/documentation/styleguide.md | 2 +-
3 files changed, 6 insertions(+), 4 deletions(-)
diff --git a/.markdownlint.json b/.markdownlint.json
index 1ad75f229f47..ddf5105d7f27 100644
--- a/.markdownlint.json
+++ b/.markdownlint.json
@@ -116,6 +116,7 @@
"SMTP",
"SSH",
"Tiller",
+ "TOML",
"Trello",
"Trello Power-Ups",
"TypeScript",
@@ -125,6 +126,7 @@
"Unicorn",
"unicorn-worker-killer",
"WebdriverIO",
+ "YAML",
"YouTrack"
],
"code_blocks": false
diff --git a/doc/ci/large_repositories/index.md b/doc/ci/large_repositories/index.md
index 6ac3fa2c92d6..b4059fc252bb 100644
--- a/doc/ci/large_repositories/index.md
+++ b/doc/ci/large_repositories/index.md
@@ -130,7 +130,7 @@ other using `docker` executor.
### `shell` executor example
-Let's assume that you have the following [config.toml](https://docs.gitlab.com/runner/configuration/advanced-configuration.html).
+Let's assume that you have the following [`config.toml`](https://docs.gitlab.com/runner/configuration/advanced-configuration.html).
```toml
concurrent = 4
@@ -155,7 +155,7 @@ This `config.toml`:
### `docker` executor example
-Let's assume that you have the following [config.toml](https://docs.gitlab.com/runner/configuration/advanced-configuration.html).
+Let's assume that you have the following [`config.toml`](https://docs.gitlab.com/runner/configuration/advanced-configuration.html).
```toml
concurrent = 4
@@ -216,7 +216,7 @@ but this brings administrative overhead as the `.gitlab-ci.yml` needs to be upda
In such cases, it might be desirable to keep the `.gitlab-ci.yml` clone path agnostic, but make it
a configuration of Runner.
-We can extend our [config.toml](https://docs.gitlab.com/runner/configuration/advanced-configuration.html)
+We can extend our [`config.toml`](https://docs.gitlab.com/runner/configuration/advanced-configuration.html)
with the following specification that will be used by Runner if `.gitlab-ci.yml` will not override it:
```toml
diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md
index e478234df1d9..34ec8c097088 100644
--- a/doc/development/documentation/styleguide.md
+++ b/doc/development/documentation/styleguide.md
@@ -1008,7 +1008,7 @@ of language classes available.
| `ruby` | Alias: `rb`. |
| `shell` | Aliases: `bash` or `sh`. |
| `sql` | |
-| `toml` | Runner configuration examples, and other toml formatted configuration files. |
+| `toml` | Runner configuration examples, and other TOML-formatted configuration files. |
| `typescript` | Alias: `ts`. |
| `xml` | |
| `yaml` | Alias: `yml`. |
--
GitLab