Automated style checks

There are several automated style checks that run to ensure the quality of our docs remains high.

These are:

• spell check
• Vale
• Markdown lint

Spell check

If your PR is failing on spell check, please first review the flagged words to confirm they are indeed not misspelled.

Sometimes words can be valid but get flagged as they are product or feature names with unusual capitalisation e.g., Elasticsearch, PrivateLink . In these cases it may be necessary to add an exception.

Local exception list

Please add the exception to this list if this is a term specific to the document you are contributing, unlikely to be widely used across the docs.

These get added here: https://github.com/ClickHouse/clickhouse-docs/blob/main/scripts/aspell-dict-file.txt

N.B the list should not have a blank line at the end or the check breaks

Global exception list

If the word is a general term, likely to be repeated across the docs, then please add it here: https://github.com/ClickHouse/clickhouse-docs/blob/main/scripts/aspell-ignore/en/aspell-dict.txt

N.B the list should not have a blank line at the end or the check breaks