Skip to content

Commit f6b1799

Browse files
RoRoJRoRoJ
authored
feat(docs): added vale styles (#391)
* feat(vale): added vale rules * fix(vale): rules tweaks * feat(docs): continued working on vale styles * feat(docs): continued adding console terms * feat(docs): finished first round of vale linter styles * fix(vale): links * feat(docs): made vale blank templates
1 parent 190604c commit f6b1799

21 files changed

+492
-4
lines changed

‎.vale.ini

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
StylesPath = ./styles
2-
MinAlertLevel = warning
2+
MinAlertLevel = suggestion
33

44
Vocab = Scaleway
55

66
[formats]
77
mdx = md
88

99
[*.md]
10-
BasedOnStyles = Vale, write-good
10+
BasedOnStyles = Vale, scw_styles

‎styles/Microsoft/Accessibility.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,4 @@ tokens:
2323
- sight-impaired
2424
- stricken with
2525
- suffers from
26-
- vision-impaired
26+
- vision-impaired

‎styles/Vocab/Scaleway/accept.txt

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,5 @@ GitHub
33
Quickstarts
44
[fF]rontmatters
55
licensor
6-
[eE]arly Access
6+
[eE]arly Access
7+
[hH]ostname

‎styles/scw_styles/Accessibility.yml

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
extends: existence
2+
message: "Avoid using uninclusive language such as '%s'"
3+
4+
level: suggestion
5+
ignorecase: true
6+
tokens:
7+
- a victim of
8+
- able-bodied
9+
- affected by
10+
- an epileptic
11+
- crippled
12+
- disabled
13+
- dumb
14+
- handicapped
15+
- handicaps
16+
- healthy
17+
- lame
18+
- maimed
19+
- missing a limb
20+
- mute
21+
- normal
22+
- sight-impaired
23+
- stricken with
24+
- suffers from
25+
- vision-impaired
26+
- sanity-check
27+
- blacklist
28+
- master
29+
- slave

‎styles/scw_styles/Acronyms.yml

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
extends: conditional
2+
message: "'%s' has no definition."
3+
4+
level: suggestion
5+
ignorecase: false
6+
# Ensures that the existence of 'first' implies the existence of 'second'.
7+
first: '\b([A-Z]{3,5})\b'
8+
second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)'
9+
# ... with the exception of these:
10+
exceptions:
11+
- API
12+
- ASP
13+
- CLI
14+
- CPU
15+
- CSS
16+
- CSV
17+
- DEBUG
18+
- DOM
19+
- DPI
20+
- FAQ
21+
- GCC
22+
- GDB
23+
- GET
24+
- GPU
25+
- GTK
26+
- GUI
27+
- HTML
28+
- HTTP
29+
- HTTPS
30+
- IDE
31+
- JAR
32+
- JSON
33+
- JSX
34+
- LESS
35+
- LLDB
36+
- NET
37+
- NOTE
38+
- NVDA
39+
- OSS
40+
- PATH
41+
- PDF
42+
- PHP
43+
- POST
44+
- RAM
45+
- REPL
46+
- RSA
47+
- SCM
48+
- SCSS
49+
- SDK
50+
- SQL
51+
- SSH
52+
- SSL
53+
- SVG
54+
- TBD
55+
- TCP
56+
- TODO
57+
- URI
58+
- URL
59+
- USB
60+
- UTF
61+
- XML
62+
- XSS
63+
- YAML
64+
- ZIP

‎styles/scw_styles/ConsoleTerms.yml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
extends: substitution
2+
message: "If referring to the Scaleway console, use '%s' instead of '%s'."
3+
link: https://confluence.infra.online.net/display/MARKETTECHANIM/Documentation+Guidelines#DocumentationGuidelines-ConsoleWordingConvention
4+
ignorecase: true
5+
level: warning
6+
7+
action:
8+
name: replace
9+
swap:
10+
menu on the left|left side menu: side menu
11+
splashscreen|splash screen: creation page
12+
dropdown: drop-down
13+
the support|the assistance|our assistance: our support team

‎styles/scw_styles/Contractions.yml

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
extends: substitution
2+
message: "Use '%s' instead of '%s'."
3+
link: https://confluence.infra.online.net/display/MARKETTECHANIM/Documentation+Guidelines#DocumentationGuidelines-Tone
4+
level: error
5+
6+
ignorecase: true
7+
action:
8+
name: replace
9+
swap:
10+
aren't: are not
11+
can't: cannot
12+
couldn't: could not
13+
didn't: did not
14+
don't: do not
15+
doesn't: does not
16+
hasn't: has not
17+
haven't: have not
18+
how's: how is
19+
isn't: is not
20+
it's: it is
21+
shouldn't: should not
22+
that's: that is
23+
they're: they are
24+
wasn't: was not
25+
we're: we are
26+
we've: we have
27+
weren't: were not
28+
what's: what is
29+
when's: when is
30+
where's: where is
31+
won't: will not

‎styles/scw_styles/Future.yml

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
extends: existence
2+
message: "Try to use the present tense instead of '%s'"
3+
link: https://confluence.infra.online.net/display/MARKETTECHANIM/Documentation+Guidelines#DocumentationGuidelines-WritingGuidelines
4+
5+
level: warning
6+
ignorecase: true
7+
tokens:
8+
- will
9+
- won't

‎styles/scw_styles/HeadingSentenceCase.yml

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
extends: capitalization
2+
message: "'%s' is a heading and should use sentence-style capitalization."
3+
level: suggestion
4+
scope: heading
5+
match: $sentence
6+
indicators:
7+
- ':'
8+
exceptions:
9+
- Availability Zone
10+
- Availability Zones
11+
- API
12+
- CLI
13+
- Organization
14+
- Organizations
15+
- Project
16+
- Projects
17+
- Scaleway
18+
- Instance
19+
- Instances
20+
- Private Network
21+
- Private Networks
22+
- Protected Instance
23+
- InstantApp
24+
- Apple M1
25+
- Apple
26+
- Mac mini
27+
- Bare Metal
28+
- Elastic Metal
29+
- MAC
30+
- Kubernetes
31+
- Kubernetes Kapsule
32+
- Kubernetes Kosmos
33+
- CNI
34+
- Easy Deploy
35+
- Container Registry
36+
- Docker
37+
- Serverless Container
38+
- Serverless Containers
39+
- Container Instance
40+
- JWT
41+
- Serverless Function
42+
- Serverless Functions
43+
- Serverless
44+
- Serverless Instance
45+
- Serverless Instances
46+
- Object Storage
47+
- Glacier
48+
- Standard
49+
- S3
50+
- Block Storage
51+
- Managed Database
52+
- Managed Databases
53+
- Database Instance
54+
- Database Instances
55+
- Private Networks
56+
- Private Network
57+
- Public Gateways
58+
- Public Gateway
59+
- Load Balancer
60+
- DNS
61+
- IoT Hub
62+
- Hub
63+
- Kickstart
64+
- WebSocket
65+
- Linux
66+
- macOS
67+
- MongoDB
68+
- URLs
69+
- Windows

0 commit comments

Comments
 (0)