From b78b8be6321acc242c6df0dcc864e1c6f5c6bc1a Mon Sep 17 00:00:00 2001 From: Maryam Sulemani Date: Thu, 19 May 2022 18:03:01 +0400 Subject: [PATCH 01/43] add .vale.ini+basic rules --- .vale.ini | 6 ++ styles/Vocab/word_list/accept.txt | 26 +++++ styles/Vocab/word_list/reject.txt | 0 styles/style_guide/Condescending.yml | 16 +++ styles/style_guide/FirstPerson.yml | 13 +++ styles/style_guide/HeadingPunctuation.yml | 7 ++ styles/style_guide/Headings.yml | 34 ++++++ styles/style_guide/Ordinal.yml | 7 ++ styles/style_guide/OxfordComma.yml | 7 ++ styles/style_guide/Periods.yml | 7 ++ styles/style_guide/Semicolons.yml | 8 ++ styles/style_guide/Spacing.yml | 12 +++ styles/style_guide/URLFormat.yml | 11 ++ styles/style_guide/Wordiness.yml | 122 ++++++++++++++++++++++ styles/style_guide/spell.yml | 9 ++ styles/style_guide/spellcheck.yml | 4 + styles/style_guide/wordSpace.yaml | 10 ++ 17 files changed, 299 insertions(+) create mode 100644 .vale.ini create mode 100644 styles/Vocab/word_list/accept.txt create mode 100644 styles/Vocab/word_list/reject.txt create mode 100644 styles/style_guide/Condescending.yml create mode 100644 styles/style_guide/FirstPerson.yml create mode 100644 styles/style_guide/HeadingPunctuation.yml create mode 100644 styles/style_guide/Headings.yml create mode 100644 styles/style_guide/Ordinal.yml create mode 100644 styles/style_guide/OxfordComma.yml create mode 100644 styles/style_guide/Periods.yml create mode 100644 styles/style_guide/Semicolons.yml create mode 100644 styles/style_guide/Spacing.yml create mode 100644 styles/style_guide/URLFormat.yml create mode 100644 styles/style_guide/Wordiness.yml create mode 100644 styles/style_guide/spell.yml create mode 100644 styles/style_guide/spellcheck.yml create mode 100644 styles/style_guide/wordSpace.yaml diff --git a/.vale.ini b/.vale.ini new file mode 100644 index 0000000000..da5bf86e7d --- /dev/null +++ b/.vale.ini @@ -0,0 +1,6 @@ +StylesPath = styles + +Vocab = word_list + +[*.md] +BasedOnStyles = style_guide \ No newline at end of file diff --git a/styles/Vocab/word_list/accept.txt b/styles/Vocab/word_list/accept.txt new file mode 100644 index 0000000000..c8176f4687 --- /dev/null +++ b/styles/Vocab/word_list/accept.txt @@ -0,0 +1,26 @@ +Meilisearch +subroute +substring +uid +Qovery +Koyeb +Vue +[Gg]eosearch +Nginx +Docxtemplater +config +Algolia +Typesense +Symfony +Laravel +Strapi +[Sc]chemaless +reindexed +chatbox +Lucene +Levenshtein +Swiftype +tokenizer +tokenization +[Aa]sync +[Ee]nqueued \ No newline at end of file diff --git a/styles/Vocab/word_list/reject.txt b/styles/Vocab/word_list/reject.txt new file mode 100644 index 0000000000..e69de29bb2 diff --git a/styles/style_guide/Condescending.yml b/styles/style_guide/Condescending.yml new file mode 100644 index 0000000000..4283a33671 --- /dev/null +++ b/styles/style_guide/Condescending.yml @@ -0,0 +1,16 @@ +--- +extends: existence +message: Using '%s' may come across as condescending. +link: https://css-tricks.com/words-avoid-educational-writing/ +level: error +ignorecase: true +tokens: + - obvious + - obviously + - simple + - simply + - easy + - easily + - of course + - clearly + - everyone knows diff --git a/styles/style_guide/FirstPerson.yml b/styles/style_guide/FirstPerson.yml new file mode 100644 index 0000000000..0b7b8828ca --- /dev/null +++ b/styles/style_guide/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: warning +nonword: true +tokens: + - (?:^|\s)I\s + - (?:^|\s)I,\s + - \bI'm\b + - \bme\b + - \bmy\b + - \bmine\b diff --git a/styles/style_guide/HeadingPunctuation.yml b/styles/style_guide/HeadingPunctuation.yml new file mode 100644 index 0000000000..d202f3f33f --- /dev/null +++ b/styles/style_guide/HeadingPunctuation.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Don't use end punctuation in headings." +nonword: true +level: warning +scope: heading +tokens: + - '[a-z0-9][.?!](?:\s|$)' diff --git a/styles/style_guide/Headings.yml b/styles/style_guide/Headings.yml new file mode 100644 index 0000000000..b79bbd98e7 --- /dev/null +++ b/styles/style_guide/Headings.yml @@ -0,0 +1,34 @@ +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 + - Code + - Docker + - SDK + - Kubernetes + - Linux + - macOS + - Marketplace + - MongoDB + - TypeScript + - URLs + - Visual + - VS + - Windows + - Meilisearch + - AWS + - DigitalOcean + - GCP + - Qovery + - GCP + - GitHub + - JSON + - API + - VuePress diff --git a/styles/style_guide/Ordinal.yml b/styles/style_guide/Ordinal.yml new file mode 100644 index 0000000000..d1ac7d27e8 --- /dev/null +++ b/styles/style_guide/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: error +nonword: true +tokens: + - \d+(?:st|nd|rd|th) diff --git a/styles/style_guide/OxfordComma.yml b/styles/style_guide/OxfordComma.yml new file mode 100644 index 0000000000..b9ba21ebb2 --- /dev/null +++ b/styles/style_guide/OxfordComma.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Use the Oxford comma in '%s'." +link: 'https://developers.google.com/style/commas' +scope: sentence +level: warning +tokens: + - '(?:[^,]+,){1,}\s\w+\s(?:and|or)' diff --git a/styles/style_guide/Periods.yml b/styles/style_guide/Periods.yml new file mode 100644 index 0000000000..d24a6a6c03 --- /dev/null +++ b/styles/style_guide/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: error +nonword: true +tokens: + - '\b(?:[A-Z]\.){3,}' diff --git a/styles/style_guide/Semicolons.yml b/styles/style_guide/Semicolons.yml new file mode 100644 index 0000000000..bb8b85b420 --- /dev/null +++ b/styles/style_guide/Semicolons.yml @@ -0,0 +1,8 @@ +extends: existence +message: "Use semicolons judiciously." +link: 'https://developers.google.com/style/semicolons' +nonword: true +scope: sentence +level: suggestion +tokens: + - ';' diff --git a/styles/style_guide/Spacing.yml b/styles/style_guide/Spacing.yml new file mode 100644 index 0000000000..c915fc945e --- /dev/null +++ b/styles/style_guide/Spacing.yml @@ -0,0 +1,12 @@ +# works for this is a sentence. This is another not for this is a sentence. this is another +extends: existence +message: "'%s' should have one space." +link: https://docs.microsoft.com/en-us/style-guide/punctuation/periods +level: error +nonword: true +tokens: + - '[a-z]\s{2,}[a-z]' # ensure only one space between words + - '[a-z][.?!] {2,}[A-Z]' # one space between sentences (end. new) + - '[a-z][.?!][A-Z]' #(end.new) + - '[,.?]\s{2,}[a-z]' #only one space after ,.? + \ No newline at end of file diff --git a/styles/style_guide/URLFormat.yml b/styles/style_guide/URLFormat.yml new file mode 100644 index 0000000000..0f922813da --- /dev/null +++ b/styles/style_guide/URLFormat.yml @@ -0,0 +1,11 @@ +extends: substitution +message: "Use '%s' instead of '%s'." +ignorecase: true +level: error +action: + name: replace +swap: + URL for: URL of + an URL: a URL + an HTML: a HTML + diff --git a/styles/style_guide/Wordiness.yml b/styles/style_guide/Wordiness.yml new file mode 100644 index 0000000000..22a4c932c8 --- /dev/null +++ b/styles/style_guide/Wordiness.yml @@ -0,0 +1,122 @@ +extends: substitution +message: "Consider using '%s' instead of '%s'." +link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences +ignorecase: true +level: warning +action: + name: replace +swap: + (?:give|gave) rise to: lead to + (?:previous|prior) to: before + a (?:large)? majority of: most + a (?:large)? number of: many + a myriad of: myriad + adversely impact: hurt + all across: across + all of a sudden: suddenly + all of these: these + all of: all + all-time record: record + almost all: most + almost never: seldom + along the lines of: similar to + an adequate number of: enough + an appreciable number of: many + an estimated: about + any and all: all + are in agreement: agree + as a matter of fact: in fact + as a means of: to + as a result of: because of + as of yet: yet + as per: per + at a later date: later + at all times: always + at the present time: now + at this point in time: at this point + based in large part on: based on + based on the fact that: because + basic necessity: necessity + because of the fact that: because + came to a realization: realized + came to an abrupt end: ended abruptly + carry out an evaluation of: evaluate + close down: close + closed down: closed + complete stranger: stranger + completely separate: separate + concerning the matter of: regarding + conduct a review of: review + conduct an investigation: investigate + conduct experiments: experiment + continue on: continue + despite the fact that: although + disappear from sight: disappear + drag and drop: drag + drag-and-drop: drag + doomed to fail: doomed + due to the fact that: because + during the period of: during + during the time that: while + emergency situation: emergency + except when: unless + excessive number: too many + extend an invitation: invite + fall down: fall + fell down: fell + for the duration of: during + gather together: gather + has the ability to: can + has the capacity to: can + has the opportunity to: could + hold a meeting: meet + if this is not the case: if not + in a careful manner: carefully + in a thoughtful manner: thoughtfully + in a timely manner: timely + in an effort to: to + in between: between + in lieu of: instead of + in many cases: often + in most cases: usually + in order to: to + in some cases: sometimes + in spite of the fact that: although + in spite of: despite + in the (?:very)? near future: soon + in the event that: if + in the neighborhood of: roughly + in the vicinity of: close to + it would appear that: apparently + lift up: lift + made reference to: referred to + make reference to: refer to + mix together: mix + none at all: none + not in a position to: unable + not possible: impossible + of major importance: important + perform an assessment of: assess + pertaining to: about + place an order: order + plays a key role in: is essential to + present time: now + readily apparent: apparent + some of the: some + span across: span + subsequent to: after + successfully complete: complete + sufficient number (?:of)?: enough + take action: act + take into account: consider + the question as to whether: whether + there is no doubt but that: doubtless + this day and age: this age + this is a subject that: this subject + time (?:frame|period): time + under the provisions of: under + until such time as: until + used for fuel purposes: used for fuel + whether or not: whether + with regard to: regarding + with the exception of: except for diff --git a/styles/style_guide/spell.yml b/styles/style_guide/spell.yml new file mode 100644 index 0000000000..c6f4f9de1b --- /dev/null +++ b/styles/style_guide/spell.yml @@ -0,0 +1,9 @@ +--- +extends: substitution +message: "Use '%s' instead of '%s'." +level: error +swap: + MeiliSearch: Meilisearch + MieliSearch: Meilisearch + meiliSearch: Meilisearch + \.\.\.: … diff --git a/styles/style_guide/spellcheck.yml b/styles/style_guide/spellcheck.yml new file mode 100644 index 0000000000..52f601baf0 --- /dev/null +++ b/styles/style_guide/spellcheck.yml @@ -0,0 +1,4 @@ +extends: spelling +message: "Did you really mean '%s'?" +filters: + - 'Vale.*\b' diff --git a/styles/style_guide/wordSpace.yaml b/styles/style_guide/wordSpace.yaml new file mode 100644 index 0000000000..500803785c --- /dev/null +++ b/styles/style_guide/wordSpace.yaml @@ -0,0 +1,10 @@ +--- +extends: existence +level: error +link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/spacing/ +message: "Keep one space beween words in '%s'." +nonword: true +source: https://docs.microsoft.com/en-us/style-guide/punctuation/periods +tokens: + - "[a-z][.?!] {2,}[A-Z]" + - "[a-z][.?!][A-Z]" \ No newline at end of file From 914b38d58d187dac4b4a8997b8a368b841c3e4ef Mon Sep 17 00:00:00 2001 From: Maryam Sulemani Date: Thu, 19 May 2022 18:14:55 +0400 Subject: [PATCH 02/43] remove wordiness rule --- styles/style_guide/Wordiness.yml | 122 ------------------------------- 1 file changed, 122 deletions(-) delete mode 100644 styles/style_guide/Wordiness.yml diff --git a/styles/style_guide/Wordiness.yml b/styles/style_guide/Wordiness.yml deleted file mode 100644 index 22a4c932c8..0000000000 --- a/styles/style_guide/Wordiness.yml +++ /dev/null @@ -1,122 +0,0 @@ -extends: substitution -message: "Consider using '%s' instead of '%s'." -link: https://docs.microsoft.com/en-us/style-guide/word-choice/use-simple-words-concise-sentences -ignorecase: true -level: warning -action: - name: replace -swap: - (?:give|gave) rise to: lead to - (?:previous|prior) to: before - a (?:large)? majority of: most - a (?:large)? number of: many - a myriad of: myriad - adversely impact: hurt - all across: across - all of a sudden: suddenly - all of these: these - all of: all - all-time record: record - almost all: most - almost never: seldom - along the lines of: similar to - an adequate number of: enough - an appreciable number of: many - an estimated: about - any and all: all - are in agreement: agree - as a matter of fact: in fact - as a means of: to - as a result of: because of - as of yet: yet - as per: per - at a later date: later - at all times: always - at the present time: now - at this point in time: at this point - based in large part on: based on - based on the fact that: because - basic necessity: necessity - because of the fact that: because - came to a realization: realized - came to an abrupt end: ended abruptly - carry out an evaluation of: evaluate - close down: close - closed down: closed - complete stranger: stranger - completely separate: separate - concerning the matter of: regarding - conduct a review of: review - conduct an investigation: investigate - conduct experiments: experiment - continue on: continue - despite the fact that: although - disappear from sight: disappear - drag and drop: drag - drag-and-drop: drag - doomed to fail: doomed - due to the fact that: because - during the period of: during - during the time that: while - emergency situation: emergency - except when: unless - excessive number: too many - extend an invitation: invite - fall down: fall - fell down: fell - for the duration of: during - gather together: gather - has the ability to: can - has the capacity to: can - has the opportunity to: could - hold a meeting: meet - if this is not the case: if not - in a careful manner: carefully - in a thoughtful manner: thoughtfully - in a timely manner: timely - in an effort to: to - in between: between - in lieu of: instead of - in many cases: often - in most cases: usually - in order to: to - in some cases: sometimes - in spite of the fact that: although - in spite of: despite - in the (?:very)? near future: soon - in the event that: if - in the neighborhood of: roughly - in the vicinity of: close to - it would appear that: apparently - lift up: lift - made reference to: referred to - make reference to: refer to - mix together: mix - none at all: none - not in a position to: unable - not possible: impossible - of major importance: important - perform an assessment of: assess - pertaining to: about - place an order: order - plays a key role in: is essential to - present time: now - readily apparent: apparent - some of the: some - span across: span - subsequent to: after - successfully complete: complete - sufficient number (?:of)?: enough - take action: act - take into account: consider - the question as to whether: whether - there is no doubt but that: doubtless - this day and age: this age - this is a subject that: this subject - time (?:frame|period): time - under the provisions of: under - until such time as: until - used for fuel purposes: used for fuel - whether or not: whether - with regard to: regarding - with the exception of: except for From 000e03e1a142ba63f2c6c178f717fb7367a2d0cf Mon Sep 17 00:00:00 2001 From: Maryam Sulemani Date: Mon, 23 May 2022 17:25:42 +0400 Subject: [PATCH 03/43] add comments explaining each rule+add links to further explanation --- styles/style_guide/Condescending.yml | 3 ++- styles/style_guide/FirstPerson.yml | 4 +++- styles/style_guide/HeadingPunctuation.yml | 5 ++++- styles/style_guide/Headings.yml | 2 ++ styles/style_guide/OxfordComma.yml | 4 +++- styles/style_guide/Semicolons.yml | 2 ++ styles/style_guide/Spacing.yml | 3 ++- styles/style_guide/spell.yml | 2 +- styles/style_guide/spellcheck.yml | 2 ++ styles/style_guide/wordSpace.yaml | 10 ---------- 10 files changed, 21 insertions(+), 16 deletions(-) delete mode 100644 styles/style_guide/wordSpace.yaml diff --git a/styles/style_guide/Condescending.yml b/styles/style_guide/Condescending.yml index 4283a33671..817e52af9a 100644 --- a/styles/style_guide/Condescending.yml +++ b/styles/style_guide/Condescending.yml @@ -1,8 +1,9 @@ --- +# A list of words we want to avoid as they may come across as condescending. extends: existence message: Using '%s' may come across as condescending. link: https://css-tricks.com/words-avoid-educational-writing/ -level: error +level: warning ignorecase: true tokens: - obvious diff --git a/styles/style_guide/FirstPerson.yml b/styles/style_guide/FirstPerson.yml index 0b7b8828ca..5f63d9b552 100644 --- a/styles/style_guide/FirstPerson.yml +++ b/styles/style_guide/FirstPerson.yml @@ -1,8 +1,10 @@ +--- +# We want to avoid using singular first person pronouns extends: existence message: "Avoid first-person pronouns such as '%s'." link: 'https://developers.google.com/style/pronouns#personal-pronouns' ignorecase: true -level: warning +level: error nonword: true tokens: - (?:^|\s)I\s diff --git a/styles/style_guide/HeadingPunctuation.yml b/styles/style_guide/HeadingPunctuation.yml index d202f3f33f..2596b39540 100644 --- a/styles/style_guide/HeadingPunctuation.yml +++ b/styles/style_guide/HeadingPunctuation.yml @@ -1,7 +1,10 @@ +--- +# Our headings should not use end punctuation extends: existence message: "Don't use end punctuation in headings." +link: https://developers.google.com/style/periods nonword: true -level: warning +level: error scope: heading tokens: - '[a-z0-9][.?!](?:\s|$)' diff --git a/styles/style_guide/Headings.yml b/styles/style_guide/Headings.yml index b79bbd98e7..195d4bef3e 100644 --- a/styles/style_guide/Headings.yml +++ b/styles/style_guide/Headings.yml @@ -1,3 +1,5 @@ +--- +# Our headings should use sentence-style capitalization. The exceptions include any headings that maybe a list, start with "Step 1: Do this", and the list of words below extends: capitalization message: "'%s' should use sentence-style capitalization." link: 'https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings' diff --git a/styles/style_guide/OxfordComma.yml b/styles/style_guide/OxfordComma.yml index b9ba21ebb2..8adce86fb0 100644 --- a/styles/style_guide/OxfordComma.yml +++ b/styles/style_guide/OxfordComma.yml @@ -1,7 +1,9 @@ +--- +# Use the Oxford comma extends: existence message: "Use the Oxford comma in '%s'." link: 'https://developers.google.com/style/commas' scope: sentence -level: warning +level: error tokens: - '(?:[^,]+,){1,}\s\w+\s(?:and|or)' diff --git a/styles/style_guide/Semicolons.yml b/styles/style_guide/Semicolons.yml index bb8b85b420..6265dba043 100644 --- a/styles/style_guide/Semicolons.yml +++ b/styles/style_guide/Semicolons.yml @@ -1,3 +1,5 @@ +--- +# If your sentence uses a semicolon, you should break it into two sentences or rewrite it to avoid super long sentences. extends: existence message: "Use semicolons judiciously." link: 'https://developers.google.com/style/semicolons' diff --git a/styles/style_guide/Spacing.yml b/styles/style_guide/Spacing.yml index c915fc945e..acc0757afd 100644 --- a/styles/style_guide/Spacing.yml +++ b/styles/style_guide/Spacing.yml @@ -1,4 +1,5 @@ -# works for this is a sentence. This is another not for this is a sentence. this is another +--- +# Use a space between words, sentences, and punctuation marks extends: existence message: "'%s' should have one space." link: https://docs.microsoft.com/en-us/style-guide/punctuation/periods diff --git a/styles/style_guide/spell.yml b/styles/style_guide/spell.yml index c6f4f9de1b..487fc7b1e7 100644 --- a/styles/style_guide/spell.yml +++ b/styles/style_guide/spell.yml @@ -1,4 +1,5 @@ --- +# Lists any possible typos for Meilisearch extends: substitution message: "Use '%s' instead of '%s'." level: error @@ -6,4 +7,3 @@ swap: MeiliSearch: Meilisearch MieliSearch: Meilisearch meiliSearch: Meilisearch - \.\.\.: … diff --git a/styles/style_guide/spellcheck.yml b/styles/style_guide/spellcheck.yml index 52f601baf0..9d5d538c9e 100644 --- a/styles/style_guide/spellcheck.yml +++ b/styles/style_guide/spellcheck.yml @@ -1,3 +1,5 @@ +--- +# Checks if your words exist in the dictionary. Any exceptions (including Meilisearch) should be defined in `styles/Vocab/word_list/accept.txt` extends: spelling message: "Did you really mean '%s'?" filters: diff --git a/styles/style_guide/wordSpace.yaml b/styles/style_guide/wordSpace.yaml deleted file mode 100644 index 500803785c..0000000000 --- a/styles/style_guide/wordSpace.yaml +++ /dev/null @@ -1,10 +0,0 @@ ---- -extends: existence -level: error -link: https://redhat-documentation.github.io/vale-at-red-hat/docs/reference-guide/spacing/ -message: "Keep one space beween words in '%s'." -nonword: true -source: https://docs.microsoft.com/en-us/style-guide/punctuation/periods -tokens: - - "[a-z][.?!] {2,}[A-Z]" - - "[a-z][.?!][A-Z]" \ No newline at end of file From e7ede4cf7efe344ed38dc6af5ecf4c464c28a55c Mon Sep 17 00:00:00 2001 From: Maryam Sulemani Date: Mon, 23 May 2022 18:42:15 +0400 Subject: [PATCH 04/43] update headings rule(not working) --- styles/style_guide/Headings.yml | 3 ++- styles/style_guide/URLFormat.yml | 2 ++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/styles/style_guide/Headings.yml b/styles/style_guide/Headings.yml index 195d4bef3e..3504fa09c8 100644 --- a/styles/style_guide/Headings.yml +++ b/styles/style_guide/Headings.yml @@ -3,7 +3,7 @@ extends: capitalization message: "'%s' should use sentence-style capitalization." link: 'https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings' -level: warning +level: error scope: heading match: $sentence indicators: @@ -34,3 +34,4 @@ exceptions: - JSON - API - VuePress + - '([0-9a-z]:\s[A-Z])' # How do get this to throw an error for `Step 1: do this`? diff --git a/styles/style_guide/URLFormat.yml b/styles/style_guide/URLFormat.yml index 0f922813da..52ffb22196 100644 --- a/styles/style_guide/URLFormat.yml +++ b/styles/style_guide/URLFormat.yml @@ -1,3 +1,5 @@ +--- +# Use "a URL"/"an HTML" instead of "an URL"/"a HTML" extends: substitution message: "Use '%s' instead of '%s'." ignorecase: true From 68b97a7c8863bbc1c8d0934f9d4d8b7b0bcbb2b8 Mon Sep 17 00:00:00 2001 From: Maryam Sulemani Date: Tue, 24 May 2022 15:06:36 +0400 Subject: [PATCH 05/43] remove heading rules --- styles/Vocab/word_list/accept.txt | 13 +++++- styles/style_guide/HeadingPunctuation.txt | 50 +++++++++++++++++++++++ styles/style_guide/HeadingPunctuation.yml | 10 ----- styles/style_guide/Headings.yml | 37 ----------------- styles/style_guide/Ordinal.yml | 7 ---- 5 files changed, 62 insertions(+), 55 deletions(-) create mode 100644 styles/style_guide/HeadingPunctuation.txt delete mode 100644 styles/style_guide/HeadingPunctuation.yml delete mode 100644 styles/style_guide/Headings.yml delete mode 100644 styles/style_guide/Ordinal.yml diff --git a/styles/Vocab/word_list/accept.txt b/styles/Vocab/word_list/accept.txt index c8176f4687..424d269759 100644 --- a/styles/Vocab/word_list/accept.txt +++ b/styles/Vocab/word_list/accept.txt @@ -23,4 +23,15 @@ Swiftype tokenizer tokenization [Aa]sync -[Ee]nqueued \ No newline at end of file +[Ee]nqueued +[Ff]ilepath +[Ww]ebshop +boolean +Taj +Mahal +[Cc]ertbot +toolchain +vm +Jieba +Lindera +Netlify \ No newline at end of file diff --git a/styles/style_guide/HeadingPunctuation.txt b/styles/style_guide/HeadingPunctuation.txt new file mode 100644 index 0000000000..0a3cf1eacf --- /dev/null +++ b/styles/style_guide/HeadingPunctuation.txt @@ -0,0 +1,50 @@ +# Need to update this for "1. Click this" "1.1. Click that" +# Our headings should not use end punctuation +# extends: existence +# message: "Don't use end punctuation in headings." +# link: https://developers.google.com/style/periods +# nonword: true +# level: error +# scope: heading +# tokens: +# - '[a-z0-9][.?!](?:\s|$)' +# exceptions: +# # - '([\d.\s][A-Z])' # 1. Do this/ 1.1. Do that +# - '[^0-9][.\s][$A-Z]' +# need to update this for 'Step 1: Do this' and "Step1: do that" +# Our headings should use sentence-style capitalization. The exceptions include any headings that maybe a list, start with "Step 1: Do this", and the list of words below +# extends: capitalization +# message: "'%s' should use sentence-style capitalization." +# link: 'https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings' +# level: error +# scope: heading +# match: $sentence +# indicators: +# - ':' +# exceptions: +# - Azure +# - CLI +# - Code +# - Docker +# - SDK +# - Kubernetes +# - Linux +# - macOS +# - Marketplace +# - MongoDB +# - TypeScript +# - URLs +# - Visual +# - VS +# - Windows +# - Meilisearch +# - AWS +# - DigitalOcean +# - GCP +# - Qovery +# - GCP +# - GitHub +# - JSON +# - API +# - VuePress +# - '([0-9a-z]:\s[A-Z])' How do get this to throw an error for `Step 1: do this`? \ No newline at end of file diff --git a/styles/style_guide/HeadingPunctuation.yml b/styles/style_guide/HeadingPunctuation.yml deleted file mode 100644 index 2596b39540..0000000000 --- a/styles/style_guide/HeadingPunctuation.yml +++ /dev/null @@ -1,10 +0,0 @@ ---- -# Our headings should not use end punctuation -extends: existence -message: "Don't use end punctuation in headings." -link: https://developers.google.com/style/periods -nonword: true -level: error -scope: heading -tokens: - - '[a-z0-9][.?!](?:\s|$)' diff --git a/styles/style_guide/Headings.yml b/styles/style_guide/Headings.yml deleted file mode 100644 index 3504fa09c8..0000000000 --- a/styles/style_guide/Headings.yml +++ /dev/null @@ -1,37 +0,0 @@ ---- -# Our headings should use sentence-style capitalization. The exceptions include any headings that maybe a list, start with "Step 1: Do this", and the list of words below -extends: capitalization -message: "'%s' should use sentence-style capitalization." -link: 'https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings' -level: error -scope: heading -match: $sentence -indicators: - - ':' -exceptions: - - Azure - - CLI - - Code - - Docker - - SDK - - Kubernetes - - Linux - - macOS - - Marketplace - - MongoDB - - TypeScript - - URLs - - Visual - - VS - - Windows - - Meilisearch - - AWS - - DigitalOcean - - GCP - - Qovery - - GCP - - GitHub - - JSON - - API - - VuePress - - '([0-9a-z]:\s[A-Z])' # How do get this to throw an error for `Step 1: do this`? diff --git a/styles/style_guide/Ordinal.yml b/styles/style_guide/Ordinal.yml deleted file mode 100644 index d1ac7d27e8..0000000000 --- a/styles/style_guide/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) From 6949513dc76a53c2415a4cee27b60ab69dde4775 Mon Sep 17 00:00:00 2001 From: Maryam Sulemani Date: Tue, 24 May 2022 15:16:27 +0400 Subject: [PATCH 06/43] ignore first person rule for telemetry.md --- styles/style_guide/FirstPerson.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/styles/style_guide/FirstPerson.yml b/styles/style_guide/FirstPerson.yml index 5f63d9b552..3e26ec75a9 100644 --- a/styles/style_guide/FirstPerson.yml +++ b/styles/style_guide/FirstPerson.yml @@ -13,3 +13,6 @@ tokens: - \bme\b - \bmy\b - \bmine\b +ignore: + - /learn/what_is_meilisearch/telemetry.md + From 63422d13da63e9f7cca014b14a76d3e2f7243298 Mon Sep 17 00:00:00 2001 From: Maryam Sulemani Date: Tue, 24 May 2022 15:55:20 +0400 Subject: [PATCH 07/43] add rule for repeated words --- styles/style_guide/Repetition.yml | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 styles/style_guide/Repetition.yml diff --git a/styles/style_guide/Repetition.yml b/styles/style_guide/Repetition.yml new file mode 100644 index 0000000000..187610b6ac --- /dev/null +++ b/styles/style_guide/Repetition.yml @@ -0,0 +1,8 @@ +--- +# catch any instances of repeated words. E.g., "This is is a sentence" +extends: repetition +message: "'%s' is repeated." +level: error +alpha: true +tokens: + - '[^\s]+' \ No newline at end of file From bb117015877342f2296449fba76998dcd9b35332 Mon Sep 17 00:00:00 2001 From: Maryam <90181761+maryamsulemani97@users.noreply.github.com> Date: Thu, 26 May 2022 14:16:05 +0400 Subject: [PATCH 08/43] update list of accepted words --- styles/Vocab/word_list/accept.txt | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/styles/Vocab/word_list/accept.txt b/styles/Vocab/word_list/accept.txt index 424d269759..22fa56598e 100644 --- a/styles/Vocab/word_list/accept.txt +++ b/styles/Vocab/word_list/accept.txt @@ -34,4 +34,14 @@ toolchain vm Jieba Lindera -Netlify \ No newline at end of file +Netlify +unintuitive +overconsumption +geopositioning +hanzi +[Aa]utobatching +impactful +lowercased +[Mm]ultitenancy +rulesets +prepended From 04c8b4c50916c7e0bf53085ecddb25989199c2ba Mon Sep 17 00:00:00 2001 From: Maryam <90181761+maryamsulemani97@users.noreply.github.com> Date: Thu, 26 May 2022 15:00:02 +0400 Subject: [PATCH 09/43] updated list of accepted words_2 --- styles/Vocab/word_list/accept.txt | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/styles/Vocab/word_list/accept.txt b/styles/Vocab/word_list/accept.txt index 22fa56598e..78c19ed416 100644 --- a/styles/Vocab/word_list/accept.txt +++ b/styles/Vocab/word_list/accept.txt @@ -45,3 +45,19 @@ lowercased [Mm]ultitenancy rulesets prepended +deallocated +anonymized +serverless +autoscaling +Unsetting +hostname +Scaleway +cron +mkcert +upvote +Docsearch +Orderable +performant +Nutch +subproject +Doofinder From 2575a3cca7a01d2f4a1baba65a7c8bd2a2945d61 Mon Sep 17 00:00:00 2001 From: Maryam <90181761+maryamsulemani97@users.noreply.github.com> Date: Thu, 26 May 2022 15:00:35 +0400 Subject: [PATCH 10/43] update list of files to ignore `FirstPerson.yml` --- styles/style_guide/FirstPerson.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/styles/style_guide/FirstPerson.yml b/styles/style_guide/FirstPerson.yml index 3e26ec75a9..12061ee5cb 100644 --- a/styles/style_guide/FirstPerson.yml +++ b/styles/style_guide/FirstPerson.yml @@ -15,4 +15,6 @@ tokens: - \bmine\b ignore: - /learn/what_is_meilisearch/telemetry.md + - /resources/faq.md + - /learn/what_is_meilisearch/language.md From 796daf3a9925e20fdb0ea16a6c70cca8f021e95f Mon Sep 17 00:00:00 2001 From: Maryam Sulemani Date: Thu, 26 May 2022 15:26:15 +0400 Subject: [PATCH 11/43] update `accept.txt` to ignore any text in [] --- styles/Vocab/word_list/accept.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/styles/Vocab/word_list/accept.txt b/styles/Vocab/word_list/accept.txt index 78c19ed416..76fce585ba 100644 --- a/styles/Vocab/word_list/accept.txt +++ b/styles/Vocab/word_list/accept.txt @@ -61,3 +61,4 @@ performant Nutch subproject Doofinder +'/\((.*?)\)' From 52199c1b7a37c9a464a58f2658e004819189ef40 Mon Sep 17 00:00:00 2001 From: Maryam <90181761+maryamsulemani97@users.noreply.github.com> Date: Thu, 26 May 2022 17:05:55 +0400 Subject: [PATCH 12/43] more accepted words --- styles/Vocab/word_list/accept.txt | 2 ++ 1 file changed, 2 insertions(+) diff --git a/styles/Vocab/word_list/accept.txt b/styles/Vocab/word_list/accept.txt index 76fce585ba..3aef2ad475 100644 --- a/styles/Vocab/word_list/accept.txt +++ b/styles/Vocab/word_list/accept.txt @@ -62,3 +62,5 @@ Nutch subproject Doofinder '/\((.*?)\)' +sharding +[Mm]eili From 2d7e0d8c2d77a5ccfec940a9229c49c050cdabc7 Mon Sep 17 00:00:00 2001 From: Maryam <90181761+maryamsulemani97@users.noreply.github.com> Date: Thu, 26 May 2022 17:49:18 +0400 Subject: [PATCH 13/43] update `Condescending.yml` --- styles/style_guide/Condescending.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/styles/style_guide/Condescending.yml b/styles/style_guide/Condescending.yml index 817e52af9a..6eb4893c93 100644 --- a/styles/style_guide/Condescending.yml +++ b/styles/style_guide/Condescending.yml @@ -12,6 +12,8 @@ tokens: - simply - easy - easily - - of course - clearly - everyone knows +ignore: + - /learn/contributing/contributing_to_docs.md + - /resources/faq.md From 5f13e36f845cde453215e92fe653814c30f66a5f Mon Sep 17 00:00:00 2001 From: Maryam Sulemani Date: Mon, 6 Jun 2022 12:44:04 +0400 Subject: [PATCH 14/43] sound condescending for now --- styles/style_guide/Condescending.yml | 19 ------------------- 1 file changed, 19 deletions(-) delete mode 100644 styles/style_guide/Condescending.yml diff --git a/styles/style_guide/Condescending.yml b/styles/style_guide/Condescending.yml deleted file mode 100644 index 6eb4893c93..0000000000 --- a/styles/style_guide/Condescending.yml +++ /dev/null @@ -1,19 +0,0 @@ ---- -# A list of words we want to avoid as they may come across as condescending. -extends: existence -message: Using '%s' may come across as condescending. -link: https://css-tricks.com/words-avoid-educational-writing/ -level: warning -ignorecase: true -tokens: - - obvious - - obviously - - simple - - simply - - easy - - easily - - clearly - - everyone knows -ignore: - - /learn/contributing/contributing_to_docs.md - - /resources/faq.md From c7da541f6f0414efad010c63bb49ac3a95e64deb Mon Sep 17 00:00:00 2001 From: Maryam <90181761+maryamsulemani97@users.noreply.github.com> Date: Tue, 7 Jun 2022 13:43:32 +0400 Subject: [PATCH 15/43] Update styles/Vocab/word_list/accept.txt Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- styles/Vocab/word_list/accept.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/styles/Vocab/word_list/accept.txt b/styles/Vocab/word_list/accept.txt index 3aef2ad475..6820839ac2 100644 --- a/styles/Vocab/word_list/accept.txt +++ b/styles/Vocab/word_list/accept.txt @@ -14,7 +14,7 @@ Typesense Symfony Laravel Strapi -[Sc]chemaless +[Ss]chemaless reindexed chatbox Lucene From 17a4ab0e70da834fdad2f2ff23d60b2eb0c02a58 Mon Sep 17 00:00:00 2001 From: Maryam <90181761+maryamsulemani97@users.noreply.github.com> Date: Tue, 7 Jun 2022 13:44:02 +0400 Subject: [PATCH 16/43] Update styles/Vocab/word_list/accept.txt Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- styles/Vocab/word_list/accept.txt | 1 - 1 file changed, 1 deletion(-) diff --git a/styles/Vocab/word_list/accept.txt b/styles/Vocab/word_list/accept.txt index 6820839ac2..9eebeb817f 100644 --- a/styles/Vocab/word_list/accept.txt +++ b/styles/Vocab/word_list/accept.txt @@ -45,7 +45,6 @@ lowercased [Mm]ultitenancy rulesets prepended -deallocated anonymized serverless autoscaling From d04a80d6e300b73bcd34bcd58c552766b7de7d9f Mon Sep 17 00:00:00 2001 From: Maryam <90181761+maryamsulemani97@users.noreply.github.com> Date: Tue, 7 Jun 2022 13:44:25 +0400 Subject: [PATCH 17/43] Update styles/Vocab/word_list/accept.txt Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- styles/Vocab/word_list/accept.txt | 1 - 1 file changed, 1 deletion(-) diff --git a/styles/Vocab/word_list/accept.txt b/styles/Vocab/word_list/accept.txt index 9eebeb817f..919fb42dc8 100644 --- a/styles/Vocab/word_list/accept.txt +++ b/styles/Vocab/word_list/accept.txt @@ -31,7 +31,6 @@ Taj Mahal [Cc]ertbot toolchain -vm Jieba Lindera Netlify From 63a2ea0e524126527743994469a2b642bb8ced9c Mon Sep 17 00:00:00 2001 From: Maryam <90181761+maryamsulemani97@users.noreply.github.com> Date: Tue, 7 Jun 2022 13:44:42 +0400 Subject: [PATCH 18/43] Update styles/Vocab/word_list/accept.txt Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- styles/Vocab/word_list/accept.txt | 1 - 1 file changed, 1 deletion(-) diff --git a/styles/Vocab/word_list/accept.txt b/styles/Vocab/word_list/accept.txt index 919fb42dc8..cb24553ccc 100644 --- a/styles/Vocab/word_list/accept.txt +++ b/styles/Vocab/word_list/accept.txt @@ -47,7 +47,6 @@ prepended anonymized serverless autoscaling -Unsetting hostname Scaleway cron From 0f065d8325e913c2791859e2a3dadb1dac8650e9 Mon Sep 17 00:00:00 2001 From: Maryam <90181761+maryamsulemani97@users.noreply.github.com> Date: Tue, 7 Jun 2022 13:48:56 +0400 Subject: [PATCH 19/43] Update styles/style_guide/Periods.yml Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- styles/style_guide/Periods.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/styles/style_guide/Periods.yml b/styles/style_guide/Periods.yml index d24a6a6c03..227e141536 100644 --- a/styles/style_guide/Periods.yml +++ b/styles/style_guide/Periods.yml @@ -1,7 +1,7 @@ extends: existence message: "Don't use periods with acronyms or initialisms such as '%s'." link: 'https://developers.google.com/style/abbreviations' -level: error +level: warning nonword: true tokens: - '\b(?:[A-Z]\.){3,}' From a1e4d23d231eb39e67082dd71bc752ea276a1fe1 Mon Sep 17 00:00:00 2001 From: Maryam <90181761+maryamsulemani97@users.noreply.github.com> Date: Tue, 7 Jun 2022 13:50:09 +0400 Subject: [PATCH 20/43] Update styles/style_guide/URLFormat.yml Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- styles/style_guide/URLFormat.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/styles/style_guide/URLFormat.yml b/styles/style_guide/URLFormat.yml index 52ffb22196..c4cedfb1aa 100644 --- a/styles/style_guide/URLFormat.yml +++ b/styles/style_guide/URLFormat.yml @@ -3,7 +3,7 @@ extends: substitution message: "Use '%s' instead of '%s'." ignorecase: true -level: error +level: warning action: name: replace swap: From 555b2ce56edadaa9fc2cd4deb6054bb30a9ba7f1 Mon Sep 17 00:00:00 2001 From: Maryam Sulemani Date: Tue, 7 Jun 2022 16:17:11 +0400 Subject: [PATCH 21/43] Update accept.txt --- styles/Vocab/word_list/accept.txt | 40 +++++++++++++++---------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/styles/Vocab/word_list/accept.txt b/styles/Vocab/word_list/accept.txt index cb24553ccc..3a829a1ac4 100644 --- a/styles/Vocab/word_list/accept.txt +++ b/styles/Vocab/word_list/accept.txt @@ -1,6 +1,6 @@ Meilisearch -subroute -substring +[Ss]ubroute +[Ss]ubstring uid Qovery Koyeb @@ -8,20 +8,20 @@ Vue [Gg]eosearch Nginx Docxtemplater -config +[Cc]onfig Algolia Typesense Symfony Laravel Strapi [Ss]chemaless -reindexed +[Rr]eindexed chatbox Lucene Levenshtein Swiftype -tokenizer -tokenization +[Tt]okenizer +[Tt]okenization [Aa]sync [Ee]nqueued [Ff]ilepath @@ -30,34 +30,34 @@ boolean Taj Mahal [Cc]ertbot -toolchain +[Tt]oolchain Jieba Lindera Netlify unintuitive -overconsumption -geopositioning +[Oo]verconsumption +[Gg]eopositioning hanzi [Aa]utobatching impactful lowercased [Mm]ultitenancy -rulesets -prepended -anonymized -serverless -autoscaling -hostname +[Rr]ulesets +[Pp]repended +[Aa]nonymized +[Ss]erverless +[Aa]utoscaling +[Hh]ostname Scaleway cron mkcert -upvote +[Uu]pvote Docsearch -Orderable -performant +[Oo]rderable +[Pp]erformant Nutch -subproject +[Ss]ubproject Doofinder '/\((.*?)\)' -sharding +[Ss]harding [Mm]eili From bb354f74f12001b683438a63a12283dc1016a3ec Mon Sep 17 00:00:00 2001 From: Maryam Sulemani Date: Tue, 7 Jun 2022 16:32:21 +0400 Subject: [PATCH 22/43] update based on review --- styles/Vocab/word_list/accept.txt | 2 +- styles/style_guide/OxfordComma.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/styles/Vocab/word_list/accept.txt b/styles/Vocab/word_list/accept.txt index 3a829a1ac4..19d461d0f4 100644 --- a/styles/Vocab/word_list/accept.txt +++ b/styles/Vocab/word_list/accept.txt @@ -58,6 +58,6 @@ Docsearch Nutch [Ss]ubproject Doofinder -'/\((.*?)\)' +'/\(\B(.*?)\)' [Ss]harding [Mm]eili diff --git a/styles/style_guide/OxfordComma.yml b/styles/style_guide/OxfordComma.yml index 8adce86fb0..93c6c23084 100644 --- a/styles/style_guide/OxfordComma.yml +++ b/styles/style_guide/OxfordComma.yml @@ -4,6 +4,6 @@ extends: existence message: "Use the Oxford comma in '%s'." link: 'https://developers.google.com/style/commas' scope: sentence -level: error +level: suggestion tokens: - '(?:[^,]+,){1,}\s\w+\s(?:and|or)' From 0e8bd28ecdafaa3fd232eeddd29e76e9bbd5c6f1 Mon Sep 17 00:00:00 2001 From: Maryam Sulemani Date: Tue, 7 Jun 2022 17:49:27 +0400 Subject: [PATCH 23/43] update heading rules --- styles/style_guide/HeadingPunctuation.txt | 50 ---------------------- styles/style_guide/HeadingPunctuation.yml | 13 ++++++ styles/style_guide/Headings.yml | 52 +++++++++++++++++++++++ 3 files changed, 65 insertions(+), 50 deletions(-) delete mode 100644 styles/style_guide/HeadingPunctuation.txt create mode 100644 styles/style_guide/HeadingPunctuation.yml create mode 100644 styles/style_guide/Headings.yml diff --git a/styles/style_guide/HeadingPunctuation.txt b/styles/style_guide/HeadingPunctuation.txt deleted file mode 100644 index 0a3cf1eacf..0000000000 --- a/styles/style_guide/HeadingPunctuation.txt +++ /dev/null @@ -1,50 +0,0 @@ -# Need to update this for "1. Click this" "1.1. Click that" -# Our headings should not use end punctuation -# extends: existence -# message: "Don't use end punctuation in headings." -# link: https://developers.google.com/style/periods -# nonword: true -# level: error -# scope: heading -# tokens: -# - '[a-z0-9][.?!](?:\s|$)' -# exceptions: -# # - '([\d.\s][A-Z])' # 1. Do this/ 1.1. Do that -# - '[^0-9][.\s][$A-Z]' -# need to update this for 'Step 1: Do this' and "Step1: do that" -# Our headings should use sentence-style capitalization. The exceptions include any headings that maybe a list, start with "Step 1: Do this", and the list of words below -# extends: capitalization -# message: "'%s' should use sentence-style capitalization." -# link: 'https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings' -# level: error -# scope: heading -# match: $sentence -# indicators: -# - ':' -# exceptions: -# - Azure -# - CLI -# - Code -# - Docker -# - SDK -# - Kubernetes -# - Linux -# - macOS -# - Marketplace -# - MongoDB -# - TypeScript -# - URLs -# - Visual -# - VS -# - Windows -# - Meilisearch -# - AWS -# - DigitalOcean -# - GCP -# - Qovery -# - GCP -# - GitHub -# - JSON -# - API -# - VuePress -# - '([0-9a-z]:\s[A-Z])' How do get this to throw an error for `Step 1: do this`? \ No newline at end of file diff --git a/styles/style_guide/HeadingPunctuation.yml b/styles/style_guide/HeadingPunctuation.yml new file mode 100644 index 0000000000..972973e4ed --- /dev/null +++ b/styles/style_guide/HeadingPunctuation.yml @@ -0,0 +1,13 @@ +--- +# Need to update this for "1. Click this" "1.1. Click that" +#Our headings should not use end punctuation +extends: existence +message: "Don't use end punctuation in headings." +link: https://developers.google.com/style/periods +level: warning +scope: heading +tokens: + - '[a-z0-9][.?!](?:\s|$)' +ignore: + - resources/faq.md + - /learn/what_is_meilisearch/telemetry.md \ No newline at end of file diff --git a/styles/style_guide/Headings.yml b/styles/style_guide/Headings.yml new file mode 100644 index 0000000000..5aa5fc0b80 --- /dev/null +++ b/styles/style_guide/Headings.yml @@ -0,0 +1,52 @@ +--- +# Our headings should use sentence-style capitalization. The exceptions include any headings that maybe a list, start with "Step 1: Do this", and the list of words below +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 + - Code + - Docker + - SDK + - SDKs + - Kubernetes + - Linux + - macOS + - Marketplace + - MongoDB + - TypeScript + - URLs + - Visual + - VS + - Windows + - Meilisearch + - AWS + - Amazon Web Services + - DigitalOcean + - GCP + - Qovery + - GCP + - Google Cloud Platform + - Compute Engine + - GitHub + - JSON + - API + - VuePress + - OpenAPI + - Elasticsearch + - Algolia + - DevOps + - Lucene-Solr + - App Service Auto-Scale + - Certbot + - Bleve & Tantivy + - '([0-9a-z]:\s[A-Z])' #How do get this to throw an error for `Step 1: do this`? +ignore: + - /learn/what_is_meilisearch/language.md + - index.md From d14cfd17801d7f3b5d56f2ec2d5f61099379c3e9 Mon Sep 17 00:00:00 2001 From: Maryam Sulemani Date: Tue, 7 Jun 2022 18:23:00 +0400 Subject: [PATCH 24/43] move rules to `.vale` folder --- .vale.ini | 2 +- {styles => .vale/styles}/Vocab/word_list/accept.txt | 0 {styles => .vale/styles}/Vocab/word_list/reject.txt | 0 {styles => .vale/styles}/style_guide/FirstPerson.yml | 0 {styles => .vale/styles}/style_guide/HeadingPunctuation.yml | 0 {styles => .vale/styles}/style_guide/Headings.yml | 0 {styles => .vale/styles}/style_guide/OxfordComma.yml | 0 {styles => .vale/styles}/style_guide/Periods.yml | 0 {styles => .vale/styles}/style_guide/Repetition.yml | 0 {styles => .vale/styles}/style_guide/Semicolons.yml | 0 {styles => .vale/styles}/style_guide/Spacing.yml | 0 {styles => .vale/styles}/style_guide/URLFormat.yml | 0 {styles => .vale/styles}/style_guide/spell.yml | 0 {styles => .vale/styles}/style_guide/spellcheck.yml | 0 14 files changed, 1 insertion(+), 1 deletion(-) rename {styles => .vale/styles}/Vocab/word_list/accept.txt (100%) rename {styles => .vale/styles}/Vocab/word_list/reject.txt (100%) rename {styles => .vale/styles}/style_guide/FirstPerson.yml (100%) rename {styles => .vale/styles}/style_guide/HeadingPunctuation.yml (100%) rename {styles => .vale/styles}/style_guide/Headings.yml (100%) rename {styles => .vale/styles}/style_guide/OxfordComma.yml (100%) rename {styles => .vale/styles}/style_guide/Periods.yml (100%) rename {styles => .vale/styles}/style_guide/Repetition.yml (100%) rename {styles => .vale/styles}/style_guide/Semicolons.yml (100%) rename {styles => .vale/styles}/style_guide/Spacing.yml (100%) rename {styles => .vale/styles}/style_guide/URLFormat.yml (100%) rename {styles => .vale/styles}/style_guide/spell.yml (100%) rename {styles => .vale/styles}/style_guide/spellcheck.yml (100%) diff --git a/.vale.ini b/.vale.ini index da5bf86e7d..84a0d59d7a 100644 --- a/.vale.ini +++ b/.vale.ini @@ -1,4 +1,4 @@ -StylesPath = styles +StylesPath = .vale/styles Vocab = word_list diff --git a/styles/Vocab/word_list/accept.txt b/.vale/styles/Vocab/word_list/accept.txt similarity index 100% rename from styles/Vocab/word_list/accept.txt rename to .vale/styles/Vocab/word_list/accept.txt diff --git a/styles/Vocab/word_list/reject.txt b/.vale/styles/Vocab/word_list/reject.txt similarity index 100% rename from styles/Vocab/word_list/reject.txt rename to .vale/styles/Vocab/word_list/reject.txt diff --git a/styles/style_guide/FirstPerson.yml b/.vale/styles/style_guide/FirstPerson.yml similarity index 100% rename from styles/style_guide/FirstPerson.yml rename to .vale/styles/style_guide/FirstPerson.yml diff --git a/styles/style_guide/HeadingPunctuation.yml b/.vale/styles/style_guide/HeadingPunctuation.yml similarity index 100% rename from styles/style_guide/HeadingPunctuation.yml rename to .vale/styles/style_guide/HeadingPunctuation.yml diff --git a/styles/style_guide/Headings.yml b/.vale/styles/style_guide/Headings.yml similarity index 100% rename from styles/style_guide/Headings.yml rename to .vale/styles/style_guide/Headings.yml diff --git a/styles/style_guide/OxfordComma.yml b/.vale/styles/style_guide/OxfordComma.yml similarity index 100% rename from styles/style_guide/OxfordComma.yml rename to .vale/styles/style_guide/OxfordComma.yml diff --git a/styles/style_guide/Periods.yml b/.vale/styles/style_guide/Periods.yml similarity index 100% rename from styles/style_guide/Periods.yml rename to .vale/styles/style_guide/Periods.yml diff --git a/styles/style_guide/Repetition.yml b/.vale/styles/style_guide/Repetition.yml similarity index 100% rename from styles/style_guide/Repetition.yml rename to .vale/styles/style_guide/Repetition.yml diff --git a/styles/style_guide/Semicolons.yml b/.vale/styles/style_guide/Semicolons.yml similarity index 100% rename from styles/style_guide/Semicolons.yml rename to .vale/styles/style_guide/Semicolons.yml diff --git a/styles/style_guide/Spacing.yml b/.vale/styles/style_guide/Spacing.yml similarity index 100% rename from styles/style_guide/Spacing.yml rename to .vale/styles/style_guide/Spacing.yml diff --git a/styles/style_guide/URLFormat.yml b/.vale/styles/style_guide/URLFormat.yml similarity index 100% rename from styles/style_guide/URLFormat.yml rename to .vale/styles/style_guide/URLFormat.yml diff --git a/styles/style_guide/spell.yml b/.vale/styles/style_guide/spell.yml similarity index 100% rename from styles/style_guide/spell.yml rename to .vale/styles/style_guide/spell.yml diff --git a/styles/style_guide/spellcheck.yml b/.vale/styles/style_guide/spellcheck.yml similarity index 100% rename from styles/style_guide/spellcheck.yml rename to .vale/styles/style_guide/spellcheck.yml From a817ff1f8e90f1bb7267076f183a045d56bbc74d Mon Sep 17 00:00:00 2001 From: Maryam <90181761+maryamsulemani97@users.noreply.github.com> Date: Tue, 7 Jun 2022 18:46:03 +0400 Subject: [PATCH 25/43] Update accept.txt --- .vale/styles/Vocab/word_list/accept.txt | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.vale/styles/Vocab/word_list/accept.txt b/.vale/styles/Vocab/word_list/accept.txt index 19d461d0f4..a6b0f7ea4e 100644 --- a/.vale/styles/Vocab/word_list/accept.txt +++ b/.vale/styles/Vocab/word_list/accept.txt @@ -2,6 +2,7 @@ Meilisearch [Ss]ubroute [Ss]ubstring uid +jq Qovery Koyeb Vue @@ -61,3 +62,5 @@ Doofinder '/\(\B(.*?)\)' [Ss]harding [Mm]eili +jsonlines +Biutiful From 587779fb9f9c646599e0c5403d510d97a7331d04 Mon Sep 17 00:00:00 2001 From: Maryam <90181761+maryamsulemani97@users.noreply.github.com> Date: Wed, 8 Jun 2022 12:09:59 +0400 Subject: [PATCH 26/43] Update vale.ini to add MinAlertLevel --- .vale.ini | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.vale.ini b/.vale.ini index 84a0d59d7a..be56a6991d 100644 --- a/.vale.ini +++ b/.vale.ini @@ -1,6 +1,7 @@ StylesPath = .vale/styles +MinAlertLevel = suggestion Vocab = word_list [*.md] -BasedOnStyles = style_guide \ No newline at end of file +BasedOnStyles = style_guide From 8ddceb866b006e88148b9b8f4fb59b0b0cdf598c Mon Sep 17 00:00:00 2001 From: Maryam <90181761+maryamsulemani97@users.noreply.github.com> Date: Wed, 8 Jun 2022 15:13:42 +0400 Subject: [PATCH 27/43] Update accept.txt --- .vale/styles/Vocab/word_list/accept.txt | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.vale/styles/Vocab/word_list/accept.txt b/.vale/styles/Vocab/word_list/accept.txt index a6b0f7ea4e..2da3822928 100644 --- a/.vale/styles/Vocab/word_list/accept.txt +++ b/.vale/styles/Vocab/word_list/accept.txt @@ -64,3 +64,5 @@ Doofinder [Mm]eili jsonlines Biutiful +Gb +docs-searchbar.js From 6c7b7763c3fcffc06c2d107d2ca9cdc2a254d0e8 Mon Sep 17 00:00:00 2001 From: Maryam <90181761+maryamsulemani97@users.noreply.github.com> Date: Wed, 8 Jun 2022 15:54:34 +0400 Subject: [PATCH 28/43] Update .vale/styles/style_guide/HeadingPunctuation.yml --- .vale/styles/style_guide/HeadingPunctuation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vale/styles/style_guide/HeadingPunctuation.yml b/.vale/styles/style_guide/HeadingPunctuation.yml index 972973e4ed..052d9fe67f 100644 --- a/.vale/styles/style_guide/HeadingPunctuation.yml +++ b/.vale/styles/style_guide/HeadingPunctuation.yml @@ -4,7 +4,7 @@ extends: existence message: "Don't use end punctuation in headings." link: https://developers.google.com/style/periods -level: warning +level: suggestion scope: heading tokens: - '[a-z0-9][.?!](?:\s|$)' From 26821b3ce9f67009bbebb5266437a805ee7610fb Mon Sep 17 00:00:00 2001 From: Maryam <90181761+maryamsulemani97@users.noreply.github.com> Date: Wed, 8 Jun 2022 15:54:50 +0400 Subject: [PATCH 29/43] Update .vale/styles/style_guide/Headings.yml --- .vale/styles/style_guide/Headings.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vale/styles/style_guide/Headings.yml b/.vale/styles/style_guide/Headings.yml index 5aa5fc0b80..fbc717cbcb 100644 --- a/.vale/styles/style_guide/Headings.yml +++ b/.vale/styles/style_guide/Headings.yml @@ -3,7 +3,7 @@ extends: capitalization message: "'%s' should use sentence-style capitalization." link: 'https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings' -level: warning +level: suggestion scope: heading match: $sentence indicators: From 2b5964586a3930fa3c764d4d433d3e7c823c1e6a Mon Sep 17 00:00:00 2001 From: Maryam <90181761+maryamsulemani97@users.noreply.github.com> Date: Wed, 8 Jun 2022 16:40:05 +0400 Subject: [PATCH 30/43] Update FirstPerson.yml --- .vale/styles/style_guide/FirstPerson.yml | 5 ----- 1 file changed, 5 deletions(-) diff --git a/.vale/styles/style_guide/FirstPerson.yml b/.vale/styles/style_guide/FirstPerson.yml index 12061ee5cb..5f63d9b552 100644 --- a/.vale/styles/style_guide/FirstPerson.yml +++ b/.vale/styles/style_guide/FirstPerson.yml @@ -13,8 +13,3 @@ tokens: - \bme\b - \bmy\b - \bmine\b -ignore: - - /learn/what_is_meilisearch/telemetry.md - - /resources/faq.md - - /learn/what_is_meilisearch/language.md - From 0ae23f23722eeb936cb47a529d8f2830c12fffa3 Mon Sep 17 00:00:00 2001 From: Maryam <90181761+maryamsulemani97@users.noreply.github.com> Date: Wed, 8 Jun 2022 16:41:39 +0400 Subject: [PATCH 31/43] Update HeadingPunctuation.yml --- .vale/styles/style_guide/HeadingPunctuation.yml | 3 --- 1 file changed, 3 deletions(-) diff --git a/.vale/styles/style_guide/HeadingPunctuation.yml b/.vale/styles/style_guide/HeadingPunctuation.yml index 052d9fe67f..9304cc1978 100644 --- a/.vale/styles/style_guide/HeadingPunctuation.yml +++ b/.vale/styles/style_guide/HeadingPunctuation.yml @@ -8,6 +8,3 @@ level: suggestion scope: heading tokens: - '[a-z0-9][.?!](?:\s|$)' -ignore: - - resources/faq.md - - /learn/what_is_meilisearch/telemetry.md \ No newline at end of file From b41877b86cfad96216d42299d98e1045aadc63b5 Mon Sep 17 00:00:00 2001 From: Maryam <90181761+maryamsulemani97@users.noreply.github.com> Date: Wed, 8 Jun 2022 16:42:06 +0400 Subject: [PATCH 32/43] Update Headings.yml --- .vale/styles/style_guide/Headings.yml | 3 --- 1 file changed, 3 deletions(-) diff --git a/.vale/styles/style_guide/Headings.yml b/.vale/styles/style_guide/Headings.yml index fbc717cbcb..1a672ff02e 100644 --- a/.vale/styles/style_guide/Headings.yml +++ b/.vale/styles/style_guide/Headings.yml @@ -47,6 +47,3 @@ exceptions: - Certbot - Bleve & Tantivy - '([0-9a-z]:\s[A-Z])' #How do get this to throw an error for `Step 1: do this`? -ignore: - - /learn/what_is_meilisearch/language.md - - index.md From 4dd95da3d1c5591c43eb7c984b1c17bbd3fb4921 Mon Sep 17 00:00:00 2001 From: Maryam <90181761+maryamsulemani97@users.noreply.github.com> Date: Wed, 8 Jun 2022 17:18:34 +0400 Subject: [PATCH 33/43] Update accept.txt --- .vale/styles/Vocab/word_list/accept.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/.vale/styles/Vocab/word_list/accept.txt b/.vale/styles/Vocab/word_list/accept.txt index 2da3822928..6fb0b4b7e8 100644 --- a/.vale/styles/Vocab/word_list/accept.txt +++ b/.vale/styles/Vocab/word_list/accept.txt @@ -66,3 +66,4 @@ jsonlines Biutiful Gb docs-searchbar.js +Meilisearch_apikey From 183cb7f578526fe9aa94555e38664bc161dd1351 Mon Sep 17 00:00:00 2001 From: Maryam Sulemani Date: Thu, 9 Jun 2022 11:41:16 +0400 Subject: [PATCH 34/43] update vale.ini --- .vale.ini | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.vale.ini b/.vale.ini index be56a6991d..d1608a3636 100644 --- a/.vale.ini +++ b/.vale.ini @@ -5,3 +5,6 @@ Vocab = word_list [*.md] BasedOnStyles = style_guide + +#style_guide.Headings = NO +#style_guide.HeadingPunctuation = NO From 8cbf38f489e4a3c09ba7d980b643862490d89547 Mon Sep 17 00:00:00 2001 From: Maryam <90181761+maryamsulemani97@users.noreply.github.com> Date: Thu, 9 Jun 2022 13:40:21 +0400 Subject: [PATCH 35/43] Update Spacing.yml --- .vale/styles/style_guide/Spacing.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.vale/styles/style_guide/Spacing.yml b/.vale/styles/style_guide/Spacing.yml index acc0757afd..5394673093 100644 --- a/.vale/styles/style_guide/Spacing.yml +++ b/.vale/styles/style_guide/Spacing.yml @@ -7,7 +7,7 @@ level: error nonword: true tokens: - '[a-z]\s{2,}[a-z]' # ensure only one space between words - - '[a-z][.?!] {2,}[A-Z]' # one space between sentences (end. new) - - '[a-z][.?!][A-Z]' #(end.new) - - '[,.?]\s{2,}[a-z]' #only one space after ,.? - \ No newline at end of file + - '[a-z][.?!:;",] {2,}[A-Z]' # one space between sentences (end. new) + - '[a-z][.?!:;",][A-Z]' #(end.new) + - '[\w.?!,\(\)\-":] {2,}[\w.?!,\(\)\-":]' #only one space after ,.? + From b100792ee4749de5405ade320dc9d36569e6a106 Mon Sep 17 00:00:00 2001 From: Maryam <90181761+maryamsulemani97@users.noreply.github.com> Date: Thu, 9 Jun 2022 13:42:12 +0400 Subject: [PATCH 36/43] Update and rename spellcheck.yml to Spelling.yml --- .vale/styles/style_guide/{spellcheck.yml => Spelling.yml} | 1 + 1 file changed, 1 insertion(+) rename .vale/styles/style_guide/{spellcheck.yml => Spelling.yml} (93%) diff --git a/.vale/styles/style_guide/spellcheck.yml b/.vale/styles/style_guide/Spelling.yml similarity index 93% rename from .vale/styles/style_guide/spellcheck.yml rename to .vale/styles/style_guide/Spelling.yml index 9d5d538c9e..39401c2e26 100644 --- a/.vale/styles/style_guide/spellcheck.yml +++ b/.vale/styles/style_guide/Spelling.yml @@ -2,5 +2,6 @@ # Checks if your words exist in the dictionary. Any exceptions (including Meilisearch) should be defined in `styles/Vocab/word_list/accept.txt` extends: spelling message: "Did you really mean '%s'?" +level: warning filters: - 'Vale.*\b' From ec628f96e99fdd0bc6bf0e4dd633a5ffe8f5abaa Mon Sep 17 00:00:00 2001 From: Maryam Sulemani Date: Thu, 9 Jun 2022 14:43:31 +0400 Subject: [PATCH 37/43] add warning/error name + added internal link & merge conflict rules --- .vale/styles/style_guide/FirstPerson.yml | 4 +++- .vale/styles/style_guide/HeadingPunctuation.yml | 2 ++ .vale/styles/style_guide/Headings.yml | 2 ++ .vale/styles/style_guide/InternalLinkExtension.yml | 11 +++++++++++ .../styles/style_guide/{spell.yml => Meilisearch.yml} | 2 ++ .vale/styles/style_guide/MergeConflictMarkers.yml | 11 +++++++++++ .vale/styles/style_guide/OxfordComma.yml | 4 +++- .vale/styles/style_guide/Periods.yml | 5 ++++- .vale/styles/style_guide/Repetition.yml | 2 ++ .vale/styles/style_guide/Semicolons.yml | 2 ++ .vale/styles/style_guide/Spacing.yml | 2 ++ .vale/styles/style_guide/Spelling.yml | 2 ++ .vale/styles/style_guide/URLFormat.yml | 2 ++ 13 files changed, 48 insertions(+), 3 deletions(-) create mode 100644 .vale/styles/style_guide/InternalLinkExtension.yml rename .vale/styles/style_guide/{spell.yml => Meilisearch.yml} (84%) create mode 100644 .vale/styles/style_guide/MergeConflictMarkers.yml diff --git a/.vale/styles/style_guide/FirstPerson.yml b/.vale/styles/style_guide/FirstPerson.yml index 5f63d9b552..4e863267db 100644 --- a/.vale/styles/style_guide/FirstPerson.yml +++ b/.vale/styles/style_guide/FirstPerson.yml @@ -1,10 +1,12 @@ --- +# Suggestion: style_guide.MergeConflictMarkers + # We want to avoid using singular first person pronouns extends: existence message: "Avoid first-person pronouns such as '%s'." link: 'https://developers.google.com/style/pronouns#personal-pronouns' ignorecase: true -level: error +level: suggestion nonword: true tokens: - (?:^|\s)I\s diff --git a/.vale/styles/style_guide/HeadingPunctuation.yml b/.vale/styles/style_guide/HeadingPunctuation.yml index 9304cc1978..c1f487c426 100644 --- a/.vale/styles/style_guide/HeadingPunctuation.yml +++ b/.vale/styles/style_guide/HeadingPunctuation.yml @@ -1,4 +1,6 @@ --- +# Suggestion: style_guide.HeadingPunctuation.yml + # Need to update this for "1. Click this" "1.1. Click that" #Our headings should not use end punctuation extends: existence diff --git a/.vale/styles/style_guide/Headings.yml b/.vale/styles/style_guide/Headings.yml index 1a672ff02e..7bb9268e6f 100644 --- a/.vale/styles/style_guide/Headings.yml +++ b/.vale/styles/style_guide/Headings.yml @@ -1,4 +1,6 @@ --- +# Suggestion: style_guide.Headings.yml + # Our headings should use sentence-style capitalization. The exceptions include any headings that maybe a list, start with "Step 1: Do this", and the list of words below extends: capitalization message: "'%s' should use sentence-style capitalization." diff --git a/.vale/styles/style_guide/InternalLinkExtension.yml b/.vale/styles/style_guide/InternalLinkExtension.yml new file mode 100644 index 0000000000..3db920552d --- /dev/null +++ b/.vale/styles/style_guide/InternalLinkExtension.yml @@ -0,0 +1,11 @@ +--- +# Error: style_guide.InternalLinkExtension.yml + +# All internal links must have a .md extension and not .html +extends: existence +message: 'Link "%s" must use the .md file extension.' +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links-to-internal-documentation +level: error +scope: raw +raw: + - '\[.+\]\([\w\/\.-]+\.html[^)]*\)' diff --git a/.vale/styles/style_guide/spell.yml b/.vale/styles/style_guide/Meilisearch.yml similarity index 84% rename from .vale/styles/style_guide/spell.yml rename to .vale/styles/style_guide/Meilisearch.yml index 487fc7b1e7..c503268626 100644 --- a/.vale/styles/style_guide/spell.yml +++ b/.vale/styles/style_guide/Meilisearch.yml @@ -1,4 +1,6 @@ --- +# Error: style_guide.Meilisearch.yml + # Lists any possible typos for Meilisearch extends: substitution message: "Use '%s' instead of '%s'." diff --git a/.vale/styles/style_guide/MergeConflictMarkers.yml b/.vale/styles/style_guide/MergeConflictMarkers.yml new file mode 100644 index 0000000000..d7f1a8c278 --- /dev/null +++ b/.vale/styles/style_guide/MergeConflictMarkers.yml @@ -0,0 +1,11 @@ +--- +# Error: style_guide.MergeConflictMarkers.yml + +# Checks for the presence of merge conflict markers. +extends: existence +message: 'Merge conflict marker "%s" found.' +link: https://docs.gitlab.com/ee/development/code_review.html#merging-a-merge-request +level: error +scope: raw +raw: + - '\n<<<<<<< .+\n|\n=======\n|\n>>>>>>> .+\n' \ No newline at end of file diff --git a/.vale/styles/style_guide/OxfordComma.yml b/.vale/styles/style_guide/OxfordComma.yml index 93c6c23084..06b546e797 100644 --- a/.vale/styles/style_guide/OxfordComma.yml +++ b/.vale/styles/style_guide/OxfordComma.yml @@ -1,5 +1,7 @@ --- -# Use the Oxford comma +# Suggestion: style_guide.OxfordComma.yml + +# Use the Oxford comma, this may not work as intended for complex sentences with many commas extends: existence message: "Use the Oxford comma in '%s'." link: 'https://developers.google.com/style/commas' diff --git a/.vale/styles/style_guide/Periods.yml b/.vale/styles/style_guide/Periods.yml index 227e141536..3dab55618e 100644 --- a/.vale/styles/style_guide/Periods.yml +++ b/.vale/styles/style_guide/Periods.yml @@ -1,7 +1,10 @@ +--- +# Suggestion: style_guide.Period.yml + extends: existence message: "Don't use periods with acronyms or initialisms such as '%s'." link: 'https://developers.google.com/style/abbreviations' -level: warning +level: suggestion nonword: true tokens: - '\b(?:[A-Z]\.){3,}' diff --git a/.vale/styles/style_guide/Repetition.yml b/.vale/styles/style_guide/Repetition.yml index 187610b6ac..e1e1f4a6fe 100644 --- a/.vale/styles/style_guide/Repetition.yml +++ b/.vale/styles/style_guide/Repetition.yml @@ -1,4 +1,6 @@ --- +# Error: style_guide.Repetition.yml + # catch any instances of repeated words. E.g., "This is is a sentence" extends: repetition message: "'%s' is repeated." diff --git a/.vale/styles/style_guide/Semicolons.yml b/.vale/styles/style_guide/Semicolons.yml index 6265dba043..87ac43e56d 100644 --- a/.vale/styles/style_guide/Semicolons.yml +++ b/.vale/styles/style_guide/Semicolons.yml @@ -1,4 +1,6 @@ --- +# Suggestion: style_guide.Semicolons.yml + # If your sentence uses a semicolon, you should break it into two sentences or rewrite it to avoid super long sentences. extends: existence message: "Use semicolons judiciously." diff --git a/.vale/styles/style_guide/Spacing.yml b/.vale/styles/style_guide/Spacing.yml index 5394673093..18a1b56e66 100644 --- a/.vale/styles/style_guide/Spacing.yml +++ b/.vale/styles/style_guide/Spacing.yml @@ -1,4 +1,6 @@ --- +# Error: style_guide.Spacing.yml + # Use a space between words, sentences, and punctuation marks extends: existence message: "'%s' should have one space." diff --git a/.vale/styles/style_guide/Spelling.yml b/.vale/styles/style_guide/Spelling.yml index 39401c2e26..f90e38fadd 100644 --- a/.vale/styles/style_guide/Spelling.yml +++ b/.vale/styles/style_guide/Spelling.yml @@ -1,4 +1,6 @@ --- +# Warning: style_guide.Spelling.yml + # Checks if your words exist in the dictionary. Any exceptions (including Meilisearch) should be defined in `styles/Vocab/word_list/accept.txt` extends: spelling message: "Did you really mean '%s'?" diff --git a/.vale/styles/style_guide/URLFormat.yml b/.vale/styles/style_guide/URLFormat.yml index c4cedfb1aa..0cfc7b30d7 100644 --- a/.vale/styles/style_guide/URLFormat.yml +++ b/.vale/styles/style_guide/URLFormat.yml @@ -1,4 +1,6 @@ --- +# Warning: style_guide.URLFormat.yml + # Use "a URL"/"an HTML" instead of "an URL"/"a HTML" extends: substitution message: "Use '%s' instead of '%s'." From 6dd5d28d0d1aab18a7e2fec6fd27c52b100b2887 Mon Sep 17 00:00:00 2001 From: Maryam Sulemani Date: Mon, 13 Jun 2022 11:12:40 +0400 Subject: [PATCH 38/43] update based on review --- .vale/styles/style_guide/FirstPerson.yml | 2 +- .vale/styles/style_guide/HeadingPunctuation.yml | 2 +- .vale/styles/style_guide/InternalLinkExtension.yml | 11 ----------- .vale/styles/style_guide/MergeConflictMarkers.yml | 3 ++- .vale/styles/style_guide/Repetition.yml | 3 ++- .vale/styles/style_guide/Spacing.yml | 2 +- .vale/styles/style_guide/URLFormat.yml | 3 +-- 7 files changed, 8 insertions(+), 18 deletions(-) delete mode 100644 .vale/styles/style_guide/InternalLinkExtension.yml diff --git a/.vale/styles/style_guide/FirstPerson.yml b/.vale/styles/style_guide/FirstPerson.yml index 4e863267db..27bda04b1e 100644 --- a/.vale/styles/style_guide/FirstPerson.yml +++ b/.vale/styles/style_guide/FirstPerson.yml @@ -1,5 +1,5 @@ --- -# Suggestion: style_guide.MergeConflictMarkers +# Suggestion: style_guide.FirstPerson # We want to avoid using singular first person pronouns extends: existence diff --git a/.vale/styles/style_guide/HeadingPunctuation.yml b/.vale/styles/style_guide/HeadingPunctuation.yml index c1f487c426..801dc493cf 100644 --- a/.vale/styles/style_guide/HeadingPunctuation.yml +++ b/.vale/styles/style_guide/HeadingPunctuation.yml @@ -2,7 +2,7 @@ # Suggestion: style_guide.HeadingPunctuation.yml # Need to update this for "1. Click this" "1.1. Click that" -#Our headings should not use end punctuation +# Our headings should not use end punctuation extends: existence message: "Don't use end punctuation in headings." link: https://developers.google.com/style/periods diff --git a/.vale/styles/style_guide/InternalLinkExtension.yml b/.vale/styles/style_guide/InternalLinkExtension.yml deleted file mode 100644 index 3db920552d..0000000000 --- a/.vale/styles/style_guide/InternalLinkExtension.yml +++ /dev/null @@ -1,11 +0,0 @@ ---- -# Error: style_guide.InternalLinkExtension.yml - -# All internal links must have a .md extension and not .html -extends: existence -message: 'Link "%s" must use the .md file extension.' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links-to-internal-documentation -level: error -scope: raw -raw: - - '\[.+\]\([\w\/\.-]+\.html[^)]*\)' diff --git a/.vale/styles/style_guide/MergeConflictMarkers.yml b/.vale/styles/style_guide/MergeConflictMarkers.yml index d7f1a8c278..9be66ed5de 100644 --- a/.vale/styles/style_guide/MergeConflictMarkers.yml +++ b/.vale/styles/style_guide/MergeConflictMarkers.yml @@ -8,4 +8,5 @@ link: https://docs.gitlab.com/ee/development/code_review.html#merging-a-merge-re level: error scope: raw raw: - - '\n<<<<<<< .+\n|\n=======\n|\n>>>>>>> .+\n' \ No newline at end of file + - '\n<<<<<<< .+\n|\n=======\n|\n>>>>>>> .+\n' + \ No newline at end of file diff --git a/.vale/styles/style_guide/Repetition.yml b/.vale/styles/style_guide/Repetition.yml index e1e1f4a6fe..94f5f20b00 100644 --- a/.vale/styles/style_guide/Repetition.yml +++ b/.vale/styles/style_guide/Repetition.yml @@ -7,4 +7,5 @@ message: "'%s' is repeated." level: error alpha: true tokens: - - '[^\s]+' \ No newline at end of file + - '[^\s]+' + \ No newline at end of file diff --git a/.vale/styles/style_guide/Spacing.yml b/.vale/styles/style_guide/Spacing.yml index 18a1b56e66..536ac01d9f 100644 --- a/.vale/styles/style_guide/Spacing.yml +++ b/.vale/styles/style_guide/Spacing.yml @@ -12,4 +12,4 @@ tokens: - '[a-z][.?!:;",] {2,}[A-Z]' # one space between sentences (end. new) - '[a-z][.?!:;",][A-Z]' #(end.new) - '[\w.?!,\(\)\-":] {2,}[\w.?!,\(\)\-":]' #only one space after ,.? - + \ No newline at end of file diff --git a/.vale/styles/style_guide/URLFormat.yml b/.vale/styles/style_guide/URLFormat.yml index 0cfc7b30d7..151dd16062 100644 --- a/.vale/styles/style_guide/URLFormat.yml +++ b/.vale/styles/style_guide/URLFormat.yml @@ -11,5 +11,4 @@ action: swap: URL for: URL of an URL: a URL - an HTML: a HTML - + a HTML: an HTML From d8334ab4eaf76f236c54d662cb557ca0f7de669c Mon Sep 17 00:00:00 2001 From: Maryam <90181761+maryamsulemani97@users.noreply.github.com> Date: Mon, 13 Jun 2022 11:15:35 +0400 Subject: [PATCH 39/43] Update accept.txt --- .vale/styles/Vocab/word_list/accept.txt | 1 - 1 file changed, 1 deletion(-) diff --git a/.vale/styles/Vocab/word_list/accept.txt b/.vale/styles/Vocab/word_list/accept.txt index 6fb0b4b7e8..a4c3e23d60 100644 --- a/.vale/styles/Vocab/word_list/accept.txt +++ b/.vale/styles/Vocab/word_list/accept.txt @@ -35,7 +35,6 @@ Mahal Jieba Lindera Netlify -unintuitive [Oo]verconsumption [Gg]eopositioning hanzi From 05312a14a036717004a9405ac3edb794ea8b752b Mon Sep 17 00:00:00 2001 From: Maryam <90181761+maryamsulemani97@users.noreply.github.com> Date: Mon, 13 Jun 2022 13:36:56 +0400 Subject: [PATCH 40/43] Update .vale/styles/Vocab/word_list/accept.txt Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- .vale/styles/Vocab/word_list/accept.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.vale/styles/Vocab/word_list/accept.txt b/.vale/styles/Vocab/word_list/accept.txt index a4c3e23d60..ecbb3a90fe 100644 --- a/.vale/styles/Vocab/word_list/accept.txt +++ b/.vale/styles/Vocab/word_list/accept.txt @@ -39,8 +39,8 @@ Netlify [Gg]eopositioning hanzi [Aa]utobatching -impactful -lowercased +[Ii]mpactful +[Ll]owercased [Mm]ultitenancy [Rr]ulesets [Pp]repended From 89db44b1f8db923f2575ef5516789735208a2922 Mon Sep 17 00:00:00 2001 From: Maryam Sulemani Date: Mon, 13 Jun 2022 13:51:36 +0400 Subject: [PATCH 41/43] update based on review --- .vale/styles/style_guide/Periods.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.vale/styles/style_guide/Periods.yml b/.vale/styles/style_guide/Periods.yml index 3dab55618e..adb58099fa 100644 --- a/.vale/styles/style_guide/Periods.yml +++ b/.vale/styles/style_guide/Periods.yml @@ -1,6 +1,8 @@ --- # Suggestion: style_guide.Period.yml +# Don't use periods with acronyms. "H.T.M.L" is incorrect, HTML isn't + extends: existence message: "Don't use periods with acronyms or initialisms such as '%s'." link: 'https://developers.google.com/style/abbreviations' From 6ff54955c5f2a8883ee0531fd9f145a983ff165b Mon Sep 17 00:00:00 2001 From: Maryam <90181761+maryamsulemani97@users.noreply.github.com> Date: Mon, 13 Jun 2022 13:52:24 +0400 Subject: [PATCH 42/43] Update accept.txt --- .vale/styles/Vocab/word_list/accept.txt | 1 - 1 file changed, 1 deletion(-) diff --git a/.vale/styles/Vocab/word_list/accept.txt b/.vale/styles/Vocab/word_list/accept.txt index ecbb3a90fe..47197672ff 100644 --- a/.vale/styles/Vocab/word_list/accept.txt +++ b/.vale/styles/Vocab/word_list/accept.txt @@ -65,4 +65,3 @@ jsonlines Biutiful Gb docs-searchbar.js -Meilisearch_apikey From 810b7fa272d10232372f3cd440f79469311d6824 Mon Sep 17 00:00:00 2001 From: Maryam <90181761+maryamsulemani97@users.noreply.github.com> Date: Mon, 13 Jun 2022 14:21:35 +0400 Subject: [PATCH 43/43] Update .vale/styles/style_guide/Repetition.yml Co-authored-by: Tommy <68053732+dichotommy@users.noreply.github.com> --- .vale/styles/style_guide/Repetition.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.vale/styles/style_guide/Repetition.yml b/.vale/styles/style_guide/Repetition.yml index 94f5f20b00..e1e1f4a6fe 100644 --- a/.vale/styles/style_guide/Repetition.yml +++ b/.vale/styles/style_guide/Repetition.yml @@ -7,5 +7,4 @@ message: "'%s' is repeated." level: error alpha: true tokens: - - '[^\s]+' - \ No newline at end of file + - '[^\s]+' \ No newline at end of file