Commit 8fdad3ab authored by Marcel Amirault's avatar Marcel Amirault

Merge branch 'docs-improve-styleguide-.gitlab.yml' into 'master'

Docs: improve documentation example in styleguide

See merge request gitlab-org/gitlab!51039
parents bb3b021d 3862bcad
...@@ -207,9 +207,9 @@ Some examples fail if incorrect capitalization is used: ...@@ -207,9 +207,9 @@ Some examples fail if incorrect capitalization is used:
Additionally, commands, parameters, values, filenames, and so on must be Additionally, commands, parameters, values, filenames, and so on must be
included in backticks. For example: included in backticks. For example:
- "Change the `needs` keyword in your `.gitlab.yml`..." - "Change the `needs` keyword in your `.gitlab-ci.yml`..."
- `needs` is a parameter, and `.gitlab.yml` is a file, so both need backticks. - `needs` is a parameter, and `.gitlab-ci.yml` is a file, so both need backticks.
Additionally, `.gitlab.yml` without backticks fails markdownlint because it Additionally, `.gitlab-ci.yml` without backticks fails markdownlint because it
does not have capital G or L. does not have capital G or L.
- "Run `git clone` to clone a Git repository..." - "Run `git clone` to clone a Git repository..."
- `git clone` is a command, so it must be lowercase, while Git is the product, - `git clone` is a command, so it must be lowercase, while Git is the product,
......
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