diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3abd7c1d5..f23065431 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -42,7 +42,7 @@ within a few minutes. If you open a pull request that requires ongoing discussion or review, the Fluent Bit maintainers will add a `waiting-for-user` to your pull request. This tag means that we're blocked from moving forward until you reply. To keep contributions from going -stale, we'll wait 45 days for your response, but we may close the pull request if we +stale, we'll wait 45 days for your response, but we might close the pull request if we don't hear back from you by then. ## Submit a contribution @@ -140,13 +140,17 @@ The following tests are at a `error` level and will prevent merging: - [AmSpelling](https://developers.google.com/style/word-list) - [Ampersand](https://developers.google.com/style/word-list#ampersand) +- [Don'tUse](https://github.com/fluent/fluent-bit-docs/blob/master/vale-styles/FluentBit/DontUse.yml) - [Emdash](https://github.com/errata-ai/Google/blob/master/Google/EmDash.yml) - [Endash](https://github.com/errata-ai/Google/blob/master/Google/EmDash.yml) - [Exclamation](https://github.com/errata-ai/Google/blob/master/Google/Exclamation.yml) - [Gender](https://developers.google.com/style/pronouns#gender-neutral-pronouns) - [GenderBias](https://developers.google.com/style/inclusive-documentation) +- [Hints](https://github.com/fluent/fluent-bit-docs/blob/master/vale-styles/FluentBit/Hints.yml) using `>`. - [HeadingPunctuation](https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings) +- [Latin](https://developers.google.com/style/abbreviations) - [LyHyphens](https://developers.google.com/style/hyphens) +- [MayMightCan](https://github.com/fluent/fluent-bit-docs/blob/master/vale-styles/FluentBit/MayMightCan.yml) - [NonStandardQuotes](https://github.com/fluent/fluent-bit-docs/blob/master/vale-styles/FluentBit/NonStandardQuotes.yml): [Use standard quotes](https://developers.google.com/style/quotation-marks#straight-and-curly-quotation-marks). By default, Google Docs and Microsoft Word turn standard straight quotes into "smart" @@ -155,13 +159,21 @@ The following tests are at a `error` level and will prevent merging: in [Google Docs](https://support.google.com/docs/thread/217182974/can-i-turn-smart-quotes-off-in-a-google-doc?hl=en) or [Microsoft Word](https://support.microsoft.com/en-us/office/smart-quotes-in-word-and-powerpoint-702fc92e-b723-4e3d-b2cc-71dedaf2f343) to prevent this problem. +- [Optional plurals](https://developers.google.com/style/plurals-parentheses) - [Ordinal](https://developers.google.com/style/numbers) +- [Periods](https://developers.google.com/style/abbreviations) +- [Ranges](https://developers.google.com/style/hyphens) - [Repetition](https://github.com/errata-ai/vale/blob/v3/testdata/styles/Markup/Repetition.yml): Checks for the same word used twice in succession. +- [Slang](https://developers.google.com/style/abbreviations) +- [Spacing](https://developers.google.com/style/sentence-spacing) The following tests are at a `warning` level and won't prevent merging: - [Ampersand](https://developers.google.com/style/word-list#ampersand) +- [First person](https://developers.google.com/style/pronouns#personal-pronouns) +- [Possessives](https://developers.google.com/style/possessives) +- [Simplicity](https://developers.google.com/style/word-list#easy) ### Markdownlint diff --git a/MAINTAINERS.md b/MAINTAINERS.md index 60dec25b4..197c01a41 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -1,6 +1,6 @@ # Fluent Bit Documentation Maintainers -Fluent Bit is developed and supported by many individuals and companies. The following table list the names of maintainers per components and the company supporting their work. +Fluent Bit is developed and supported by many individuals and companies. The following table list the names of maintainers per components and the company supporting their work. | Maintainer Name | Documentation portion | Company | | :---------------------------------------------------- | ------------------------ | ------------------------------------------------- | @@ -11,4 +11,3 @@ Fluent Bit is developed and supported by many individuals and companies. The fo | [Alexa Kreizinger](https://github.com/alexakreizinger) | All | [Chronosphere](https://chronosphere.io) | | [Paige Cruz](https://github.com/paigerduty) | All | [Chronosphere](https://chronosphere.io/) | | [Eric D. Schabell](https://github.com/eschabell) | All | [Chronosphere](https://chronosphere.io/) | - diff --git a/vale-styles/FluentBit/DontUse.yml b/vale-styles/FluentBit/DontUse.yml index 8308555d7..b23fa495f 100644 --- a/vale-styles/FluentBit/DontUse.yml +++ b/vale-styles/FluentBit/DontUse.yml @@ -2,7 +2,7 @@ extends: existence message: "We don't use '%s'." ignorecase: true -level: suggestion +level: error tokens: - a.k.a. - aka diff --git a/vale-styles/FluentBit/FirstPerson.yml b/vale-styles/FluentBit/FirstPerson.yml index e8793eddf..0b7b8828c 100644 --- a/vale-styles/FluentBit/FirstPerson.yml +++ b/vale-styles/FluentBit/FirstPerson.yml @@ -2,7 +2,7 @@ extends: existence message: "Avoid first-person pronouns such as '%s'." link: 'https://developers.google.com/style/pronouns#personal-pronouns' ignorecase: true -level: suggestion +level: warning nonword: true tokens: - (?:^|\s)I\s @@ -10,4 +10,4 @@ tokens: - \bI'm\b - \bme\b - \bmy\b - - \bmine\b \ No newline at end of file + - \bmine\b diff --git a/vale-styles/FluentBit/Hints.yml b/vale-styles/FluentBit/Hints.yml index c023a4a39..6c047d701 100644 --- a/vale-styles/FluentBit/Hints.yml +++ b/vale-styles/FluentBit/Hints.yml @@ -1,6 +1,6 @@ extends: existence message: "Instead of using `>` to call out information, use GitBook hint syntax. https://gitbook.com/docs/creating-content/blocks/hint#representation-in-markdown" -level: suggestion +level: error nonword: true scope: raw tokens: diff --git a/vale-styles/FluentBit/Latin.yml b/vale-styles/FluentBit/Latin.yml index ca6f3abb7..a2dc275cb 100644 --- a/vale-styles/FluentBit/Latin.yml +++ b/vale-styles/FluentBit/Latin.yml @@ -2,7 +2,7 @@ extends: substitution message: "Use '%s' instead of '%s'." link: 'https://developers.google.com/style/abbreviations' ignorecase: true -level: suggestion +level: error nonword: true action: name: replace diff --git a/vale-styles/FluentBit/MayMightCan.yml b/vale-styles/FluentBit/MayMightCan.yml index 56ce95f06..8d75bb53a 100644 --- a/vale-styles/FluentBit/MayMightCan.yml +++ b/vale-styles/FluentBit/MayMightCan.yml @@ -1,7 +1,7 @@ --- extends: existence message: "Use 'can' for permissions or 'might' for possibility." -level: suggestion +level: error ignorecase: true tokens: - may diff --git a/vale-styles/FluentBit/OptionalPlurals.yml b/vale-styles/FluentBit/OptionalPlurals.yml index 50bf2c247..f858ea6fe 100644 --- a/vale-styles/FluentBit/OptionalPlurals.yml +++ b/vale-styles/FluentBit/OptionalPlurals.yml @@ -1,7 +1,7 @@ extends: existence message: "Don't use plurals in parentheses such as in '%s'." link: 'https://developers.google.com/style/plurals-parentheses' -level: suggestion +level: error nonword: true action: name: edit diff --git a/vale-styles/FluentBit/Periods.yml b/vale-styles/FluentBit/Periods.yml index 0333c3160..d24a6a6c0 100644 --- a/vale-styles/FluentBit/Periods.yml +++ b/vale-styles/FluentBit/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: suggestion +level: error nonword: true tokens: - - '\b(?:[A-Z]\.){3,}' \ No newline at end of file + - '\b(?:[A-Z]\.){3,}' diff --git a/vale-styles/FluentBit/Possessives.yml b/vale-styles/FluentBit/Possessives.yml index 1d0a74e0c..394cbbb62 100644 --- a/vale-styles/FluentBit/Possessives.yml +++ b/vale-styles/FluentBit/Possessives.yml @@ -1,7 +1,7 @@ --- extends: existence message: "Rewrite '%s' to not use 's." -level: suggestion +level: warning ignorecase: true tokens: - Bit's diff --git a/vale-styles/FluentBit/Ranges.yml b/vale-styles/FluentBit/Ranges.yml index 78af6f999..30fb25d22 100644 --- a/vale-styles/FluentBit/Ranges.yml +++ b/vale-styles/FluentBit/Ranges.yml @@ -2,6 +2,6 @@ extends: existence message: "Don't add words such as 'from' or 'between' to describe a range of numbers." link: 'https://developers.google.com/style/hyphens' nonword: true -level: suggestion +level: error tokens: - - '(?:from|between)\s\d+\s?-\s?\d+' \ No newline at end of file + - '(?:from|between)\s\d+\s?-\s?\d+' diff --git a/vale-styles/FluentBit/Simplicity.yml b/vale-styles/FluentBit/Simplicity.yml index e9b779763..7e2f4549f 100644 --- a/vale-styles/FluentBit/Simplicity.yml +++ b/vale-styles/FluentBit/Simplicity.yml @@ -1,7 +1,7 @@ --- extends: existence message: 'Avoid words like "%s" that imply ease of use, because the user may find this action difficult.' -level: suggestion +level: warning ignorecase: true tokens: - easy diff --git a/vale-styles/FluentBit/Slang.yml b/vale-styles/FluentBit/Slang.yml index b43eeb299..63f4c248a 100644 --- a/vale-styles/FluentBit/Slang.yml +++ b/vale-styles/FluentBit/Slang.yml @@ -2,10 +2,10 @@ extends: existence message: "Don't use internet slang abbreviations such as '%s'." link: 'https://developers.google.com/style/abbreviations' ignorecase: true -level: suggestion +level: error tokens: - 'tl;dr' - ymmv - rtfm - imo - - fwiw \ No newline at end of file + - fwiw diff --git a/vale-styles/FluentBit/Spacing.yml b/vale-styles/FluentBit/Spacing.yml index 57c52f046..27f7ca2bd 100644 --- a/vale-styles/FluentBit/Spacing.yml +++ b/vale-styles/FluentBit/Spacing.yml @@ -1,8 +1,8 @@ extends: existence message: "'%s' should have one space." link: 'https://developers.google.com/style/sentence-spacing' -level: suggestion +level: error nonword: true tokens: - '[a-z][.?!] {2,}[A-Z]' - - '[a-z][.?!][A-Z]' \ No newline at end of file + - '[a-z][.?!][A-Z]' diff --git a/vale-styles/FluentBit/Spelling-exceptions.txt b/vale-styles/FluentBit/Spelling-exceptions.txt index c10b40d79..9c6c311f5 100644 --- a/vale-styles/FluentBit/Spelling-exceptions.txt +++ b/vale-styles/FluentBit/Spelling-exceptions.txt @@ -119,6 +119,7 @@ Lua Lucene macOS Mandiant +markdownlint matchers metacharacter Metricbeat