From 51d15e721bf53317e08cb4b6009b28abbb4b5873 Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Wed, 14 Sep 2022 05:31:36 +0200 Subject: [PATCH] vale poc (#15371) * added vale config embryo * added some more example rules * update rules * add more formatting rules * expanded vocab * added more rules * added dvp vocabulary terms * rm link text from sentence case rule --- .github/vale/Docker/Acronyms.yml | 65 ++++++ .github/vale/Docker/Adverbs.yml | 269 +++++++++++++++++++++++ .github/vale/Docker/Callouts.yml | 12 + .github/vale/Docker/ComplexWords.yml | 117 ++++++++++ .github/vale/Docker/Contractions.yml | 47 ++++ .github/vale/Docker/DateFormat.yml | 10 + .github/vale/Docker/DateMonthName.yml | 8 + .github/vale/Docker/DateNumber.yml | 40 ++++ .github/vale/Docker/Decimals.yml | 8 + .github/vale/Docker/GenericCTA.yml | 10 + .github/vale/Docker/HeadingLength.yml | 7 + .github/vale/Docker/LinkLength.yml | 7 + .github/vale/Docker/LinkPunctuation.yml | 8 + .github/vale/Docker/ListComma.yml | 6 + .github/vale/Docker/ListLength.yml | 7 + .github/vale/Docker/OxfordComma.yml | 7 + .github/vale/Docker/Passive.yml | 9 + .github/vale/Docker/SentenceCase.yml | 11 + .github/vale/Docker/SentenceLength.yml | 7 + .github/vale/Docker/Spacing.yml | 7 + .github/vale/Docker/Substitute.yml | 38 ++++ .github/vale/Docker/URLFormat.yml | 9 + .github/vale/Docker/VersionText.yml | 12 + .github/vale/Docker/We.yml | 11 + .github/vale/Vocab/Docker/accept.txt | 26 +++ .github/vale/Vocab/Industry/accept.txt | 52 +++++ .github/vale/Vocab/Technology/accept.txt | 48 ++++ .vale.ini | 8 + 28 files changed, 866 insertions(+) create mode 100644 .github/vale/Docker/Acronyms.yml create mode 100644 .github/vale/Docker/Adverbs.yml create mode 100644 .github/vale/Docker/Callouts.yml create mode 100644 .github/vale/Docker/ComplexWords.yml create mode 100644 .github/vale/Docker/Contractions.yml create mode 100644 .github/vale/Docker/DateFormat.yml create mode 100644 .github/vale/Docker/DateMonthName.yml create mode 100644 .github/vale/Docker/DateNumber.yml create mode 100644 .github/vale/Docker/Decimals.yml create mode 100644 .github/vale/Docker/GenericCTA.yml create mode 100644 .github/vale/Docker/HeadingLength.yml create mode 100644 .github/vale/Docker/LinkLength.yml create mode 100644 .github/vale/Docker/LinkPunctuation.yml create mode 100644 .github/vale/Docker/ListComma.yml create mode 100644 .github/vale/Docker/ListLength.yml create mode 100644 .github/vale/Docker/OxfordComma.yml create mode 100644 .github/vale/Docker/Passive.yml create mode 100644 .github/vale/Docker/SentenceCase.yml create mode 100644 .github/vale/Docker/SentenceLength.yml create mode 100644 .github/vale/Docker/Spacing.yml create mode 100644 .github/vale/Docker/Substitute.yml create mode 100644 .github/vale/Docker/URLFormat.yml create mode 100644 .github/vale/Docker/VersionText.yml create mode 100644 .github/vale/Docker/We.yml create mode 100644 .github/vale/Vocab/Docker/accept.txt create mode 100644 .github/vale/Vocab/Industry/accept.txt create mode 100644 .github/vale/Vocab/Technology/accept.txt create mode 100644 .vale.ini diff --git a/.github/vale/Docker/Acronyms.yml b/.github/vale/Docker/Acronyms.yml new file mode 100644 index 0000000000..85f7136c2e --- /dev/null +++ b/.github/vale/Docker/Acronyms.yml @@ -0,0 +1,65 @@ +extends: conditional +message: "'%s' has no definition." +link: https://docs.docker.com/contribute/style/grammar/#acronyms-and-initialisms +level: warning +ignorecase: false +# Ensures that the existence of 'first' implies the existence of 'second'. +first: '\b([A-Z]{3,5})\b' +second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)' +# ... with the exception of these: +exceptions: + - API + - ASP + - CLI + - CPU + - CSS + - CSV + - DEBUG + - DOM + - DPI + - FAQ + - GCC + - GDB + - GET + - GPU + - GTK + - GUI + - HEAD + - HTML + - HTTP + - HTTPS + - IDE + - JAR + - JSON + - JSX + - LESS + - LLDB + - NET + - NOTE + - NVDA + - OSS + - PATH + - PDF + - PHP + - POST + - RAM + - REPL + - RSA + - SCM + - SCSS + - SDK + - SQL + - SSH + - SSL + - SVG + - TBD + - TCP + - TODO + - URI + - URL + - USB + - UTF + - XML + - XSS + - YAML + - ZIP diff --git a/.github/vale/Docker/Adverbs.yml b/.github/vale/Docker/Adverbs.yml new file mode 100644 index 0000000000..630a31698b --- /dev/null +++ b/.github/vale/Docker/Adverbs.yml @@ -0,0 +1,269 @@ +extends: existence +message: "Consider removing '%s'." +ignorecase: true +level: warning +tokens: + - abnormally + - absentmindedly + - accidentally + - adventurously + - anxiously + - arrogantly + - awkwardly + - bashfully + - beautifully + - bitterly + - bleakly + - blindly + - blissfully + - boastfully + - boldly + - bravely + - briefly + - brightly + - briskly + - broadly + - busily + - calmly + - carefully + - carelessly + - cautiously + - cheerfully + - cleverly + - closely + - coaxingly + - colorfully + - continually + - coolly + - courageously + - crossly + - cruelly + - curiously + - currently + - daintily + - dearly + - deceivingly + - deeply + - defiantly + - deliberately + - delightfully + - diligently + - dimly + - doubtfully + - dreamily + - easily + - elegantly + - energetically + - enormously + - enthusiastically + - excitedly + - extremely + - fairly + - faithfully + - famously + - ferociously + - fervently + - fiercely + - fondly + - foolishly + - fortunately + - frankly + - frantically + - freely + - frenetically + - frightfully + - furiously + - generally + - generously + - gently + - gladly + - gleefully + - gracefully + - gratefully + - greatly + - greedily + - happily + - hastily + - healthily + - heavily + - helplessly + - honestly + - hopelessly + - hungrily + - innocently + - inquisitively + - intensely + - intently + - interestingly + - inwardly + - irritably + - jaggedly + - jealously + - jovially + - joyfully + - joyously + - jubilantly + - judgmentally + - justly + - keenly + - kiddingly + - kindheartedly + - knavishly + - knowingly + - knowledgeably + - lazily + - lightly + - limply + - lively + - loftily + - longingly + - loosely + - loudly + - lovingly + - loyally + - madly + - majestically + - meaningfully + - mechanically + - merrily + - miserably + - mockingly + - mortally + - mysteriously + - naturally + - nearly + - neatly + - nervously + - nicely + - noisily + - obediently + - obnoxiously + - oddly + - offensively + - optimistically + - overconfidently + - painfully + - partially + - patiently + - perfectly + - playfully + - politely + - poorly + - positively + - potentially + - powerfully + - promptly + - properly + - punctually + - quaintly + - queasily + - queerly + - questionably + - quickly + - quietly + - quirkily + - quizzically + - randomly + - rapidly + - rarely + - readily + - really + - reassuringly + - recklessly + - regularly + - reluctantly + - repeatedly + - reproachfully + - respectively + - restfully + - righteously + - rightfully + - rigidly + - roughly + - rudely + - safely + - scarcely + - scarily + - searchingly + - sedately + - seemingly + - selfishly + - separately + - seriously + - shakily + - sharply + - sheepishly + - shrilly + - shyly + - silently + - sleepily + - slowly + - smoothly + - softly + - solemnly + - solidly + - speedily + - stealthily + - sternly + - strictly + - suddenly + - supposedly + - surprisingly + - suspiciously + - sweetly + - swiftly + - sympathetically + - tenderly + - tensely + - terribly + - thankfully + - thoroughly + - thoughtfully + - tightly + - tremendously + - triumphantly + - truthfully + - ultimately + - unabashedly + - unaccountably + - unbearably + - unethically + - unexpectedly + - unfortunately + - unimpressively + - unnaturally + - unnecessarily + - urgently + - usefully + - uselessly + - utterly + - vacantly + - vaguely + - vainly + - valiantly + - vastly + - verbally + - very + - viciously + - victoriously + - violently + - vivaciously + - voluntarily + - warmly + - weakly + - wearily + - wetly + - wholly + - wildly + - willfully + - wisely + - woefully + - wonderfully + - worriedly + - yawningly + - yearningly + - yieldingly + - youthfully + - zealously + - zestfully + - zestily diff --git a/.github/vale/Docker/Callouts.yml b/.github/vale/Docker/Callouts.yml new file mode 100644 index 0000000000..a5b7c21c3b --- /dev/null +++ b/.github/vale/Docker/Callouts.yml @@ -0,0 +1,12 @@ +extends: existence +message: "Use a liquid tag for 'Important' or 'Warning' callouts." +link: https://docs.docker.com/contribute/components/call-outs/ +level: warning +nonword: true +scope: raw +raw: + - '[:blank:]*\> .*?' + - "(?i)(?:important|warning|danger|caution)(?-i)" + - '.*\n' + - '(?:[:blank:]*\>.*\n)+?' + - '[:blank:]*(?!\{: \.(important|warning))' diff --git a/.github/vale/Docker/ComplexWords.yml b/.github/vale/Docker/ComplexWords.yml new file mode 100644 index 0000000000..add7baf389 --- /dev/null +++ b/.github/vale/Docker/ComplexWords.yml @@ -0,0 +1,117 @@ +extends: substitution +message: "Consider using '%s' instead of '%s'." +ignorecase: true +level: suggestion +swap: + "approximate(?:ly)?": about + abundance: plenty + accelerate: speed up + accentuate: stress + accompany: go with + accomplish: carry out|do + accorded: given + accordingly: so + accrue: add + accurate: right|exact + acquiesce: agree + acquire: get|buy + additional: more|extra + address: discuss + addressees: you + adjacent to: next to + adjustment: change + admissible: allowed + advantageous: helpful + advise: tell + aggregate: total + aircraft: plane + alleviate: ease + allocate: assign|divide + alternatively: or + alternatives: choices|options + ameliorate: improve + amend: change + anticipate: expect + apparent: clear|plain + ascertain: discover|find out + assistance: help + attain: meet + attempt: try + authorize: allow + belated: late + bestow: give + cease: stop|end + collaborate: work together + commence: begin + compensate: pay + component: part + comprise: form|include + concept: idea + concerning: about + confer: give|award + consequently: so + consolidate: merge + constitutes: forms + contains: has + convene: meet + demonstrate: show|prove + depart: leave + designate: choose + desire: want|wish + determine: decide|find + detrimental: bad|harmful + disclose: share|tell + discontinue: stop + disseminate: send|give + eliminate: end + elucidate: explain + employ: use + enclosed: inside|included + encounter: meet + endeavor: try + enumerate: count + equitable: fair + equivalent: equal + exclusively: only + expedite: hurry + facilitate: ease + females: women + finalize: complete|finish + frequently: often + identical: same + incorrect: wrong + indication: sign + initiate: start|begin + itemized: listed + jeopardize: risk + liaise: work with|partner with + maintain: keep|support + methodology: method + modify: change + monitor: check|watch + multiple: many + necessitate: cause + notify: tell + numerous: many + objective: aim|goal + obligate: bind|compel + optimum: best|most + permit: let + portion: part + possess: own + previous: earlier + previously: before + prioritize: rank + procure: buy + provide: give|offer + purchase: buy + relocate: move + solicit: request + state-of-the-art: latest + subsequent: later|next + substantial: large + sufficient: enough + terminate: end + transmit: send + utilization: use + utilize: use diff --git a/.github/vale/Docker/Contractions.yml b/.github/vale/Docker/Contractions.yml new file mode 100644 index 0000000000..a814a1c8e9 --- /dev/null +++ b/.github/vale/Docker/Contractions.yml @@ -0,0 +1,47 @@ +extends: substitution +message: "Consider using '%s' instead of '%s'." +level: warning +ignorecase: true +swap: + are not: aren't + cannot: can't + could not: couldn't + did not: didn't + do not: don't + does not: doesn't + has not: hasn't + have not: haven't + how is: how's + is not: isn't + + 'it is(?!\.)': it's + 'it''s(?=\.)': it is + + should not: shouldn't + + 'that is(?!\.)': that's + 'that''s(?=\.)': that is + + 'they are(?!\.)': they're + 'they''re(?=\.)': they are + + was not: wasn't + + 'we are(?!\.)': we're + 'we''re(?=\.)': we are + + 'we have(?!\.)': we've + 'we''ve(?=\.)': we have + + were not: weren't + + 'what is(?!\.)': what's + 'what''s(?=\.)': what is + + 'when is(?!\.)': when's + 'when''s(?=\.)': when is + + 'where is(?!\.)': where's + 'where''s(?=\.)': where is + + will not: won't diff --git a/.github/vale/Docker/DateFormat.yml b/.github/vale/Docker/DateFormat.yml new file mode 100644 index 0000000000..ff9b641724 --- /dev/null +++ b/.github/vale/Docker/DateFormat.yml @@ -0,0 +1,10 @@ +extends: existence +message: Use 'July 31, 2016' format, not '%s'. +link: https://docs.docker.com/contribute/style/grammar/#dates +ignorecase: true +level: error +nonword: true +tokens: + - '\d{1,2} + (?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?) + \d{4}' diff --git a/.github/vale/Docker/DateMonthName.yml b/.github/vale/Docker/DateMonthName.yml new file mode 100644 index 0000000000..26ba757d4e --- /dev/null +++ b/.github/vale/Docker/DateMonthName.yml @@ -0,0 +1,8 @@ +extends: existence +message: "When possible, spell out the name of the month." +link: https://docs.docker.com/contribute/style/grammar/#dates +ignorecase: true +level: warning +nonword: true +tokens: + - '\b\d{1,2}/\d{1,2}/(?:\d{4}|\d{2})\b' diff --git a/.github/vale/Docker/DateNumber.yml b/.github/vale/Docker/DateNumber.yml new file mode 100644 index 0000000000..fbd2abbc4a --- /dev/null +++ b/.github/vale/Docker/DateNumber.yml @@ -0,0 +1,40 @@ +extends: existence +message: "Don't use ordinal numbers for dates." +link: https://docs.docker.com/contribute/style/grammar/#dates +level: error +nonword: true +ignorecase: true +raw: + - \b(?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?)\b\s* +tokens: + - first + - second + - third + - fourth + - fifth + - sixth + - seventh + - eighth + - ninth + - tenth + - eleventh + - twelfth + - thirteenth + - fourteenth + - fifteenth + - sixteenth + - seventeenth + - eighteenth + - nineteenth + - twentieth + - twenty-first + - twenty-second + - twenty-third + - twenty-fourth + - twenty-fifth + - twenty-sixth + - twenty-seventh + - twenty-eighth + - twenty-ninth + - thirtieth + - thirty-first diff --git a/.github/vale/Docker/Decimals.yml b/.github/vale/Docker/Decimals.yml new file mode 100644 index 0000000000..d01d3ca9cf --- /dev/null +++ b/.github/vale/Docker/Decimals.yml @@ -0,0 +1,8 @@ +extends: existence +message: Use decimals instead of fractions. +link: https://docs.docker.com/contribute/style/grammar/#decimals-and-fractions +level: warning +raw: + - '[\w\s]' + - \d+\/\d+ + - '(?!\/\d+)' diff --git a/.github/vale/Docker/GenericCTA.yml b/.github/vale/Docker/GenericCTA.yml new file mode 100644 index 0000000000..1d588c277a --- /dev/null +++ b/.github/vale/Docker/GenericCTA.yml @@ -0,0 +1,10 @@ +extends: existence +message: "Avoid generic calls to action: '%s'" +link: https://docs.docker.com/contribute/style/formatting/#links +level: warning +scope: link +ignorecase: true +tokens: + - click here + - find out more + - learn more diff --git a/.github/vale/Docker/HeadingLength.yml b/.github/vale/Docker/HeadingLength.yml new file mode 100644 index 0000000000..270ccf80ae --- /dev/null +++ b/.github/vale/Docker/HeadingLength.yml @@ -0,0 +1,7 @@ +extends: occurrence +message: "Try to keep headings short (< 8 words)." +link: https://docs.docker.com/contribute/style/formatting/#headings-and-subheadings +scope: heading +level: suggestion +max: 8 +token: \b(\w+)\b diff --git a/.github/vale/Docker/LinkLength.yml b/.github/vale/Docker/LinkLength.yml new file mode 100644 index 0000000000..85c1de98e0 --- /dev/null +++ b/.github/vale/Docker/LinkLength.yml @@ -0,0 +1,7 @@ +extends: occurrence +message: "Try to keep link text short (< 5 words)." +scope: link +link: https://docs.docker.com/contribute/style/formatting/#links +level: suggestion +max: 5 +token: \b(\w+)\b diff --git a/.github/vale/Docker/LinkPunctuation.yml b/.github/vale/Docker/LinkPunctuation.yml new file mode 100644 index 0000000000..118c7c191a --- /dev/null +++ b/.github/vale/Docker/LinkPunctuation.yml @@ -0,0 +1,8 @@ +extends: existence +message: "Don't use end punctuation in links." +link: https://docs.docker.com/contribute/style/formatting/#links +nonword: true +level: warning +scope: link +tokens: + - '[a-z0-9][.?!](?:\s|$)' diff --git a/.github/vale/Docker/ListComma.yml b/.github/vale/Docker/ListComma.yml new file mode 100644 index 0000000000..2af0bc710d --- /dev/null +++ b/.github/vale/Docker/ListComma.yml @@ -0,0 +1,6 @@ +extends: existence +message: Don’t add commas (,) or semicolons (;) to the ends of list items. +link: https://docs.docker.com/contribute/style/grammar/#lists +level: warning +scope: list +raw: '[,;]$' diff --git a/.github/vale/Docker/ListLength.yml b/.github/vale/Docker/ListLength.yml new file mode 100644 index 0000000000..2e187ea1ba --- /dev/null +++ b/.github/vale/Docker/ListLength.yml @@ -0,0 +1,7 @@ +extends: occurrence +message: List items should contain relatively few words or short phrases. +link: https://docs.docker.com/contribute/style/grammar/#lists +level: suggestion +scope: list +max: 20 +token: \b(\w+)\b diff --git a/.github/vale/Docker/OxfordComma.yml b/.github/vale/Docker/OxfordComma.yml new file mode 100644 index 0000000000..8344e91d64 --- /dev/null +++ b/.github/vale/Docker/OxfordComma.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Use the Oxford comma in '%s'." +scope: sentence +level: suggestion +nonword: true +tokens: + - '(?:[^\s,]+,){1,} \w+ (?:and|or) \w+[.?!]' diff --git a/.github/vale/Docker/Passive.yml b/.github/vale/Docker/Passive.yml new file mode 100644 index 0000000000..b25cff6241 --- /dev/null +++ b/.github/vale/Docker/Passive.yml @@ -0,0 +1,9 @@ +extends: existence +message: "'%s' looks like passive voice." +link: https://docs.docker.com/contribute/checklist/ +ignorecase: true +level: suggestion +raw: + - \b(am|are|were|being|is|been|was|be)\b\s* +tokens: + - '[\w]+ed' diff --git a/.github/vale/Docker/SentenceCase.yml b/.github/vale/Docker/SentenceCase.yml new file mode 100644 index 0000000000..148ab96766 --- /dev/null +++ b/.github/vale/Docker/SentenceCase.yml @@ -0,0 +1,11 @@ +extends: capitalization +message: "Use sentence case for headings: '%s'." +level: warning +scope: heading +match: $sentence +indicators: + - ":" +exceptions: + - Vocab/Docker/accept.txt + - Vocab/Technology/accept.txt + - Vocab/Industry/accept.txt diff --git a/.github/vale/Docker/SentenceLength.yml b/.github/vale/Docker/SentenceLength.yml new file mode 100644 index 0000000000..d08241cd16 --- /dev/null +++ b/.github/vale/Docker/SentenceLength.yml @@ -0,0 +1,7 @@ +extends: occurrence +message: "Write short, concise sentences." +scope: sentence +link: https://docs.docker.com/contribute/checklist/ +level: warning +max: 25 +token: \b(\w+)\b diff --git a/.github/vale/Docker/Spacing.yml b/.github/vale/Docker/Spacing.yml new file mode 100644 index 0000000000..81d79e2c10 --- /dev/null +++ b/.github/vale/Docker/Spacing.yml @@ -0,0 +1,7 @@ +extends: existence +message: "'%s' should have one space." +level: error +nonword: true +tokens: + - "[a-z][.?!] {2,}[A-Z]" + - "[a-z][.?!][A-Z]" diff --git a/.github/vale/Docker/Substitute.yml b/.github/vale/Docker/Substitute.yml new file mode 100644 index 0000000000..d225ff7369 --- /dev/null +++ b/.github/vale/Docker/Substitute.yml @@ -0,0 +1,38 @@ +extends: substitution +message: "Consider using '%s' instead of '%s'" +link: https://docs.docker.com/contribute/style/recommended-words/ +ignorecase: true +level: suggestion +swap: + '\b(?:eg|e\.g\.)[\s,]': for example + '\b(?:ie|i\.e\.)[\s,]': that is + (?:sign on|log on|log in): sign in + above: previous + adaptor: adapter + administrate: administer + afterwards: afterward + alphabetic: alphabetical + alphanumerical: alphanumeric + anti-aliasing: antialiasing + anti-malware: antimalware + anti-spyware: antispyware + anti-virus: antivirus + appendixes: appendices + assembler: assembly language + below: following + check box: checkbox + click: select + deselect: clear + ergo: therefore + execute: invoke + gb: GB + gbps: Gbps + kb: KB + keypress: keystroke + mb: MB + mutices: mutexes + paas: PaaS + pb: PB + scroll: navigate + sign up: register + tb: TB diff --git a/.github/vale/Docker/URLFormat.yml b/.github/vale/Docker/URLFormat.yml new file mode 100644 index 0000000000..c81b486c4c --- /dev/null +++ b/.github/vale/Docker/URLFormat.yml @@ -0,0 +1,9 @@ +extends: substitution +message: "Use '%s' instead of '%s'." +ignorecase: true +level: error +action: + name: replace +swap: + URL for: URL of + an URL: a URL diff --git a/.github/vale/Docker/VersionText.yml b/.github/vale/Docker/VersionText.yml new file mode 100644 index 0000000000..3210997efc --- /dev/null +++ b/.github/vale/Docker/VersionText.yml @@ -0,0 +1,12 @@ +extends: existence +message: Use later when talking about version numbers. +link: https://docs.docker.com/contribute/style/recommended-words/#later +scope: raw +raw: + - '\bv?' + - '(?P0|[1-9]\d*)\.?' + - '(?P0|[1-9]\d*)?\.?' + - '(?P0|[1-9]\d*)?' + - '(?:-(?P(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?' + - '(?:\+(?P[0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?' + - '\b (and|or) (higher|above)' diff --git a/.github/vale/Docker/We.yml b/.github/vale/Docker/We.yml new file mode 100644 index 0000000000..65d3a7dd6e --- /dev/null +++ b/.github/vale/Docker/We.yml @@ -0,0 +1,11 @@ +extends: existence +message: "Avoid using first-person plural like '%s'." +link: https://docs.microsoft.com/en-us/style-guide/grammar/person#avoid-first-person-plural +level: warning +ignorecase: true +tokens: + - we + - we'(?:ve|re) + - ours? + - us + - let's diff --git a/.github/vale/Vocab/Docker/accept.txt b/.github/vale/Vocab/Docker/accept.txt new file mode 100644 index 0000000000..d1b0f6466b --- /dev/null +++ b/.github/vale/Vocab/Docker/accept.txt @@ -0,0 +1,26 @@ +(Certified|Verified) Publisher( Program)? +Autotest +BuildKit +Docker +Dockerize +Dockerizing +Docker Business +Docker Dasboard +Docker Desktop +Docker Engine +Docker Hub +Docker Team +Docker Extension +Dockerfile +HyperKit +Kitematic +LinuxKit +Official Images? +Sponsored (OSS|Open Source Software) +Swarm +Swarm Mode +[Bb]uildx +[Cc]ompose +[Mm]oby +dockerd +dockerignore diff --git a/.github/vale/Vocab/Industry/accept.txt b/.github/vale/Vocab/Industry/accept.txt new file mode 100644 index 0000000000..d17cc955bb --- /dev/null +++ b/.github/vale/Vocab/Industry/accept.txt @@ -0,0 +1,52 @@ +AWS +Amazon +Apple +Artifactory +BusyBox +CentOS +Ceph +CloudFront +Codefresh +CouchDB +Couchbase +Ddosify +Django +Fargate +Fedora +Flink +GeoNetwork +GitHub( Actions)? +Google +Intel +JetBrains +Kubernetes +Lightstreamer +Linux +Logstash +Mac +Mail(chimp|gun) +Microsoft +MySQL +Nginx +Nuxeo +OAuth +Okta +Postgres +PowerShell +Python +QEMU +RHEL +S3 +SQLite +Slack +Snyk +Solr +SonarQube +Syft +Twilio +Ubuntu +WSL +Windows +XWiki +Zsh +macOS diff --git a/.github/vale/Vocab/Technology/accept.txt b/.github/vale/Vocab/Technology/accept.txt new file mode 100644 index 0000000000..1f8b56f6cb --- /dev/null +++ b/.github/vale/Vocab/Technology/accept.txt @@ -0,0 +1,48 @@ +APIs? +Ethernet +Git +HTTP +IPs? +IPv[46] +IPvlan +MAC +SDKs? +SSO +TCP +UDP +VLAN +VM +cgroup +config +containerd +deserialization +deserialize +filepath +glibc +goroutine +hostname +inotify +iptables +kubectl +kubelet +lookup +macvlan +mfsymlinks +musl +namespace +osquery +osxfs +paravirtualization +proxying +real-time +runc +runtime +stdin +stdout +subnet +swappable +systemd +ungated +virtiofs +virtualize +walkthrough diff --git a/.vale.ini b/.vale.ini new file mode 100644 index 0000000000..6b33d3939b --- /dev/null +++ b/.vale.ini @@ -0,0 +1,8 @@ +StylesPath = .github/vale +MinAlertLevel = suggestion + +Vocab = Docker, Industry, Technology + +[*.md] +BasedOnStyles = Vale, Docker +TokenIgnores = ({%.*%})