fix(vale): propagate Google.Units=NO to product-specific Vale configs (#6917)
* Initial plan * fix(vale): add missing Google.Units=NO to product-specific .vale.ini files Duration literals like 7d, 24h, 30d were being flagged as errors when running Vale with product-specific configs because those configs were missing Google.Units = NO. Also adds Vale.Terms = NO, write-good.TooWordy = NO, and TokenIgnores to match the root .vale.ini. Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com> Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>pull/6914/head^2
parent
3952e3b65b
commit
8a6143d5d1
|
|
@ -299,15 +299,42 @@ echo "systemd" >> .ci/vale/styles/config/vocabularies/InfluxDataDocs/accept.txt
|
|||
|
||||
### Creating a Product-Specific Override
|
||||
|
||||
> [!Important]
|
||||
> Product-specific `.vale.ini` files must include the same disabled rules as the
|
||||
> root `.vale.ini`. Rules disabled in the root config are **not** inherited by
|
||||
> product-specific configs. Omitting them re-enables the rules for those products.
|
||||
> For example, omitting `Google.Units = NO` causes duration literals like `7d`,
|
||||
> `24h` to be flagged as errors in product-specific linting runs.
|
||||
|
||||
```bash
|
||||
# 1. Create product-specific .vale.ini
|
||||
cat > content/influxdb3/cloud-dedicated/.vale.ini << 'EOF'
|
||||
StylesPath = ../../../.ci/vale/styles
|
||||
MinAlertLevel = error
|
||||
MinAlertLevel = warning
|
||||
Vocab = InfluxDataDocs
|
||||
|
||||
Packages = Google, write-good, Hugo
|
||||
|
||||
[*.md]
|
||||
BasedOnStyles = Vale, InfluxDataDocs, Google, write-good
|
||||
|
||||
# These rules must be disabled in every product .vale.ini, same as the root .vale.ini.
|
||||
Google.Acronyms = NO
|
||||
Google.DateFormat = NO
|
||||
Google.Ellipses = NO
|
||||
Google.Headings = NO
|
||||
Google.WordList = NO
|
||||
# Disable Google.Units in favor of InfluxDataDocs.Units which only checks byte
|
||||
# units (GB, TB, etc). Duration literals (30d, 24h, 1h) are valid InfluxDB syntax.
|
||||
Google.Units = NO
|
||||
Vale.Spelling = NO
|
||||
Vale.Terms = NO
|
||||
write-good.TooWordy = NO
|
||||
|
||||
TokenIgnores = /[a-zA-Z0-9/_\-\.]+, \
|
||||
https?://[^\s\)\]>"]+, \
|
||||
`[^`]+`
|
||||
|
||||
# Product-specific overrides
|
||||
InfluxDataDocs.Branding = YES
|
||||
EOF
|
||||
|
|
|
|||
|
|
@ -14,4 +14,22 @@ Google.DateFormat = NO
|
|||
Google.Ellipses = NO
|
||||
Google.Headings = NO
|
||||
Google.WordList = NO
|
||||
Vale.Spelling = NO
|
||||
# Disable Google.Units in favor of InfluxDataDocs.Units which only checks byte
|
||||
# units (GB, TB, etc). Duration literals (30d, 24h, 1h) are valid InfluxDB syntax.
|
||||
Google.Units = NO
|
||||
Vale.Spelling = NO
|
||||
# Disable Vale.Terms - the vocabulary-based substitution rule creates too many
|
||||
# false positives from URLs, file paths, and code. The accepted terms in
|
||||
# accept.txt still work for spelling checks via InfluxDataDocs.Spelling.
|
||||
Vale.Terms = NO
|
||||
# Disable write-good.TooWordy - flags legitimate technical terms like
|
||||
# "aggregate", "expiration", "multiple", "However" that are standard in
|
||||
# database documentation.
|
||||
write-good.TooWordy = NO
|
||||
|
||||
# Ignore URL paths like /api/v3/..., /cli/..., /influxdb3/...
|
||||
# Ignore full URLs like https://example.com/...
|
||||
# Ignore inline code in frontmatter (description fields, etc.)
|
||||
TokenIgnores = /[a-zA-Z0-9/_\-\.]+, \
|
||||
https?://[^\s\)\]>"]+, \
|
||||
`[^`]+`
|
||||
|
|
@ -14,4 +14,22 @@ Google.DateFormat = NO
|
|||
Google.Ellipses = NO
|
||||
Google.Headings = NO
|
||||
Google.WordList = NO
|
||||
Vale.Spelling = NO
|
||||
# Disable Google.Units in favor of InfluxDataDocs.Units which only checks byte
|
||||
# units (GB, TB, etc). Duration literals (30d, 24h, 1h) are valid InfluxDB syntax.
|
||||
Google.Units = NO
|
||||
Vale.Spelling = NO
|
||||
# Disable Vale.Terms - the vocabulary-based substitution rule creates too many
|
||||
# false positives from URLs, file paths, and code. The accepted terms in
|
||||
# accept.txt still work for spelling checks via InfluxDataDocs.Spelling.
|
||||
Vale.Terms = NO
|
||||
# Disable write-good.TooWordy - flags legitimate technical terms like
|
||||
# "aggregate", "expiration", "multiple", "However" that are standard in
|
||||
# database documentation.
|
||||
write-good.TooWordy = NO
|
||||
|
||||
# Ignore URL paths like /api/v3/..., /cli/..., /influxdb3/...
|
||||
# Ignore full URLs like https://example.com/...
|
||||
# Ignore inline code in frontmatter (description fields, etc.)
|
||||
TokenIgnores = /[a-zA-Z0-9/_\-\.]+, \
|
||||
https?://[^\s\)\]>"]+, \
|
||||
`[^`]+`
|
||||
|
|
@ -14,4 +14,22 @@ Google.DateFormat = NO
|
|||
Google.Ellipses = NO
|
||||
Google.Headings = NO
|
||||
Google.WordList = NO
|
||||
Vale.Spelling = NO
|
||||
# Disable Google.Units in favor of InfluxDataDocs.Units which only checks byte
|
||||
# units (GB, TB, etc). Duration literals (30d, 24h, 1h) are valid InfluxDB syntax.
|
||||
Google.Units = NO
|
||||
Vale.Spelling = NO
|
||||
# Disable Vale.Terms - the vocabulary-based substitution rule creates too many
|
||||
# false positives from URLs, file paths, and code. The accepted terms in
|
||||
# accept.txt still work for spelling checks via InfluxDataDocs.Spelling.
|
||||
Vale.Terms = NO
|
||||
# Disable write-good.TooWordy - flags legitimate technical terms like
|
||||
# "aggregate", "expiration", "multiple", "However" that are standard in
|
||||
# database documentation.
|
||||
write-good.TooWordy = NO
|
||||
|
||||
# Ignore URL paths like /api/v3/..., /cli/..., /influxdb3/...
|
||||
# Ignore full URLs like https://example.com/...
|
||||
# Ignore inline code in frontmatter (description fields, etc.)
|
||||
TokenIgnores = /[a-zA-Z0-9/_\-\.]+, \
|
||||
https?://[^\s\)\]>"]+, \
|
||||
`[^`]+`
|
||||
|
|
@ -14,4 +14,22 @@ Google.DateFormat = NO
|
|||
Google.Ellipses = NO
|
||||
Google.Headings = NO
|
||||
Google.WordList = NO
|
||||
Vale.Spelling = NO
|
||||
# Disable Google.Units in favor of InfluxDataDocs.Units which only checks byte
|
||||
# units (GB, TB, etc). Duration literals (30d, 24h, 1h) are valid InfluxDB syntax.
|
||||
Google.Units = NO
|
||||
Vale.Spelling = NO
|
||||
# Disable Vale.Terms - the vocabulary-based substitution rule creates too many
|
||||
# false positives from URLs, file paths, and code. The accepted terms in
|
||||
# accept.txt still work for spelling checks via InfluxDataDocs.Spelling.
|
||||
Vale.Terms = NO
|
||||
# Disable write-good.TooWordy - flags legitimate technical terms like
|
||||
# "aggregate", "expiration", "multiple", "However" that are standard in
|
||||
# database documentation.
|
||||
write-good.TooWordy = NO
|
||||
|
||||
# Ignore URL paths like /api/v3/..., /cli/..., /influxdb3/...
|
||||
# Ignore full URLs like https://example.com/...
|
||||
# Ignore inline code in frontmatter (description fields, etc.)
|
||||
TokenIgnores = /[a-zA-Z0-9/_\-\.]+, \
|
||||
https?://[^\s\)\]>"]+, \
|
||||
`[^`]+`
|
||||
|
|
@ -19,4 +19,22 @@ Google.DateFormat = NO
|
|||
Google.Ellipses = NO
|
||||
Google.Headings = NO
|
||||
Google.WordList = NO
|
||||
Vale.Spelling = NO
|
||||
# Disable Google.Units in favor of InfluxDataDocs.Units which only checks byte
|
||||
# units (GB, TB, etc). Duration literals (30d, 24h, 1h) are valid InfluxDB syntax.
|
||||
Google.Units = NO
|
||||
Vale.Spelling = NO
|
||||
# Disable Vale.Terms - the vocabulary-based substitution rule creates too many
|
||||
# false positives from URLs, file paths, and code. The accepted terms in
|
||||
# accept.txt still work for spelling checks via InfluxDataDocs.Spelling.
|
||||
Vale.Terms = NO
|
||||
# Disable write-good.TooWordy - flags legitimate technical terms like
|
||||
# "aggregate", "expiration", "multiple", "However" that are standard in
|
||||
# database documentation.
|
||||
write-good.TooWordy = NO
|
||||
|
||||
# Ignore URL paths like /api/v3/..., /cli/..., /influxdb3/...
|
||||
# Ignore full URLs like https://example.com/...
|
||||
# Ignore inline code in frontmatter (description fields, etc.)
|
||||
TokenIgnores = /[a-zA-Z0-9/_\-\.]+, \
|
||||
https?://[^\s\)\]>"]+, \
|
||||
`[^`]+`
|
||||
Loading…
Reference in New Issue