diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 03f74d587..7fa148013 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -138,3 +138,7 @@ The following tests are at a `error` level and will prevent merging: to prevent this problem. - [Repetition](https://github.com/errata-ai/vale/blob/v3/testdata/styles/Markup/Repetition.yml): Checks for the same word used twice in succession. + +The following tests are at a `warning` level and won't prevent merging: + +- [Ampersand](https://developers.google.com/style/word-list#ampersand) diff --git a/SUMMARY.md b/SUMMARY.md index af2be189e..2e8ddaf14 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -6,7 +6,7 @@ * [What is Fluent Bit?](about/what-is-fluent-bit.md) * [A Brief History of Fluent Bit](about/history.md) -* [Fluentd & Fluent Bit](about/fluentd-and-fluent-bit.md) +* [Fluentd and Fluent Bit](about/fluentd-and-fluent-bit.md) * [License](about/license.md) * [Sandbox and Lab Resources](about/sandbox-and-lab-resources.md) @@ -69,7 +69,7 @@ * [Unit Sizes](administration/configuring-fluent-bit/unit-sizes.md) * [Multiline Parsing](administration/configuring-fluent-bit/multiline-parsing.md) * [Transport Security](administration/transport-security.md) -* [Buffering & Storage](administration/buffering-and-storage.md) +* [Buffering and Storage](administration/buffering-and-storage.md) * [Backpressure](administration/backpressure.md) * [Scheduling and Retries](administration/scheduling-and-retries.md) * [Networking](administration/networking.md) @@ -217,7 +217,7 @@ * [Stackdriver](pipeline/outputs/stackdriver.md) * [Standard Output](pipeline/outputs/standard-output.md) * [Syslog](pipeline/outputs/syslog.md) - * [TCP & TLS](pipeline/outputs/tcp-and-tls.md) + * [TCP and TLS](pipeline/outputs/tcp-and-tls.md) * [Treasure Data](pipeline/outputs/treasure-data.md) * [Vivo Exporter](pipeline/outputs/vivo-exporter.md) * [WebSocket](pipeline/outputs/websocket.md) diff --git a/administration/buffering-and-storage.md b/administration/buffering-and-storage.md index 32dc8d657..df2ca6003 100644 --- a/administration/buffering-and-storage.md +++ b/administration/buffering-and-storage.md @@ -1,4 +1,4 @@ -# Buffering & Storage +# Buffering and Storage diff --git a/pipeline/inputs/cpu-metrics.md b/pipeline/inputs/cpu-metrics.md index c54558cbf..caf06201f 100644 --- a/pipeline/inputs/cpu-metrics.md +++ b/pipeline/inputs/cpu-metrics.md @@ -57,7 +57,7 @@ As described above, the CPU input plugin gathers the overall usage every one sec ### Configuration File -In your main configuration file append the following _Input_ & _Output_ sections: +In your main configuration file append the following _Input_ and _Output_ sections: {% tabs %} {% tab title="fluent-bit.conf" %} diff --git a/vale-styles/FluentBit/Ampersand.yml b/vale-styles/FluentBit/Ampersand.yml index 75117bc08..73658b50b 100644 --- a/vale-styles/FluentBit/Ampersand.yml +++ b/vale-styles/FluentBit/Ampersand.yml @@ -1,9 +1,11 @@ ---- extends: existence -message: "Don't use an ampersand in place of the word 'and'. Always write out 'and' unless the ampersand is part of a proper name." +message: 'Use "and" instead of "&" in content.' +level: warning +scope: text nonword: true -ignorecase: false -level: suggestion -scope: sentence tokens: - - '[^\*{2}].*.&.*[^\*{2}]\n' + - '\s&\s' + - '^&\s' + - '\s&$' + - '\s&[^\w]' + - '[^\w]&\s'