Skip to content

Commit d37c0fa

Browse files
committed
Refresh Vale rules and link checking Docker image
1 parent c913c19 commit d37c0fa

File tree

11 files changed

+46
-41
lines changed

11 files changed

+46
-41
lines changed
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
# Error: gitlab.CommandStringsQuoted
3+
#
4+
# Ensures all code blocks wrap URL strings in quotation marks.
5+
#
6+
# For a list of all options, see https://vale.sh/docs/topics/styles/
7+
extends: existence
8+
message: "For the command example, use double quotes around the URL: %s"
9+
link: https://docs.gitlab.com/ee/development/documentation/restful_api_styleguide.html#curl-commands
10+
level: error
11+
scope: raw
12+
nonword: true
13+
tokens:
14+
- '(curl|--url)[^"\]\n]+?https?:\/\/[^ \n]*'

doc/.vale/gitlab/CurlStringsQuoted.yml

Lines changed: 0 additions & 13 deletions
This file was deleted.

doc/.vale/gitlab/HeadingContent.yml

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,13 @@
77
extends: existence
88
message: "Rename the heading '%s', or re-purpose the content elsewhere."
99
level: warning
10-
scope: heading
1110
link: https://docs.gitlab.com/ee/development/documentation/topic_types/concept.html#concept-headings
12-
ignorecase: false
11+
ignorecase: true
12+
nonword: true
13+
scope: raw
1314
tokens:
14-
- How it works
15-
- Limitations
16-
- Overview
17-
- Use cases?
18-
- Important notes?
15+
- '\#+ How it works'
16+
- '\#+ Limitations'
17+
- '\#+ Overview'
18+
- '\#+ Use cases?'
19+
- '\#+ Important notes?'

doc/.vale/gitlab/Markdown_emoji.yml

Lines changed: 0 additions & 13 deletions
This file was deleted.

doc/.vale/gitlab/MeaningfulLinkWords.yml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,12 @@
55
#
66
# For a list of all options, see https://vale.sh/docs/topics/styles/
77
extends: existence
8-
message: "Improve SEO and accessibility by rewriting '%s' in the link text."
8+
message: "Improve SEO and accessibility by rewriting the link text for '%s'."
99
level: warning
10-
scope: link
1110
ignorecase: true
1211
link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#text-for-links
12+
scope: raw
13+
nonword: true
1314
tokens:
14-
- here
15-
- this page
15+
- \[here\]\(.*\)
16+
- \[this page\]\(.*\)

doc/.vale/gitlab/SubstitutionWarning.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,18 +18,27 @@ swap:
1818
click: "select"
1919
code base: "codebase"
2020
config: "configuration"
21+
confirmation box: "confirmation dialog"
22+
confirmation dialog box: "confirmation dialog"
2123
deselect: "clear"
2224
deselected: "cleared"
25+
dialog box: "dialog"
2326
distro: "distribution"
2427
docs: "documentation"
2528
e-mail: "email"
29+
emojis: "emoji"
2630
ex: "for example"
2731
file name: "filename"
2832
filesystem: "file system"
2933
info: "information"
34+
installation from source: self-compiled installation
35+
installations from source: self-compiled installations
3036
it is recommended: "you should"
3137
logged in user: "authenticated user"
3238
logged-in user: "authenticated user"
39+
modal dialog: "dialog"
40+
modal window: "dialog"
41+
modal: "dialog"
3342
n/a: "not applicable"
3443
navigate to: "go to"
3544
OAuth2: "OAuth 2.0"
@@ -38,10 +47,15 @@ swap:
3847
once that: "after that"
3948
once the: "after the"
4049
once you: "after you"
50+
pop-up window: "dialog"
51+
pop-up: "dialog"
52+
popup: "dialog"
4153
repo: "repository"
4254
signed in user: "authenticated user"
4355
signed-in user: "authenticated user"
4456
since: "because' or 'after"
57+
source (?:install|installation): self-compiled installation
58+
source (?:installs|installations): self-compiled installations
4559
sub-group: "subgroup"
4660
sub-groups: "subgroups"
4761
timezone: "time zone"

doc/.vale/gitlab/Wordy.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.
1010
level: suggestion
1111
ignorecase: true
1212
swap:
13+
as well as: "Use 'and' instead of 'as well as'."
1314
note that: "Remove the phrase 'note that'."
1415
please: "Use 'please' only if we've inconvenienced the user."
1516
respectively: "Remove 'respectively' and list each option instead."

doc/.vale/gitlab/spelling-exceptions.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -995,7 +995,7 @@ tcpdump
995995
teardown
996996
templated
997997
Thanos
998-
Thoughtbot
998+
thoughtbot
999999
throughputs
10001000
Tiller
10011001
timebox

doc/development/setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
66

77
# Set up your development environment
88

9-
Development of Omnibus GitLab can be done using an existing package available
9+
Development of the Linux package can be done using an existing package available
1010
from the [Downloads page](https://about.gitlab.com/install/). To know how to setup
1111
a build environment to build these packages and use them, please read
1212
[Setting up a Build Environment](../build/build_package.md#prepare-a-build-environment)

doc/troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -982,7 +982,7 @@ local mirror that are no longer present in the corresponding GitLab repository.
982982

983983
```shell
984984
pulp rpm repository create --retain-package-versions=1 --name "gitlab-ee"
985-
pulp rpm remote create --name gitlab-ee --url http://mirror.example.com/repos/gitlab_gitlab-ee/ --policy immediate
985+
pulp rpm remote create --name gitlab-ee --url "http://mirror.example.com/repos/gitlab_gitlab-ee/" --policy immediate
986986
pulp rpm repository update --name gitlab-ee --remote gitlab-ee
987987
```
988988

0 commit comments

Comments
 (0)