From 75b334ebabaaad17981e732cb9fbd459f74a98b2 Mon Sep 17 00:00:00 2001 From: Erin Cochran Date: Tue, 20 Aug 2024 12:17:01 -0400 Subject: [PATCH] [docs] [revamp] - Beefing up Vale (#23754) ## Summary & Motivation This PR beefs up our Vale implementation with some custom rules and vocabularies. The README for this will be updated in a subsequent PR. ## How I Tested These Changes eyes, local --- docs/.vale.ini | 46 +++-- .../Acronyms.yml => Dagster/acronyms.yml} | 5 + ...hitespace.yml => chars-eol-whitespace.yml} | 1 - ...otes.yml => chars-non-standard-quotes.yml} | 0 .../{Google/Colons.yml => Dagster/colons.yml} | 4 +- .../contractions.yml} | 2 +- docs/vale/styles/Dagster/dagster_terms.yml | 20 -- .../{Google/EmDash.yml => Dagster/dashes.yml} | 3 +- docs/vale/styles/Dagster/gender.yml | 14 ++ .../styles/Dagster/heading-characters.yml | 11 ++ docs/vale/styles/Dagster/heading-content.yml | 1 - docs/vale/styles/Dagster/headings-casing.yml | 8 + ...heading-gerund.yml => headings-gerund.yml} | 3 + .../LyHyphens.yml => Dagster/hyphens.yml} | 0 .../Dagster/{latin-terms.yml => latin.yml} | 0 docs/vale/styles/Dagster/link-text.yml | 26 +++ docs/vale/styles/Dagster/missing-tos.yml | 9 + .../optional-plurals.yaml} | 4 +- .../OxfordComma.yml => Dagster/oxford.yml} | 2 +- .../Parens.yml => Dagster/parentheses.yml} | 0 docs/vale/styles/Dagster/programming.yml | 13 -- .../quotes-punctuation.yaml} | 4 +- docs/vale/styles/Dagster/readability.yml | 8 + docs/vale/styles/Dagster/repeated-words.yml | 8 + .../styles/Dagster/section-heading-depth.yml | 7 - .../Dagster/section-heading-sentence-case.yml | 5 - .../Dagster/sentence-length-variety.yml | 45 +++++ docs/vale/styles/Dagster/spacing.yaml | 10 + docs/vale/styles/Dagster/spelling.yml | 6 + docs/vale/styles/Dagster/todos.yml | 11 ++ .../Dagster/{wordy.yml => wordiness.yml} | 5 +- docs/vale/styles/Google/AMPM.yml | 9 - docs/vale/styles/Google/DateFormat.yml | 9 - docs/vale/styles/Google/Ellipses.yml | 9 - docs/vale/styles/Google/Exclamation.yml | 12 -- docs/vale/styles/Google/FirstPerson.yml | 13 -- docs/vale/styles/Google/Gender.yml | 9 - docs/vale/styles/Google/GenderBias.yml | 43 ---- .../vale/styles/Google/HeadingPunctuation.yml | 13 -- docs/vale/styles/Google/Headings.yml | 29 --- docs/vale/styles/Google/Latin.yml | 11 -- docs/vale/styles/Google/Ordinal.yml | 7 - docs/vale/styles/Google/Passive.yml | 184 ------------------ docs/vale/styles/Google/Ranges.yml | 7 - docs/vale/styles/Google/Semicolons.yml | 8 - docs/vale/styles/Google/Slang.yml | 11 -- docs/vale/styles/Google/Spelling.yml | 10 - docs/vale/styles/Google/Units.yml | 8 - docs/vale/styles/Google/We.yml | 11 -- docs/vale/styles/Google/Will.yml | 7 - docs/vale/styles/Google/WordList.yml | 80 -------- docs/vale/styles/Google/meta.json | 4 - docs/vale/styles/Google/vocab.txt | 0 docs/vale/styles/Terms/dagster-ui.yml | 26 +++ docs/vale/styles/Terms/dagster.yml | 14 ++ docs/vale/styles/Terms/engineering.yml | 25 +++ docs/vale/styles/Terms/words.yml | 21 ++ docs/vale/styles/config/ignore/ignore.txt | 9 + .../config/vocabularies/Dagster/accept.txt | 39 ++-- .../config/vocabularies/Dagster/reject.txt | 12 +- 60 files changed, 331 insertions(+), 590 deletions(-) rename docs/vale/styles/{Google/Acronyms.yml => Dagster/acronyms.yml} (95%) rename docs/vale/styles/Dagster/{eol-whitespace.yml => chars-eol-whitespace.yml} (98%) rename docs/vale/styles/Dagster/{non-standard-quotes.yml => chars-non-standard-quotes.yml} (100%) rename docs/vale/styles/{Google/Colons.yml => Dagster/colons.yml} (65%) rename docs/vale/styles/{Google/Contractions.yml => Dagster/contractions.yml} (96%) delete mode 100644 docs/vale/styles/Dagster/dagster_terms.yml rename docs/vale/styles/{Google/EmDash.yml => Dagster/dashes.yml} (91%) create mode 100644 docs/vale/styles/Dagster/gender.yml create mode 100644 docs/vale/styles/Dagster/heading-characters.yml create mode 100644 docs/vale/styles/Dagster/headings-casing.yml rename docs/vale/styles/Dagster/{section-heading-gerund.yml => headings-gerund.yml} (56%) rename docs/vale/styles/{Google/LyHyphens.yml => Dagster/hyphens.yml} (100%) rename docs/vale/styles/Dagster/{latin-terms.yml => latin.yml} (100%) create mode 100644 docs/vale/styles/Dagster/link-text.yml create mode 100644 docs/vale/styles/Dagster/missing-tos.yml rename docs/vale/styles/{Google/OptionalPlurals.yml => Dagster/optional-plurals.yaml} (67%) rename docs/vale/styles/{Google/OxfordComma.yml => Dagster/oxford.yml} (79%) rename docs/vale/styles/{Google/Parens.yml => Dagster/parentheses.yml} (100%) delete mode 100644 docs/vale/styles/Dagster/programming.yml rename docs/vale/styles/{Google/Quotes.yml => Dagster/quotes-punctuation.yaml} (54%) create mode 100644 docs/vale/styles/Dagster/readability.yml create mode 100644 docs/vale/styles/Dagster/repeated-words.yml delete mode 100644 docs/vale/styles/Dagster/section-heading-depth.yml delete mode 100644 docs/vale/styles/Dagster/section-heading-sentence-case.yml create mode 100644 docs/vale/styles/Dagster/sentence-length-variety.yml create mode 100644 docs/vale/styles/Dagster/spacing.yaml create mode 100644 docs/vale/styles/Dagster/spelling.yml create mode 100644 docs/vale/styles/Dagster/todos.yml rename docs/vale/styles/Dagster/{wordy.yml => wordiness.yml} (85%) delete mode 100644 docs/vale/styles/Google/AMPM.yml delete mode 100644 docs/vale/styles/Google/DateFormat.yml delete mode 100644 docs/vale/styles/Google/Ellipses.yml delete mode 100644 docs/vale/styles/Google/Exclamation.yml delete mode 100644 docs/vale/styles/Google/FirstPerson.yml delete mode 100644 docs/vale/styles/Google/Gender.yml delete mode 100644 docs/vale/styles/Google/GenderBias.yml delete mode 100644 docs/vale/styles/Google/HeadingPunctuation.yml delete mode 100644 docs/vale/styles/Google/Headings.yml delete mode 100644 docs/vale/styles/Google/Latin.yml delete mode 100644 docs/vale/styles/Google/Ordinal.yml delete mode 100644 docs/vale/styles/Google/Passive.yml delete mode 100644 docs/vale/styles/Google/Ranges.yml delete mode 100644 docs/vale/styles/Google/Semicolons.yml delete mode 100644 docs/vale/styles/Google/Slang.yml delete mode 100644 docs/vale/styles/Google/Spelling.yml delete mode 100644 docs/vale/styles/Google/Units.yml delete mode 100644 docs/vale/styles/Google/We.yml delete mode 100644 docs/vale/styles/Google/Will.yml delete mode 100644 docs/vale/styles/Google/WordList.yml delete mode 100644 docs/vale/styles/Google/meta.json delete mode 100644 docs/vale/styles/Google/vocab.txt create mode 100644 docs/vale/styles/Terms/dagster-ui.yml create mode 100644 docs/vale/styles/Terms/dagster.yml create mode 100644 docs/vale/styles/Terms/engineering.yml create mode 100644 docs/vale/styles/Terms/words.yml create mode 100644 docs/vale/styles/config/ignore/ignore.txt diff --git a/docs/.vale.ini b/docs/.vale.ini index fdabbe6f26ece..896897ec2950b 100644 --- a/docs/.vale.ini +++ b/docs/.vale.ini @@ -1,28 +1,36 @@ -StylesPath = "vale/styles" -MinAlertLevel = suggestion +######################## +# ABOUT # +######################## -Packages = Google -Vocab = Dagster +# This file controls the Vale application, specifically what, where, and how it lints. -[*.{md,mdx,rst}] -BasedOnStyles = Vale, Google, Dagster +# Vale config reference: https://vale.sh/docs/topics/config +# INI syntax: https://ini.unknwon.io/docs/intro -; Ignore all :py directives -IgnorePatterns = (:py:[^`]+`[^`]+`) +######################## +# CORE SETTINGS # +######################## + +StylesPath = "vale/styles" +MinAlertLevel = suggestion +Vocab = Dagster -; Error on headings that aren't sentence cased. -Google.Headings = Error +######################## +# FORMAT ASSOCIATIONS # +######################## -; Google avoids using will, we don't need to check for this -Google.Will = NO -Google.WordList = NO +[formats] +mdx = md -; Exclamation is fine -Google.Exclamation = NO +######################## +# FORMAT-SPECIFIC # +######################## -; Passive is a bit too noisy -Google.Passive = NO +[*.{md,mdx,rst}] +# Rules in this section are enforced in all md, mdx, and rst files +[*.{md,mdx,rst}] +BasedOnStyles = Dagster, Terms, Vale -[formats] -mdx = md +; Ignore all :py directives +IgnorePatterns = (:py:[^`]+`[^`]+`) \ No newline at end of file diff --git a/docs/vale/styles/Google/Acronyms.yml b/docs/vale/styles/Dagster/acronyms.yml similarity index 95% rename from docs/vale/styles/Google/Acronyms.yml rename to docs/vale/styles/Dagster/acronyms.yml index f41af0189b071..a87db8a31f888 100644 --- a/docs/vale/styles/Google/Acronyms.yml +++ b/docs/vale/styles/Dagster/acronyms.yml @@ -17,6 +17,7 @@ exceptions: - DEBUG - DOM - DPI + - ETL - FAQ - GCC - GDB @@ -43,10 +44,13 @@ exceptions: - POST - RAM - REPL + - REST - RSA - SCM - SCSS + - SDA - SDK + - SFTP - SQL - SSH - SSL @@ -54,6 +58,7 @@ exceptions: - TBD - TCP - TODO + - UI - URI - URL - USB diff --git a/docs/vale/styles/Dagster/eol-whitespace.yml b/docs/vale/styles/Dagster/chars-eol-whitespace.yml similarity index 98% rename from docs/vale/styles/Dagster/eol-whitespace.yml rename to docs/vale/styles/Dagster/chars-eol-whitespace.yml index 03664c2c0b061..263bdb805a7de 100644 --- a/docs/vale/styles/Dagster/eol-whitespace.yml +++ b/docs/vale/styles/Dagster/chars-eol-whitespace.yml @@ -1,4 +1,3 @@ ---- extends: existence message: "Remove whitespace characters from the end of the line." link: https://docs.gitlab.com/ee/development/documentation/versions.html diff --git a/docs/vale/styles/Dagster/non-standard-quotes.yml b/docs/vale/styles/Dagster/chars-non-standard-quotes.yml similarity index 100% rename from docs/vale/styles/Dagster/non-standard-quotes.yml rename to docs/vale/styles/Dagster/chars-non-standard-quotes.yml diff --git a/docs/vale/styles/Google/Colons.yml b/docs/vale/styles/Dagster/colons.yml similarity index 65% rename from docs/vale/styles/Google/Colons.yml rename to docs/vale/styles/Dagster/colons.yml index 99363fbd46d78..b7ff06e47f577 100644 --- a/docs/vale/styles/Google/Colons.yml +++ b/docs/vale/styles/Dagster/colons.yml @@ -1,3 +1,5 @@ +## This rule finds capitalized words immediately following a colon (:) + extends: existence message: "'%s' should be in lowercase." link: 'https://developers.google.com/style/colons' @@ -5,4 +7,4 @@ nonword: true level: warning scope: sentence tokens: - - ':\s[A-Z]' + - ':\s[A-Z]' \ No newline at end of file diff --git a/docs/vale/styles/Google/Contractions.yml b/docs/vale/styles/Dagster/contractions.yml similarity index 96% rename from docs/vale/styles/Google/Contractions.yml rename to docs/vale/styles/Dagster/contractions.yml index 4f6fd5d489dcb..17f3d1d267c70 100644 --- a/docs/vale/styles/Google/Contractions.yml +++ b/docs/vale/styles/Dagster/contractions.yml @@ -27,4 +27,4 @@ swap: what is: what's when is: when's where is: where's - will not: won't + will not: won't \ No newline at end of file diff --git a/docs/vale/styles/Dagster/dagster_terms.yml b/docs/vale/styles/Dagster/dagster_terms.yml deleted file mode 100644 index 9359242e2f7aa..0000000000000 --- a/docs/vale/styles/Dagster/dagster_terms.yml +++ /dev/null @@ -1,20 +0,0 @@ -extends: substitution -message: Use '%s' instead of '%s' when referring to a Dagster term. -level: warning -ignorecase: false -action: - name: replace -# swap maps tokens in form of bad: good -swap: - account id: Account Id - grpc: gRPC - '\bheartbeat\b': Heartbeat - id: ID - IDs: IDs - pre-release: Pre-Release - public preview: Public Preview - run id: Run Id - '\bdagster': Dagster - '[Dd]agster [Cc]loud': Dagster Plus - '\bworker\b': Worker - '[Aa]sset Sensor': Asset sensor \ No newline at end of file diff --git a/docs/vale/styles/Google/EmDash.yml b/docs/vale/styles/Dagster/dashes.yml similarity index 91% rename from docs/vale/styles/Google/EmDash.yml rename to docs/vale/styles/Dagster/dashes.yml index 5a81fb0942e69..ad0625af0b748 100644 --- a/docs/vale/styles/Google/EmDash.yml +++ b/docs/vale/styles/Dagster/dashes.yml @@ -9,5 +9,4 @@ action: - trim - " " tokens: - - '\s[—–]\s' - + - '\s[—–]\s' \ No newline at end of file diff --git a/docs/vale/styles/Dagster/gender.yml b/docs/vale/styles/Dagster/gender.yml new file mode 100644 index 0000000000000..286c763778dc3 --- /dev/null +++ b/docs/vale/styles/Dagster/gender.yml @@ -0,0 +1,14 @@ +extends: existence +message: "Use a gender-neutral pronoun instead of '%s'." +link: "https://github.com/DataDog/documentation/blob/master/CONTRIBUTING.md#gender" +level: error +ignorecase: true +tokens: + - he/she + - s/he + - \(s\)he + - \bhe\b + - \bhim\b + - \bhis\b + - \bshe\b + - \bher\b \ No newline at end of file diff --git a/docs/vale/styles/Dagster/heading-characters.yml b/docs/vale/styles/Dagster/heading-characters.yml new file mode 100644 index 0000000000000..e08b6f7db3eaa --- /dev/null +++ b/docs/vale/styles/Dagster/heading-characters.yml @@ -0,0 +1,11 @@ +## This rule finds non-allowed characters in headings +## WHY? Headings don't need periods or formatting, ex: `@asset` + +extends: existence +message: "Headings shouldn't have periods or other Markdown formatting" +level: error +scope: heading +ignorecase: false +nonword: true +raw: + - '`|(?<=.)\.$' diff --git a/docs/vale/styles/Dagster/heading-content.yml b/docs/vale/styles/Dagster/heading-content.yml index 29042f333b253..9416eae94d790 100644 --- a/docs/vale/styles/Dagster/heading-content.yml +++ b/docs/vale/styles/Dagster/heading-content.yml @@ -6,5 +6,4 @@ ignorecase: true nonword: true scope: raw tokens: - - '\#+ How it works' - '\#+ Overview' diff --git a/docs/vale/styles/Dagster/headings-casing.yml b/docs/vale/styles/Dagster/headings-casing.yml new file mode 100644 index 0000000000000..f87146b9a7d67 --- /dev/null +++ b/docs/vale/styles/Dagster/headings-casing.yml @@ -0,0 +1,8 @@ +## This rule finds section headings that don't use sentence casing. +## Ex: This is correct, but This Is Not Correct + +extends: capitalization +message: "'%s' should be in sentence case" +level: error +scope: heading +match: $sentence diff --git a/docs/vale/styles/Dagster/section-heading-gerund.yml b/docs/vale/styles/Dagster/headings-gerund.yml similarity index 56% rename from docs/vale/styles/Dagster/section-heading-gerund.yml rename to docs/vale/styles/Dagster/headings-gerund.yml index 3342d45930d98..dcbed29ed590e 100644 --- a/docs/vale/styles/Dagster/section-heading-gerund.yml +++ b/docs/vale/styles/Dagster/headings-gerund.yml @@ -1,3 +1,6 @@ +## This rule flags gerunds (ex: "Linting" versus "Lint") in section headings +## WHY? Gerunds don't always translate well into other languages + extends: existence message: Section '%v' should not start with a gerund (verb ending in "ing") level: error diff --git a/docs/vale/styles/Google/LyHyphens.yml b/docs/vale/styles/Dagster/hyphens.yml similarity index 100% rename from docs/vale/styles/Google/LyHyphens.yml rename to docs/vale/styles/Dagster/hyphens.yml diff --git a/docs/vale/styles/Dagster/latin-terms.yml b/docs/vale/styles/Dagster/latin.yml similarity index 100% rename from docs/vale/styles/Dagster/latin-terms.yml rename to docs/vale/styles/Dagster/latin.yml diff --git a/docs/vale/styles/Dagster/link-text.yml b/docs/vale/styles/Dagster/link-text.yml new file mode 100644 index 0000000000000..de0dd421c4e0d --- /dev/null +++ b/docs/vale/styles/Dagster/link-text.yml @@ -0,0 +1,26 @@ +## This rule flags vague language in links. Links should tell the user where you're sending them. + +extends: substitution +message: "Avoid vague text in links like '%s' unless you can pair it with more descriptive text." +link: 'https://github.com/DataDog/documentation/blob/master/CONTRIBUTING.md#links' +ignorecase: true +scope: raw +nonword: true +level: warning + +swap: +# For the word 'here' in Markdown and HTML links + '\[here\]\(.*?\)': 'here' + '\s*here\s*': 'here' + +# For the word 'this' in Markdown and HTML links + '\[this\]\(.*?\)': 'this' + '\s*this\s*': 'this' + +# For the word 'page' in Markdown and HTML links + '\[page\]\(.*?\)': 'page' + '\s*page\s*': 'page' + +# For the phrase 'this page' in Markdown and HTML links + '\[this page\]\(.*?\)': 'this page' + '\s*this page\s*': 'this page' \ No newline at end of file diff --git a/docs/vale/styles/Dagster/missing-tos.yml b/docs/vale/styles/Dagster/missing-tos.yml new file mode 100644 index 0000000000000..efc1386557c08 --- /dev/null +++ b/docs/vale/styles/Dagster/missing-tos.yml @@ -0,0 +1,9 @@ +## This rule finds missing instances of 'to'. Ex: It would be great // // write a story. + +extends: sequence +message: "Missing 'to': Did you mean '%[2]s %[3]s *to* %[4]s'?" +tokens: + - tag: MD + - pattern: be + - tag: JJ + - tag: VB|VBN \ No newline at end of file diff --git a/docs/vale/styles/Google/OptionalPlurals.yml b/docs/vale/styles/Dagster/optional-plurals.yaml similarity index 67% rename from docs/vale/styles/Google/OptionalPlurals.yml rename to docs/vale/styles/Dagster/optional-plurals.yaml index 4a8767d6f5543..5f824b229bf42 100644 --- a/docs/vale/styles/Google/OptionalPlurals.yml +++ b/docs/vale/styles/Dagster/optional-plurals.yaml @@ -1,3 +1,5 @@ +## This rule finds optional plurals in parentheses. Ex: 'The tag(s)'' instead of 'The tag or tags' + extends: existence message: "Don't use plurals in parentheses such as in '%s'." link: "https://developers.google.com/style/plurals-parentheses" @@ -9,4 +11,4 @@ action: - trim_right - "(s)" tokens: - - '\b\w+\(s\)' + - '\b\w+\(s\)' \ No newline at end of file diff --git a/docs/vale/styles/Google/OxfordComma.yml b/docs/vale/styles/Dagster/oxford.yml similarity index 79% rename from docs/vale/styles/Google/OxfordComma.yml rename to docs/vale/styles/Dagster/oxford.yml index b9ba21ebb25ab..0481542181150 100644 --- a/docs/vale/styles/Google/OxfordComma.yml +++ b/docs/vale/styles/Dagster/oxford.yml @@ -4,4 +4,4 @@ link: 'https://developers.google.com/style/commas' scope: sentence level: warning tokens: - - '(?:[^,]+,){1,}\s\w+\s(?:and|or)' + - '(?:[^,]+,){1,}\s\w+\s(?:and|or)' \ No newline at end of file diff --git a/docs/vale/styles/Google/Parens.yml b/docs/vale/styles/Dagster/parentheses.yml similarity index 100% rename from docs/vale/styles/Google/Parens.yml rename to docs/vale/styles/Dagster/parentheses.yml diff --git a/docs/vale/styles/Dagster/programming.yml b/docs/vale/styles/Dagster/programming.yml deleted file mode 100644 index 413852c923f0c..0000000000000 --- a/docs/vale/styles/Dagster/programming.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: substitution -message: "Use '%s' instead of '%s'." -level: warning -ignorecase: true -action: - name: replace -swap: - javascript: "JavaScript" - nodejs: "Node.js" - typescript: "TypeScript" - "an id": "an identifier" - python: "Python" - diff --git a/docs/vale/styles/Google/Quotes.yml b/docs/vale/styles/Dagster/quotes-punctuation.yaml similarity index 54% rename from docs/vale/styles/Google/Quotes.yml rename to docs/vale/styles/Dagster/quotes-punctuation.yaml index 3cb6f1abd1828..0f358cd50f8a5 100644 --- a/docs/vale/styles/Google/Quotes.yml +++ b/docs/vale/styles/Dagster/quotes-punctuation.yaml @@ -1,7 +1,7 @@ extends: existence -message: "Commas and periods go inside quotation marks." +message: "Commas, exclamation points, and periods go inside quotation marks." link: 'https://developers.google.com/style/quotation-marks' level: error nonword: true tokens: - - '"[^"]+"[.,?]' + - '"[^"]+"[.,?]' \ No newline at end of file diff --git a/docs/vale/styles/Dagster/readability.yml b/docs/vale/styles/Dagster/readability.yml new file mode 100644 index 0000000000000..556f0c2d60021 --- /dev/null +++ b/docs/vale/styles/Dagster/readability.yml @@ -0,0 +1,8 @@ +extends: metric +message: "Try to keep the Automated Readability Index (%s) below 8." +link: https://en.wikipedia.org/wiki/Automated_readability_index + +formula: | + (4.71 * (characters / words)) + (0.5 * (words / sentences)) - 21.43 + +condition: "> 8" \ No newline at end of file diff --git a/docs/vale/styles/Dagster/repeated-words.yml b/docs/vale/styles/Dagster/repeated-words.yml new file mode 100644 index 0000000000000..4a254fac48b98 --- /dev/null +++ b/docs/vale/styles/Dagster/repeated-words.yml @@ -0,0 +1,8 @@ +## This rule catches instances of repeated words. Ex: This //is is// a sentence. + +extends: repetition +message: "'%s' is repeated!" +level: error +alpha: true +tokens: + - '[^\s]+' \ No newline at end of file diff --git a/docs/vale/styles/Dagster/section-heading-depth.yml b/docs/vale/styles/Dagster/section-heading-depth.yml deleted file mode 100644 index 7f0eef158304d..0000000000000 --- a/docs/vale/styles/Dagster/section-heading-depth.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Refactor the section or page to avoid headings greater than H3." -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#heading-levels-in-markdown -level: error -scope: raw -raw: - - '(?<=\n)#{4,}\s.*' diff --git a/docs/vale/styles/Dagster/section-heading-sentence-case.yml b/docs/vale/styles/Dagster/section-heading-sentence-case.yml deleted file mode 100644 index 93244ad05e7c6..0000000000000 --- a/docs/vale/styles/Dagster/section-heading-sentence-case.yml +++ /dev/null @@ -1,5 +0,0 @@ -extends: capitalization -message: "'%s' should be in sentence case" -level: error -scope: heading -match: $sentence diff --git a/docs/vale/styles/Dagster/sentence-length-variety.yml b/docs/vale/styles/Dagster/sentence-length-variety.yml new file mode 100644 index 0000000000000..d98a64617b330 --- /dev/null +++ b/docs/vale/styles/Dagster/sentence-length-variety.yml @@ -0,0 +1,45 @@ +extends: script +message: "This paragraph has a stdev less than 2" +link: https://tengolang.com/ +scope: paragraph +script: | + text := import("text") + math := import("math") + + matches := [] + + each := func(seq, fn) { + for x in seq { + fn(x) + } + } + + sum := func(seq) { + s := 0 + each(seq, func(x) { + s += x + }) + return s + } + + stdev := func(seq) { + size := len(seq) + mean := sum(seq) / size + + sd := 0.0 + each(seq, func(x) { + sd += math.pow(x - mean, 2) + }) + + return math.sqrt(sd / size) + } + + lengths := [] + for sent in text.re_split(`[.!?] `, scope, -1) { + lengths = append(lengths, len(text.fields(sent))) + } + + computed := stdev(lengths) + if computed < 2 && len(lengths) >= 3 { + matches = append(matches, {begin: 0, end: len(scope)}) + } \ No newline at end of file diff --git a/docs/vale/styles/Dagster/spacing.yaml b/docs/vale/styles/Dagster/spacing.yaml new file mode 100644 index 0000000000000..fd29a2911381a --- /dev/null +++ b/docs/vale/styles/Dagster/spacing.yaml @@ -0,0 +1,10 @@ +extends: existence +message: "Use only one space between words and sentences (not two)." +link: 'https://developers.google.com/style/sentence-spacing' +level: error +nonword: true +action: + name: remove +tokens: + - '[a-z][.?!] {2,}[A-Z]' + - '[a-z][.?!][A-Z]' diff --git a/docs/vale/styles/Dagster/spelling.yml b/docs/vale/styles/Dagster/spelling.yml new file mode 100644 index 0000000000000..3f2e5a181101a --- /dev/null +++ b/docs/vale/styles/Dagster/spelling.yml @@ -0,0 +1,6 @@ +# Uses the built-in dictionary and filters. +extends: spelling +message: "Is '%s' spelled correctly?" +level: error +ignore: + - ignore.txt \ No newline at end of file diff --git a/docs/vale/styles/Dagster/todos.yml b/docs/vale/styles/Dagster/todos.yml new file mode 100644 index 0000000000000..3f1863d5f9aed --- /dev/null +++ b/docs/vale/styles/Dagster/todos.yml @@ -0,0 +1,11 @@ +# This rule will flag "TODO" or "todo" unless they occur inside HTML comments. + +extends: existence +message: "Remove or comment out TODOs." +level: error +scope: text +ignorecase: true +tokens: + - '\b[Tt][Oo][Dd][Oo]\b' +exceptions: + - '' diff --git a/docs/vale/styles/Dagster/wordy.yml b/docs/vale/styles/Dagster/wordiness.yml similarity index 85% rename from docs/vale/styles/Dagster/wordy.yml rename to docs/vale/styles/Dagster/wordiness.yml index 6b1ddcd985c06..6500c0bae8551 100644 --- a/docs/vale/styles/Dagster/wordy.yml +++ b/docs/vale/styles/Dagster/wordiness.yml @@ -6,10 +6,9 @@ ignorecase: true swap: a number of: "Specify the number or remove the phrase." as well as: "Use 'and' instead of 'as well as'." - note that: "Remove the phrase 'note that'." + note that: "Replace with **Note**: [sentence]." please: "Use 'please' only if we've inconvenienced the user." respectively: "Remove 'respectively' and list each option instead." and so on: "Remove 'and so on'. Try to use 'like' and provide examples instead." in order to: "Remove 'in order' and leave 'to'." - quite: "Remove 'quite', as it's wordy." - + quite: "Remove 'quite', as it's wordy." \ No newline at end of file diff --git a/docs/vale/styles/Google/AMPM.yml b/docs/vale/styles/Google/AMPM.yml deleted file mode 100644 index fbdc6e4f84b95..0000000000000 --- a/docs/vale/styles/Google/AMPM.yml +++ /dev/null @@ -1,9 +0,0 @@ -extends: existence -message: "Use 'AM' or 'PM' (preceded by a space)." -link: 'https://developers.google.com/style/word-list' -level: error -nonword: true -tokens: - - '\d{1,2}[AP]M' - - '\d{1,2} ?[ap]m' - - '\d{1,2} ?[aApP]\.[mM]\.' diff --git a/docs/vale/styles/Google/DateFormat.yml b/docs/vale/styles/Google/DateFormat.yml deleted file mode 100644 index e9d227fa13d5e..0000000000000 --- a/docs/vale/styles/Google/DateFormat.yml +++ /dev/null @@ -1,9 +0,0 @@ -extends: existence -message: "Use 'July 31, 2016' format, not '%s'." -link: 'https://developers.google.com/style/dates-times' -ignorecase: true -level: error -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}' diff --git a/docs/vale/styles/Google/Ellipses.yml b/docs/vale/styles/Google/Ellipses.yml deleted file mode 100644 index 1e070517bfe4c..0000000000000 --- a/docs/vale/styles/Google/Ellipses.yml +++ /dev/null @@ -1,9 +0,0 @@ -extends: existence -message: "In general, don't use an ellipsis." -link: 'https://developers.google.com/style/ellipses' -nonword: true -level: warning -action: - name: remove -tokens: - - '\.\.\.' diff --git a/docs/vale/styles/Google/Exclamation.yml b/docs/vale/styles/Google/Exclamation.yml deleted file mode 100644 index b4e4a1f7e9aa4..0000000000000 --- a/docs/vale/styles/Google/Exclamation.yml +++ /dev/null @@ -1,12 +0,0 @@ -extends: existence -message: "Don't use exclamation points in text." -link: "https://developers.google.com/style/exclamation-points" -nonword: true -level: error -action: - name: edit - params: - - trim_right - - "!" -tokens: - - '\w+!(?:\s|$)' diff --git a/docs/vale/styles/Google/FirstPerson.yml b/docs/vale/styles/Google/FirstPerson.yml deleted file mode 100644 index 0b7b8828ca5f4..0000000000000 --- a/docs/vale/styles/Google/FirstPerson.yml +++ /dev/null @@ -1,13 +0,0 @@ -extends: existence -message: "Avoid first-person pronouns such as '%s'." -link: 'https://developers.google.com/style/pronouns#personal-pronouns' -ignorecase: true -level: warning -nonword: true -tokens: - - (?:^|\s)I\s - - (?:^|\s)I,\s - - \bI'm\b - - \bme\b - - \bmy\b - - \bmine\b diff --git a/docs/vale/styles/Google/Gender.yml b/docs/vale/styles/Google/Gender.yml deleted file mode 100644 index c8486181d6977..0000000000000 --- a/docs/vale/styles/Google/Gender.yml +++ /dev/null @@ -1,9 +0,0 @@ -extends: existence -message: "Don't use '%s' as a gender-neutral pronoun." -link: 'https://developers.google.com/style/pronouns#gender-neutral-pronouns' -level: error -ignorecase: true -tokens: - - he/she - - s/he - - \(s\)he diff --git a/docs/vale/styles/Google/GenderBias.yml b/docs/vale/styles/Google/GenderBias.yml deleted file mode 100644 index 36f5a3f86e6ea..0000000000000 --- a/docs/vale/styles/Google/GenderBias.yml +++ /dev/null @@ -1,43 +0,0 @@ -extends: substitution -message: "Consider using '%s' instead of '%s'." -ignorecase: true -link: "https://developers.google.com/style/inclusive-documentation" -level: error -action: - name: replace -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) - 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 - mail(?:m[ae]n|wom[ae]n): mail carriers - man and wife: husband and wife - man enough: strong enough - mankind: human kind|humanity - manmade: manufactured - manpower: personnel - 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) diff --git a/docs/vale/styles/Google/HeadingPunctuation.yml b/docs/vale/styles/Google/HeadingPunctuation.yml deleted file mode 100644 index c1729868b6416..0000000000000 --- a/docs/vale/styles/Google/HeadingPunctuation.yml +++ /dev/null @@ -1,13 +0,0 @@ -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: warning -scope: heading -action: - name: edit - params: - - trim_right - - "." -tokens: - - '[a-z0-9][.]\s*$' diff --git a/docs/vale/styles/Google/Headings.yml b/docs/vale/styles/Google/Headings.yml deleted file mode 100644 index c8d5be26e12d7..0000000000000 --- a/docs/vale/styles/Google/Headings.yml +++ /dev/null @@ -1,29 +0,0 @@ -extends: capitalization -message: "'%s' should use sentence-style capitalization." -link: "https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings" -level: warning -scope: heading -match: $sentence -indicators: - - ":" -exceptions: - - Azure - - CLI - - Cosmos - - Docker - - Emmet - - gRPC - - I - - Kubernetes - - Linux - - macOS - - Marketplace - - MongoDB - - REPL - - Studio - - TypeScript - - URLs - - Visual - - VS - - Windows - - JSON diff --git a/docs/vale/styles/Google/Latin.yml b/docs/vale/styles/Google/Latin.yml deleted file mode 100644 index ca03b9154b163..0000000000000 --- a/docs/vale/styles/Google/Latin.yml +++ /dev/null @@ -1,11 +0,0 @@ -extends: substitution -message: "Use '%s' instead of '%s'." -link: 'https://developers.google.com/style/abbreviations' -ignorecase: true -level: error -nonword: true -action: - name: replace -swap: - '\b(?:eg|e\.g\.)(?=[\s,;])': for example - '\b(?:ie|i\.e\.)(?=[\s,;])': that is diff --git a/docs/vale/styles/Google/Ordinal.yml b/docs/vale/styles/Google/Ordinal.yml deleted file mode 100644 index d1ac7d27e80d9..0000000000000 --- a/docs/vale/styles/Google/Ordinal.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Spell out all ordinal numbers ('%s') in text." -link: 'https://developers.google.com/style/numbers' -level: error -nonword: true -tokens: - - \d+(?:st|nd|rd|th) diff --git a/docs/vale/styles/Google/Passive.yml b/docs/vale/styles/Google/Passive.yml deleted file mode 100644 index 3265890e5202b..0000000000000 --- a/docs/vale/styles/Google/Passive.yml +++ /dev/null @@ -1,184 +0,0 @@ -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 diff --git a/docs/vale/styles/Google/Ranges.yml b/docs/vale/styles/Google/Ranges.yml deleted file mode 100644 index 3ec045e777d9e..0000000000000 --- a/docs/vale/styles/Google/Ranges.yml +++ /dev/null @@ -1,7 +0,0 @@ -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: warning -tokens: - - '(?:from|between)\s\d+\s?-\s?\d+' diff --git a/docs/vale/styles/Google/Semicolons.yml b/docs/vale/styles/Google/Semicolons.yml deleted file mode 100644 index bb8b85b420ee5..0000000000000 --- a/docs/vale/styles/Google/Semicolons.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Use semicolons judiciously." -link: 'https://developers.google.com/style/semicolons' -nonword: true -scope: sentence -level: suggestion -tokens: - - ';' diff --git a/docs/vale/styles/Google/Slang.yml b/docs/vale/styles/Google/Slang.yml deleted file mode 100644 index 63f4c248a8413..0000000000000 --- a/docs/vale/styles/Google/Slang.yml +++ /dev/null @@ -1,11 +0,0 @@ -extends: existence -message: "Don't use internet slang abbreviations such as '%s'." -link: 'https://developers.google.com/style/abbreviations' -ignorecase: true -level: error -tokens: - - 'tl;dr' - - ymmv - - rtfm - - imo - - fwiw diff --git a/docs/vale/styles/Google/Spelling.yml b/docs/vale/styles/Google/Spelling.yml deleted file mode 100644 index 527ac07d318cb..0000000000000 --- a/docs/vale/styles/Google/Spelling.yml +++ /dev/null @@ -1,10 +0,0 @@ -extends: existence -message: "In general, use American spelling instead of '%s'." -link: 'https://developers.google.com/style/spelling' -ignorecase: true -level: warning -tokens: - - '(?:\w+)nised?' - - 'colour' - - 'labour' - - 'centre' diff --git a/docs/vale/styles/Google/Units.yml b/docs/vale/styles/Google/Units.yml deleted file mode 100644 index 53522ab2dea3e..0000000000000 --- a/docs/vale/styles/Google/Units.yml +++ /dev/null @@ -1,8 +0,0 @@ -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: error -tokens: - - \b\d+(?:B|kB|MB|GB|TB) - - \b\d+(?:ns|ms|s|min|h|d) diff --git a/docs/vale/styles/Google/We.yml b/docs/vale/styles/Google/We.yml deleted file mode 100644 index c7ac7d36221d5..0000000000000 --- a/docs/vale/styles/Google/We.yml +++ /dev/null @@ -1,11 +0,0 @@ -extends: existence -message: "Try to avoid using first-person plural like '%s'." -link: 'https://developers.google.com/style/pronouns#personal-pronouns' -level: warning -ignorecase: true -tokens: - - we - - we'(?:ve|re) - - ours? - - us - - let's diff --git a/docs/vale/styles/Google/Will.yml b/docs/vale/styles/Google/Will.yml deleted file mode 100644 index 128a918362b84..0000000000000 --- a/docs/vale/styles/Google/Will.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Avoid using '%s'." -link: 'https://developers.google.com/style/tense' -ignorecase: true -level: warning -tokens: - - will diff --git a/docs/vale/styles/Google/WordList.yml b/docs/vale/styles/Google/WordList.yml deleted file mode 100644 index b3c6a403c0d79..0000000000000 --- a/docs/vale/styles/Google/WordList.yml +++ /dev/null @@ -1,80 +0,0 @@ -extends: substitution -message: "Use '%s' instead of '%s'." -link: "https://developers.google.com/style/word-list" -level: warning -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 - above: preceding - account name: username - action bar: app bar - admin: administrator - Ajax: AJAX - a\.k\.a|aka: or|also known as - Android device: Android-powered device - android: Android - API explorer: APIs Explorer - application: app - approx\.: approximately - authN: authentication - authZ: authorization - autoupdate: automatically update - cellular data: mobile data - cellular network: mobile network - chapter: documents|pages|sections - check box: checkbox - CLI: command-line tool - click on: click|click in - Cloud: Google Cloud Platform|GCP - Container Engine: Kubernetes Engine - content type: media type - curated roles: predefined roles - data are: data is - Developers Console: Google API Console|API Console - disabled?: turn off|off - 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 - 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 - World Wide Web: web diff --git a/docs/vale/styles/Google/meta.json b/docs/vale/styles/Google/meta.json deleted file mode 100644 index a5da2a8480ef2..0000000000000 --- a/docs/vale/styles/Google/meta.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "feed": "https://github.com/errata-ai/Google/releases.atom", - "vale_version": ">=1.0.0" -} diff --git a/docs/vale/styles/Google/vocab.txt b/docs/vale/styles/Google/vocab.txt deleted file mode 100644 index e69de29bb2d1d..0000000000000 diff --git a/docs/vale/styles/Terms/dagster-ui.yml b/docs/vale/styles/Terms/dagster-ui.yml new file mode 100644 index 0000000000000..04643bb2d02a3 --- /dev/null +++ b/docs/vale/styles/Terms/dagster-ui.yml @@ -0,0 +1,26 @@ +extends: substitution +message: Use '%s' instead of '%s' when referring to a Dagster UI component or page. +level: warning +ignorecase: false +action: + name: replace +# swap maps tokens in form of bad: good +swap: +# Page titles + asset catalog: &ac-title "Asset catalog" + Asset Catalog: *ac-title + asset details: &ad-title "Asset details" + Asset Details: *ad-title + asset health: &ah-title "Asset health" + Asset Health: *ah-title + Global Asset Lineage: "Global asset lineage" + job details: &jd-title "Job details" + Job Details: *jd-title + resource details: &res-title "Resource details" + Resource Details: *res-title + run details: &rd-title "Run details" + Run Details: *rd-title + schedule details: &sd-title "Schedule details" + Schedule Details: *sd-title + sensor details: &sn-title "Sensor details" + Sensor Details: *sn-title \ No newline at end of file diff --git a/docs/vale/styles/Terms/dagster.yml b/docs/vale/styles/Terms/dagster.yml new file mode 100644 index 0000000000000..0d0c280173370 --- /dev/null +++ b/docs/vale/styles/Terms/dagster.yml @@ -0,0 +1,14 @@ +extends: substitution +message: Use '%s' instead of '%s' when referring to this Dagster term. +level: warning +ignorecase: false +action: + name: replace +# swap maps tokens in form of bad: good +swap: + "IO [Mm]anager": "I/O manager" + dagster cloud: Dagster+ + dagster plus: Dagster+ + '[Dd]agit': "Dagster UI" + '[Ss]oftware-defined [Aa]sset': &asset-def asset definition|asset + '[Ss][Dd][Aa]': *asset-def \ No newline at end of file diff --git a/docs/vale/styles/Terms/engineering.yml b/docs/vale/styles/Terms/engineering.yml new file mode 100644 index 0000000000000..b478bc812ae14 --- /dev/null +++ b/docs/vale/styles/Terms/engineering.yml @@ -0,0 +1,25 @@ +## This rule finds incorrectly formatting programming languages and software names and suggests a correction. + +extends: substitution +message: "Use '%s' instead of '%s'." +level: warning +ignorecase: true +action: + name: replace +swap: + +# General + HTTPs: HTTPS + "[Ss]cim": "SCIM" + ui: "UI" + web server: "webserver" + +# Languages + "[Gg]raphql": "GraphQL" + javascript: "JavaScript" + "[Nn]ode[.]?[Jj][Ss]": "Node.js" + python: "Python" + pythonic: "Pythonic" + react: "React" + sql: "SQL" + "[Tt]ypescript": "TypeScript" \ No newline at end of file diff --git a/docs/vale/styles/Terms/words.yml b/docs/vale/styles/Terms/words.yml new file mode 100644 index 0000000000000..20a6a39fa180c --- /dev/null +++ b/docs/vale/styles/Terms/words.yml @@ -0,0 +1,21 @@ +## This rule finds "bad" words and suggests an improved replacement. + +extends: substitution +message: "Use '%s' instead of '%s'." +level: warning +ignorecase: false +action: + name: replace +swap: + "(?:e-mail|Email|E-mail)": email + above: preceding + check box: checkbox + click on: click|click in|click the + drop-down: dropdown + file name: filename + HTTPs: HTTPS + in order to: to + open-source: open source + regex: regular expression + sign into: sign in to + url: URL \ No newline at end of file diff --git a/docs/vale/styles/config/ignore/ignore.txt b/docs/vale/styles/config/ignore/ignore.txt new file mode 100644 index 0000000000000..5af9597d30f02 --- /dev/null +++ b/docs/vale/styles/config/ignore/ignore.txt @@ -0,0 +1,9 @@ +apis +config +pythonic +scim +subprocess +todo +ui +webserver +yaml \ No newline at end of file diff --git a/docs/vale/styles/config/vocabularies/Dagster/accept.txt b/docs/vale/styles/config/vocabularies/Dagster/accept.txt index 0128ab9b0b513..e41298562317f 100644 --- a/docs/vale/styles/config/vocabularies/Dagster/accept.txt +++ b/docs/vale/styles/config/vocabularies/Dagster/accept.txt @@ -1,15 +1,28 @@ -API -APIs +[Cc]onfig Dagster -ETL -SDAs -SDA -Extract -Transform -Load -dataframe -dataframes DataFrame -cron -materializations -webserver +gRPC +[Mm]aterializations +[Mm]emoization +[Ss]ubprocess +Serverless + +Airbyte +AirFlow +BigQuery +Databricks +Datadog +dbt +DuckDB +MLflow +MongoDB +MySQL +OneLogin +Okta +OpenAI +PagerDuty +Pandera +PingOne +Postgres +S3 +Twilio \ No newline at end of file diff --git a/docs/vale/styles/config/vocabularies/Dagster/reject.txt b/docs/vale/styles/config/vocabularies/Dagster/reject.txt index aac703b5ca845..53c3332c07576 100644 --- a/docs/vale/styles/config/vocabularies/Dagster/reject.txt +++ b/docs/vale/styles/config/vocabularies/Dagster/reject.txt @@ -1,6 +1,6 @@ -simply -very -simple -Simply -robust -straightforward +[Ee]xtremely +[Rr]obust +[Ss]imple +[Ss]imply +[Ss]traightforward +[Vv]ery \ No newline at end of file