diff --git a/.vale.ini b/.vale.ini new file mode 100755 index 000000000..c77fea578 --- /dev/null +++ b/.vale.ini @@ -0,0 +1,17 @@ +StylesPath = vale-styles +MinAlertLevel = suggestion # suggestion, warning or error + +[formats] +mdx = md + +[*.{md,markdown,txt,htm,html}] +BasedOnStyles = FluentBit +IgnoredScopes = tt, code + +FluentBit.Terms = YES +FluentBit.Titles = YES +FluentBit.FutureTense = NO +FluentBit.Headings = NO +FluentBit.Passive = NO +FluentBit.Subjunctive = NO +FluentBit.Colons = NO diff --git a/vale-styles/FluentBit/AMPM.yml b/vale-styles/FluentBit/AMPM.yml new file mode 100644 index 000000000..5b696b3b8 --- /dev/null +++ b/vale-styles/FluentBit/AMPM.yml @@ -0,0 +1,10 @@ + +extends: existence +message: "Use 'AM' or 'PM' (preceded by a space)." +link: 'https://developers.google.com/style/word-list' +level: suggestion +nonword: true +tokens: + - '\d{1,2}[AP]M' + - '\d{1,2} ?[ap]m' + - '\d{1,2} ?[aApP]\.[mM]\.' \ No newline at end of file diff --git a/vale-styles/FluentBit/Acronyms.yml b/vale-styles/FluentBit/Acronyms.yml new file mode 100644 index 000000000..19936b25c --- /dev/null +++ b/vale-styles/FluentBit/Acronyms.yml @@ -0,0 +1,95 @@ +extends: conditional +message: "Spell out '%s', if it's unfamiliar to the audience." +link: 'https://developers.google.com/style/abbreviations' +level: suggestion +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: + - ACL + - API + - ARN + - ASC + - ASP + - AWS + - CIDR + - CLI + - CPU + - CRD + - CSS + - CSV + - DEBUG + - DESC + - DOM + - DNS + - DPI + - DPPS + - FAQ + - FIPS + - GCC + - GCP + - GDB + - GET + - GNU + - GPG + - GPU + - GTK + - GUI + - GZIP + - HPA + - IAM + - HTML + - HTTP + - HTTPS + - IDE + - JAR + - JSON + - JSX + - LESS + - LLDB + - LTS + - NET + - NOTE + - NVDA + - OSS + - PATH + - PEM + - PDF + - PHP + - POSIX + - POST + - RAM + - REPL + - REST + - RHEL + - RPC + - RSA + - SASL + - SCM + - SCSS + - SDK + - SIEM + - SLA + - SQL + - SSH + - SSL + - SSO + - SVG + - TBD + - TCP + - TLS + - TRE + - TODO + - UDP + - URI + - URL + - USB + - UTC + - UTF + - UUID + - XML + - XSS + - YAML + - ZIP diff --git a/vale-styles/FluentBit/AmSpelling.yml b/vale-styles/FluentBit/AmSpelling.yml new file mode 100644 index 000000000..9a8ea2e30 --- /dev/null +++ b/vale-styles/FluentBit/AmSpelling.yml @@ -0,0 +1,8 @@ +extends: existence +message: "In general, use American spelling instead of '%s'." +link: 'https://developers.google.com/style/spelling' +ignorecase: true +level: suggestion +tokens: + - '(?:\w+)nised?' + - '(?:\w+)logue' \ No newline at end of file diff --git a/vale-styles/FluentBit/Ampersand.yml b/vale-styles/FluentBit/Ampersand.yml new file mode 100644 index 000000000..aa516517c --- /dev/null +++ b/vale-styles/FluentBit/Ampersand.yml @@ -0,0 +1,9 @@ +--- +extends: existence +message: "Don't use an ampersand in place of the word 'and'. Always write out 'and' unless the ampersand is part of a proper name." +nonword: true +ignorecase: false +level: error +scope: sentence +tokens: + - '[^\*{2}].*.&.*[^\*{2}]\n' diff --git a/vale-styles/FluentBit/Colons.yml b/vale-styles/FluentBit/Colons.yml new file mode 100644 index 000000000..aee9281c3 --- /dev/null +++ b/vale-styles/FluentBit/Colons.yml @@ -0,0 +1,8 @@ +extends: existence +message: "'%s' should be in lowercase." +link: 'https://developers.google.com/style/colons' +nonword: true +level: suggestion +scope: sentence +tokens: + - ':\s[A-Z]' \ No newline at end of file diff --git a/vale-styles/FluentBit/Contractions.yml b/vale-styles/FluentBit/Contractions.yml new file mode 100644 index 000000000..525687ca6 --- /dev/null +++ b/vale-styles/FluentBit/Contractions.yml @@ -0,0 +1,30 @@ +extends: substitution +message: "Feel free to use '%s' instead of '%s'." +link: 'https://developers.google.com/style/contractions' +level: suggestion +ignorecase: true +action: + name: replace +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 + should not: shouldn't + that is: that's + they are: they're + was not: wasn't + we are: we're + we have: we've + were not: weren't + what is: what's + when is: when's + where is: where's + will not: won't \ No newline at end of file diff --git a/vale-styles/FluentBit/DateFormat.yml b/vale-styles/FluentBit/DateFormat.yml new file mode 100644 index 000000000..c70b3b7bc --- /dev/null +++ b/vale-styles/FluentBit/DateFormat.yml @@ -0,0 +1,9 @@ +extends: existence +message: "Use 'July 31, 2016' format, not '%s'." +link: 'https://developers.google.com/style/dates-times' +ignorecase: true +level: suggestion +nonword: true +tokens: + - '\d{1,2}(?:\.|/)\d{1,2}(?:\.|/)\d{4}' + - '\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}' \ No newline at end of file diff --git a/vale-styles/FluentBit/Directional.yml b/vale-styles/FluentBit/Directional.yml new file mode 100644 index 000000000..1d18a0f4d --- /dev/null +++ b/vale-styles/FluentBit/Directional.yml @@ -0,0 +1,8 @@ +--- +extends: existence +message: "Verify your use of '%s' with the Style Guide." +level: suggestion +ignorecase: true +tokens: + - above + - below diff --git a/vale-styles/FluentBit/DontUse.yml b/vale-styles/FluentBit/DontUse.yml new file mode 100644 index 000000000..8308555d7 --- /dev/null +++ b/vale-styles/FluentBit/DontUse.yml @@ -0,0 +1,18 @@ +--- +extends: existence +message: "We don't use '%s'." +ignorecase: true +level: suggestion +tokens: + - a.k.a. + - aka + - and/or + - at this point + - desire + - it is recommended that + - just + - note that + - please + - quite + - such that + - thus diff --git a/vale-styles/FluentBit/Drilldown.yml b/vale-styles/FluentBit/Drilldown.yml new file mode 100644 index 000000000..ca7cb2ed7 --- /dev/null +++ b/vale-styles/FluentBit/Drilldown.yml @@ -0,0 +1,8 @@ +--- +extends: sequence +message: "Use drilldown as an adjective or noun." +level: suggestion +ignorecase: true +tokens: + - tag: NN|JJ + pattern: '(?:drill down|drill-down)' diff --git a/vale-styles/FluentBit/DrilldownVerb.yml b/vale-styles/FluentBit/DrilldownVerb.yml new file mode 100644 index 000000000..3dd6ca047 --- /dev/null +++ b/vale-styles/FluentBit/DrilldownVerb.yml @@ -0,0 +1,8 @@ +--- +extends: sequence +message: "Use drill down as a verb." +level: suggestion +ignorecase: true +tokens: + - tag: VB|VBD|VBG|VBN|VBP|VBZ + pattern: '(?:drilldown|drill-down)' diff --git a/vale-styles/FluentBit/Ellipses.yml b/vale-styles/FluentBit/Ellipses.yml new file mode 100644 index 000000000..6b93a0c44 --- /dev/null +++ b/vale-styles/FluentBit/Ellipses.yml @@ -0,0 +1,9 @@ +extends: existence +message: "In general, don't use an ellipsis." +link: 'https://developers.google.com/style/ellipses' +nonword: true +level: suggestion +action: + name: remove +tokens: + - '\.\.\.' \ No newline at end of file diff --git a/vale-styles/FluentBit/EmDash.yml b/vale-styles/FluentBit/EmDash.yml new file mode 100644 index 000000000..c0de45e89 --- /dev/null +++ b/vale-styles/FluentBit/EmDash.yml @@ -0,0 +1,12 @@ +extends: existence +message: "Don't put a space before or after a dash." +link: 'https://developers.google.com/style/dashes' +nonword: true +level: suggestion +action: + name: edit + params: + - remove + - ' ' +tokens: + - '\s[—–]\s' \ No newline at end of file diff --git a/vale-styles/FluentBit/EnDash.yml b/vale-styles/FluentBit/EnDash.yml new file mode 100644 index 000000000..e69e4bcbb --- /dev/null +++ b/vale-styles/FluentBit/EnDash.yml @@ -0,0 +1,13 @@ +extends: existence +message: "Use an em dash ('—') instead of '–'." +link: 'https://developers.google.com/style/dashes' +nonword: true +level: suggestion +action: + name: edit + params: + - replace + - '-' + - '—' +tokens: + - '–' \ No newline at end of file diff --git a/vale-styles/FluentBit/Exclamation.yml b/vale-styles/FluentBit/Exclamation.yml new file mode 100644 index 000000000..b77798361 --- /dev/null +++ b/vale-styles/FluentBit/Exclamation.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Don't use exclamation points in text." +link: 'https://developers.google.com/style/exclamation-points' +nonword: true +level: suggestion +tokens: + - '\w!(?:\s|$)' diff --git a/vale-styles/FluentBit/FirstPerson.yml b/vale-styles/FluentBit/FirstPerson.yml new file mode 100644 index 000000000..e8793eddf --- /dev/null +++ b/vale-styles/FluentBit/FirstPerson.yml @@ -0,0 +1,13 @@ +extends: existence +message: "Avoid first-person pronouns such as '%s'." +link: 'https://developers.google.com/style/pronouns#personal-pronouns' +ignorecase: true +level: suggestion +nonword: true +tokens: + - (?:^|\s)I\s + - (?:^|\s)I,\s + - \bI'm\b + - \bme\b + - \bmy\b + - \bmine\b \ No newline at end of file diff --git a/vale-styles/FluentBit/FutureTense.yml b/vale-styles/FluentBit/FutureTense.yml new file mode 100644 index 000000000..17d1bd6a6 --- /dev/null +++ b/vale-styles/FluentBit/FutureTense.yml @@ -0,0 +1,10 @@ +--- +extends: existence +message: "'%s' might be in future tense. Strive for active voice and present tense in your documentation." +ignorecase: true +level: suggestion +raw: + - "(going to( |\n|[[:punct:]])[a-zA-Z]*|" + - "will( |\n|[[:punct:]])[a-zA-Z]*|" + - "won't( |\n|[[:punct:]])[a-zA-Z]*|" + - "[a-zA-Z]*'ll( |\n|[[:punct:]])[a-zA-Z]*)" diff --git a/vale-styles/FluentBit/Gender.yml b/vale-styles/FluentBit/Gender.yml new file mode 100644 index 000000000..9b5689ebd --- /dev/null +++ b/vale-styles/FluentBit/Gender.yml @@ -0,0 +1,9 @@ +extends: existence +message: "Don't use '%s' as a gender-neutral pronoun." +link: 'https://developers.google.com/style/pronouns#gender-neutral-pronouns' +level: suggestion +ignorecase: true +tokens: + - he/she + - s/he + - \(s\)he \ No newline at end of file diff --git a/vale-styles/FluentBit/GenderBias.yml b/vale-styles/FluentBit/GenderBias.yml new file mode 100644 index 000000000..3a3b6985e --- /dev/null +++ b/vale-styles/FluentBit/GenderBias.yml @@ -0,0 +1,45 @@ +extends: substitution +message: "Consider using '%s' instead of '%s'." +link: 'https://developers.google.com/style/inclusive-documentation' +ignorecase: true +level: suggestion +swap: + (?:alumna|alumnus): graduate + (?:alumnae|alumni): graduates + air(?:m[ae]n|wom[ae]n): pilot(s) + anchor(?:m[ae]n|wom[ae]n): anchor(s) + authoress: author + camera(?:m[ae]n|wom[ae]n): camera operator(s) + chair(?:m[ae]n|wom[ae]n): chair(s) + congress(?:m[ae]n|wom[ae]n): member(s) of congress + door(?:m[ae]|wom[ae]n): concierge(s) + draft(?:m[ae]n|wom[ae]n): drafter(s) + fire(?:m[ae]n|wom[ae]n): firefighter(s) + fisher(?:m[ae]n|wom[ae]n): fisher(s) + fresh(?:m[ae]n|wom[ae]n): first-year student(s) + garbage(?:m[ae]n|wom[ae]n): waste collector(s) + lady lawyer: lawyer + ladylike: courteous + landlord: building manager + mail(?:m[ae]n|wom[ae]n): mail carriers + man and wife: husband and wife + man enough: strong enough + mankind: human kind + manmade: manufactured + manpower: personnel + men and girls: men and women + middle(?:m[ae]n|wom[ae]n): intermediary + news(?:m[ae]n|wom[ae]n): journalist(s) + ombuds(?:man|woman): ombuds + oneupmanship: upstaging + poetess: poet + police(?:m[ae]n|wom[ae]n): police officer(s) + repair(?:m[ae]n|wom[ae]n): technician(s) + sales(?:m[ae]n|wom[ae]n): salesperson or sales people + service(?:m[ae]n|wom[ae]n): soldier(s) + steward(?:ess)?: flight attendant + tribes(?:m[ae]n|wom[ae]n): tribe member(s) + waitress: waiter + woman doctor: doctor + woman scientist[s]?: scientist(s) + work(?:m[ae]n|wom[ae]n): worker(s) \ No newline at end of file diff --git a/vale-styles/FluentBit/HeadingPunctuation.yml b/vale-styles/FluentBit/HeadingPunctuation.yml new file mode 100644 index 000000000..659260b27 --- /dev/null +++ b/vale-styles/FluentBit/HeadingPunctuation.yml @@ -0,0 +1,13 @@ +extends: existence +message: "Don't put a period at the end of a heading." +link: 'https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings' +nonword: true +level: suggestion +scope: heading +action: + name: edit + params: + - remove + - '.' +tokens: + - '[a-z0-9][.]\s*$' \ No newline at end of file diff --git a/vale-styles/FluentBit/Headings.yml b/vale-styles/FluentBit/Headings.yml new file mode 100644 index 000000000..2be26b3b3 --- /dev/null +++ b/vale-styles/FluentBit/Headings.yml @@ -0,0 +1,73 @@ +extends: capitalization +message: "'%s' should use sentence-style capitalization." +link: 'https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings' +level: suggestion +scope: heading +match: $sentence +indicators: + - ':' +exceptions: + - Amazon + - Amazon CloudWatch + - Amazon Kinesis Firehose + - Amazon Kinesis Streams + - API + - APIs + - Azure + - BuildKite + - CircleCI + - CLI + - CloudWatch + - Code + - Collector + - Cosmos + - Crowdstrike + - cURL + - Datadog + - Docker + - DogStatsD + - Elastic Cloud + - Emmet + - EventBridge + - Fluent Bit + - GCP + - GitLab + - GitHub + - Google + - Google Cloud + - Google Cloud Platform + - Grafana + - gRPC + - I + - InfluxDB + - Kinesis + - Kubernetes + - LaunchDarkly + - Linux + - macOS + - Marketplace + - MongoDB + - New Relic + - Observability Platform + - Okta + - OpenMetrics + - OpenTelemetry + - Opsgenie + - PagerDuty + - Prometheus + - PromQL + - REPL + - ServiceMonitor + - SignalFx + - Slack + - StatsD + - Studio + - Tanzu + - Telemetry Pipeline + - Terraform + - TypeScript + - URLs + - VictorOps + - Visual + - VS + - Windows diff --git a/vale-styles/FluentBit/Latin.yml b/vale-styles/FluentBit/Latin.yml new file mode 100644 index 000000000..ca6f3abb7 --- /dev/null +++ b/vale-styles/FluentBit/Latin.yml @@ -0,0 +1,17 @@ +extends: substitution +message: "Use '%s' instead of '%s'." +link: 'https://developers.google.com/style/abbreviations' +ignorecase: true +level: suggestion +nonword: true +action: + name: replace +swap: + '\b(?:eg|e\.g\.)[\s,]': for example + '\b(?:ie|i\.e\.)[\s,]': that is + 'ad-hoc': if needed + '[\s]et al[\s]': and others + '[\s]etc[\s|.]': and so on + '[\s]via[\s]': through or by using + 'vice versa': and the reverse + '[\s]vs[\s|.]': versus diff --git a/vale-styles/FluentBit/LyHyphens.yml b/vale-styles/FluentBit/LyHyphens.yml new file mode 100644 index 000000000..97e092a33 --- /dev/null +++ b/vale-styles/FluentBit/LyHyphens.yml @@ -0,0 +1,14 @@ +extends: existence +message: "'%s' doesn't need a hyphen." +link: 'https://developers.google.com/style/hyphens' +level: suggestion +ignorecase: false +nonword: true +action: + name: edit + params: + - replace + - '-' + - ' ' +tokens: + - '\s[^\s-]+ly-' \ No newline at end of file diff --git a/vale-styles/FluentBit/MayMightCan.yml b/vale-styles/FluentBit/MayMightCan.yml new file mode 100644 index 000000000..56ce95f06 --- /dev/null +++ b/vale-styles/FluentBit/MayMightCan.yml @@ -0,0 +1,7 @@ +--- +extends: existence +message: "Use 'can' for permissions or 'might' for possibility." +level: suggestion +ignorecase: true +tokens: + - may diff --git a/vale-styles/FluentBit/NonStandardQuotes.yml b/vale-styles/FluentBit/NonStandardQuotes.yml new file mode 100644 index 000000000..40feaafb3 --- /dev/null +++ b/vale-styles/FluentBit/NonStandardQuotes.yml @@ -0,0 +1,8 @@ +--- +extends: existence +message: 'Use standard single quotes or double quotes only. Do not use left or right quotes.' +level: suggestion +ignorecase: true +scope: raw +raw: + - '[‘’“”]' diff --git a/vale-styles/FluentBit/OptionalPlurals.yml b/vale-styles/FluentBit/OptionalPlurals.yml new file mode 100644 index 000000000..50bf2c247 --- /dev/null +++ b/vale-styles/FluentBit/OptionalPlurals.yml @@ -0,0 +1,12 @@ +extends: existence +message: "Don't use plurals in parentheses such as in '%s'." +link: 'https://developers.google.com/style/plurals-parentheses' +level: suggestion +nonword: true +action: + name: edit + params: + - remove + - '(s)' +tokens: + - '\b\w+\(s\)' diff --git a/vale-styles/FluentBit/Ordinal.yml b/vale-styles/FluentBit/Ordinal.yml new file mode 100644 index 000000000..cd836d5a5 --- /dev/null +++ b/vale-styles/FluentBit/Ordinal.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Spell out all ordinal numbers ('%s') in text." +link: 'https://developers.google.com/style/numbers' +level: suggestion +nonword: true +tokens: + - \d+(?:st|nd|rd|th) \ No newline at end of file diff --git a/vale-styles/FluentBit/Passive.yml b/vale-styles/FluentBit/Passive.yml new file mode 100644 index 000000000..b52c01204 --- /dev/null +++ b/vale-styles/FluentBit/Passive.yml @@ -0,0 +1,184 @@ +extends: existence +link: 'https://developers.google.com/style/voice' +message: "In general, use active voice instead of passive voice ('%s')." +ignorecase: true +level: suggestion +raw: + - \b(am|are|were|being|is|been|was|be)\b\s* +tokens: + - '[\w]+ed' + - awoken + - beat + - become + - been + - begun + - bent + - beset + - bet + - bid + - bidden + - bitten + - bled + - blown + - born + - bought + - bound + - bred + - broadcast + - broken + - brought + - built + - burnt + - burst + - cast + - caught + - chosen + - clung + - come + - cost + - crept + - cut + - dealt + - dived + - done + - drawn + - dreamt + - driven + - drunk + - dug + - eaten + - fallen + - fed + - felt + - fit + - fled + - flown + - flung + - forbidden + - foregone + - forgiven + - forgotten + - forsaken + - fought + - found + - frozen + - given + - gone + - gotten + - ground + - grown + - heard + - held + - hidden + - hit + - hung + - hurt + - kept + - knelt + - knit + - known + - laid + - lain + - leapt + - learnt + - led + - left + - lent + - let + - lighted + - lost + - made + - meant + - met + - misspelt + - mistaken + - mown + - overcome + - overdone + - overtaken + - overthrown + - paid + - pled + - proven + - put + - quit + - read + - rid + - ridden + - risen + - run + - rung + - said + - sat + - sawn + - seen + - sent + - set + - sewn + - shaken + - shaven + - shed + - shod + - shone + - shorn + - shot + - shown + - shrunk + - shut + - slain + - slept + - slid + - slit + - slung + - smitten + - sold + - sought + - sown + - sped + - spent + - spilt + - spit + - split + - spoken + - spread + - sprung + - spun + - stolen + - stood + - stridden + - striven + - struck + - strung + - stuck + - stung + - stunk + - sung + - sunk + - swept + - swollen + - sworn + - swum + - swung + - taken + - taught + - thought + - thrived + - thrown + - thrust + - told + - torn + - trodden + - understood + - upheld + - upset + - wed + - wept + - withheld + - withstood + - woken + - won + - worn + - wound + - woven + - written + - wrung \ No newline at end of file diff --git a/vale-styles/FluentBit/Periods.yml b/vale-styles/FluentBit/Periods.yml new file mode 100644 index 000000000..0333c3160 --- /dev/null +++ b/vale-styles/FluentBit/Periods.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Don't use periods with acronyms or initialisms such as '%s'." +link: 'https://developers.google.com/style/abbreviations' +level: suggestion +nonword: true +tokens: + - '\b(?:[A-Z]\.){3,}' \ No newline at end of file diff --git a/vale-styles/FluentBit/Possessives.yml b/vale-styles/FluentBit/Possessives.yml new file mode 100644 index 000000000..1d0a74e0c --- /dev/null +++ b/vale-styles/FluentBit/Possessives.yml @@ -0,0 +1,7 @@ +--- +extends: existence +message: "Rewrite '%s' to not use 's." +level: suggestion +ignorecase: true +tokens: + - Bit's diff --git a/vale-styles/FluentBit/Quotes.yml b/vale-styles/FluentBit/Quotes.yml new file mode 100644 index 000000000..f9c927459 --- /dev/null +++ b/vale-styles/FluentBit/Quotes.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Commas and periods go inside quotation marks." +link: 'https://developers.google.com/style/quotation-marks' +level: suggestion +nonword: true +tokens: + - '"[^"]+"[.,?]' \ No newline at end of file diff --git a/vale-styles/FluentBit/Ranges.yml b/vale-styles/FluentBit/Ranges.yml new file mode 100644 index 000000000..78af6f999 --- /dev/null +++ b/vale-styles/FluentBit/Ranges.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Don't add words such as 'from' or 'between' to describe a range of numbers." +link: 'https://developers.google.com/style/hyphens' +nonword: true +level: suggestion +tokens: + - '(?:from|between)\s\d+\s?-\s?\d+' \ No newline at end of file diff --git a/vale-styles/FluentBit/Repetition.yml b/vale-styles/FluentBit/Repetition.yml new file mode 100644 index 000000000..a5158b8b9 --- /dev/null +++ b/vale-styles/FluentBit/Repetition.yml @@ -0,0 +1,7 @@ +--- +extends: repetition +message: '"%s" is repeated.' +level: suggestion +alpha: true +tokens: + - '[^\s]+' diff --git a/vale-styles/FluentBit/SentenceLengthLong.yml b/vale-styles/FluentBit/SentenceLengthLong.yml new file mode 100644 index 000000000..556580b10 --- /dev/null +++ b/vale-styles/FluentBit/SentenceLengthLong.yml @@ -0,0 +1,7 @@ +--- +extends: occurrence +message: "Improve readability by using fewer than 35 words in this sentence." +scope: sentence +level: suggestion +max: 35 +token: \b(\w+)\b diff --git a/vale-styles/FluentBit/Simplicity.yml b/vale-styles/FluentBit/Simplicity.yml new file mode 100644 index 000000000..e9b779763 --- /dev/null +++ b/vale-styles/FluentBit/Simplicity.yml @@ -0,0 +1,12 @@ +--- +extends: existence +message: 'Avoid words like "%s" that imply ease of use, because the user may find this action difficult.' +level: suggestion +ignorecase: true +tokens: + - easy + - easily + - handy + - simple + - simply + - useful diff --git a/vale-styles/FluentBit/Slang.yml b/vale-styles/FluentBit/Slang.yml new file mode 100644 index 000000000..b43eeb299 --- /dev/null +++ b/vale-styles/FluentBit/Slang.yml @@ -0,0 +1,11 @@ +extends: existence +message: "Don't use internet slang abbreviations such as '%s'." +link: 'https://developers.google.com/style/abbreviations' +ignorecase: true +level: suggestion +tokens: + - 'tl;dr' + - ymmv + - rtfm + - imo + - fwiw \ No newline at end of file diff --git a/vale-styles/FluentBit/Spacing.yml b/vale-styles/FluentBit/Spacing.yml new file mode 100644 index 000000000..57c52f046 --- /dev/null +++ b/vale-styles/FluentBit/Spacing.yml @@ -0,0 +1,8 @@ +extends: existence +message: "'%s' should have one space." +link: 'https://developers.google.com/style/sentence-spacing' +level: suggestion +nonword: true +tokens: + - '[a-z][.?!] {2,}[A-Z]' + - '[a-z][.?!][A-Z]' \ No newline at end of file diff --git a/vale-styles/FluentBit/Spelling-exceptions.txt b/vale-styles/FluentBit/Spelling-exceptions.txt new file mode 100644 index 000000000..075e4284b --- /dev/null +++ b/vale-styles/FluentBit/Spelling-exceptions.txt @@ -0,0 +1,178 @@ +accessor +Alertmanager +allowlist +API +APIs +Appname +autoscale +autoscaler +autoscaling +backoff +Blackhole +blocklist +Buildkite +cAdvisor +Calyptia +chronotf +clickstreams +CloudWatch +Config +Coralogix +Crowdstrike +CRDs +DaemonSet +Datadog +Datagen +datapoint +datapoints +declaratively +deduplicate +Deployer +deprovision +deprovisioned +deprovisioning +deprovisions +Devo +DogStatsD +downsample +downsampled +downsamples +downsampling +downscale +downscaling +downscales +dri +Dynatrace +Elasticsearch +endcode +endhint +endtab +endtabs +Exabeam +Fargate +Firehose +FluentBit +Fluentd +Golang +golib +Grafana +Graphite +Greylog +grpc_code +grpc_method +grpc_service +gzip +HashiCorp +hostname +Hostname +Ingester +Keepalive +Istio +keepalive +Kinesis +kubectl +kubelet +Kubernetes +Kusto +labelset +loadgenerator +Logstash +Lua +Lucene +macOS +Mandiant +matchers +Minishift +minikube +MTTx +namespace +namespaces +Nginx +OAuth +Okta +Oniguruma +OpenTelemetry +Opsgenie +OTel +PagerDuty +performant +persistable +Postgres +PowerShell +prepopulate +Profiler +Prometheus +PromQL +Protobuf +proxying +Pulumi +Pushgateway +quantile +quantiles +queryable +Queryable +rdkafka +Redpanda +rollup +Rollup +rollups +Rollups +routable +runbook +runbooks +Scalyr +SDKs +SELinux +serverless +ServiceDiscovery +ServiceMonitor +ServiceMonitors +sharding +SignalFx +Signup +sparkline +sparklines +Sparklines +Splunk +Stackdriver +StatsD +stderr +stdout +strftime +subcommand +subcommands +subquery +subrecord +substring +syslog +systemctl +Systemd +Tanzu +Telegraf +templated +temporality +Terraform +Thanos +Timeshift +tolerations +tooltip +tooltips +uber +unaggregated +unary +Unary +unmuted +unsort +UUIDs +Vectra +Vercel +VictoriaMetrics +VictorOps +Vivo +VMs +Wavefront +Worldmap +Zipkin +Zsh +Zstandard +zstd diff --git a/vale-styles/FluentBit/Spelling.yml b/vale-styles/FluentBit/Spelling.yml new file mode 100644 index 000000000..46cc6dc74 --- /dev/null +++ b/vale-styles/FluentBit/Spelling.yml @@ -0,0 +1,5 @@ +extends: spelling +message: "Spelling check: '%s'?" +level: suggestion +ignore: + - FluentBit/Spelling-exceptions.txt diff --git a/vale-styles/FluentBit/Subjunctive.yml b/vale-styles/FluentBit/Subjunctive.yml new file mode 100644 index 000000000..f7087389c --- /dev/null +++ b/vale-styles/FluentBit/Subjunctive.yml @@ -0,0 +1,14 @@ +--- +extends: existence +message: "Use the indicative or imperative moods when writing docs." +ignorecase: true +level: suggestion +tokens: + - should + - shouldn't + - should not + - won't + - would + - wouldn't + - could + - couldn't diff --git a/vale-styles/FluentBit/Terms.yml b/vale-styles/FluentBit/Terms.yml new file mode 100644 index 000000000..6ad4cf2e3 --- /dev/null +++ b/vale-styles/FluentBit/Terms.yml @@ -0,0 +1,13 @@ +--- +extends: substitution +message: Use '%s' instead of '%s'. +level: suggestion +ignorecase: true +scope: paragraph +action: + name: replace +swap: + datapoints: data points + Terraform Provider: Terraform provider + timeseries: time series + topology: placement diff --git a/vale-styles/FluentBit/Units.yml b/vale-styles/FluentBit/Units.yml new file mode 100644 index 000000000..786c1d8bb --- /dev/null +++ b/vale-styles/FluentBit/Units.yml @@ -0,0 +1,11 @@ +extends: existence +message: "Put a nonbreaking space between the number and the unit in '%s'." +link: 'https://developers.google.com/style/units-of-measure' +nonword: true +level: suggestion +tokens: + - \d+(?:B|kB|MB|GB|TB) + - \d+(?:ns|ms|s|min|h|d) + +exceptions: + - k3s diff --git a/vale-styles/FluentBit/UserFocus.yml b/vale-styles/FluentBit/UserFocus.yml new file mode 100644 index 000000000..340ad71e7 --- /dev/null +++ b/vale-styles/FluentBit/UserFocus.yml @@ -0,0 +1,17 @@ +--- +extends: existence +message: "Rewrite to put the focus on what the user wants to do rather than on how the document is laid out." +ignorecase: true +level: suggestion +tokens: + - The purpose of this document is + - This document (?:describes|explains|shows) + - This page (?:describes|explains|shows) + - This page (?:describes|explains|shows) + - This document (?:describes|explains|shows) + - This section (?:describes|explains|shows) + - This section (?:describes|explains|shows) + - The following page (?:describes|explains|shows) + - The following document (?:describes|explains|shows) + - The following section (?:describes|explains|shows) + - This topic (?:describes|explains|shows) diff --git a/vale-styles/FluentBit/We.yml b/vale-styles/FluentBit/We.yml new file mode 100644 index 000000000..ffe69e65d --- /dev/null +++ b/vale-styles/FluentBit/We.yml @@ -0,0 +1,11 @@ +extends: existence +message: "Try to avoid using first-person plural like '%s'." +link: 'https://developers.google.com/style/pronouns#personal-pronouns' +level: suggestion +ignorecase: true +tokens: + - we + - we'(?:ve|re) + - ours? + - us + - let's \ No newline at end of file diff --git a/vale-styles/FluentBit/WordList.yml b/vale-styles/FluentBit/WordList.yml new file mode 100644 index 000000000..aca77474a --- /dev/null +++ b/vale-styles/FluentBit/WordList.yml @@ -0,0 +1,79 @@ +extends: substitution +message: "Use '%s' instead of '%s'." +link: 'https://developers.google.com/style/word-list' +level: suggestion +ignorecase: false +action: + name: replace +swap: + '(?:API Console|dev|developer) key': API key + '(?:cell ?phone|smart ?phone)': phone|mobile phone + '(?:dev|developer|APIs) console': API console + '(?:e-mail|Email|E-mail)': email + '(?:file ?path|path ?name)': path + '(?:kill|terminate|abort)': stop|exit|cancel|end + '(?:OAuth ?2|Oauth)': OAuth 2.0 + '(?:ok|Okay)': OK|okay + '(?:WiFi|wifi)': Wi-Fi + '[\.]+apk': APK + '3\-D': 3D + 'Google (?:I\-O|IO)': Google I/O + 'tap (?:&|and) hold': touch & hold + 'un(?:check|select)': clear + # account name: username + action bar: app bar + admin: administrator + Ajax: AJAX + allows you to: lets you + Android device: Android-powered device + android: Android + API explorer: APIs Explorer + application: app + approx\.: approximately + as well as: and + authN: authentication + authZ: authorization + autoupdate: automatically update + cellular data: mobile data + cellular network: mobile network + chapter: documents|pages|sections + check box: checkbox + check: select + click on: click|click in + Container Engine: Kubernetes Engine + content type: media type + curated roles: predefined roles + data are: data is + Developers Console: Google API Console|API Console + ephemeral IP address: ephemeral external IP address + fewer data: less data + file name: filename + firewalls: firewall rules + functionality: capability|feature + Google account: Google Account + Google accounts: Google Accounts + Googling: search with Google + grayed-out: unavailable + HTTPs: HTTPS + in order to: to + # ingest: import|load + k8s: Kubernetes + long press: touch & hold + network IP address: internal IP address + omnibox: address bar + open-source: open source + overview screen: recents screen + regex: regular expression + SHA1: SHA-1|HAS-SHA1 + sign into: sign in to + \w* ?sign-?on: single sign-on + static IP address: static external IP address + stylesheet: style sheet + synch: sync + tablename: table name + tablet: device + touch: tap + url: URL + vs\.: versus + wish: want + World Wide Web: web