Skip to content

Commit 75d7c4c

Browse files
committed
fix(vale): improve spelling and heading rules for Google style compliance
Spelling improvements: - Exclude fenced code blocks (~code) and inline code (~raw) from checking - Add filters for URL paths, full URLs, and shortcode attributes - Prevents false positives on code syntax and API endpoints Capitalization improvements: - Add InfluxDB product exceptions (InfluxDB, InfluxQL, Telegraf, etc.) - Add common technical acronyms (API, CLI, SQL, HTTP, JSON, etc.) - Add cloud provider names (AWS, GCP, Azure, S3) - Add link to Google style guide for sentence case headings Aligns with Google Developer Documentation Style Guide: https://developers.google.com/style/capitalization https://claude.ai/code/session_0173AuWPoy6UXiatCMGz4W7h
1 parent 9e845ce commit 75d7c4c

File tree

2 files changed

+72
-3
lines changed

2 files changed

+72
-3
lines changed

.ci/vale/styles/InfluxDataDocs/Capitalization.yml

Lines changed: 58 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,69 @@
11
extends: capitalization
22
message: "'%s' should be in sentence case"
3+
link: "https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings"
34
level: warning
45
scope: heading
56
# $title, $sentence, $lower, $upper, or a pattern.
67
match: $sentence
78
style: AP # AP or Chicago; only applies when match is set to $title.
89
exceptions:
9-
# SQL_INFO_SQL_KEYWORDS
10+
# InfluxDB products and components
11+
- InfluxDB
12+
- InfluxQL
13+
- Telegraf
14+
- Kapacitor
15+
- Chronograf
16+
- Flux
17+
- TSM
18+
- WAL
19+
- OSS
20+
# Common technical acronyms
21+
- API
22+
- APIs
23+
- CLI
24+
- SQL
25+
- HTTP
26+
- HTTPS
27+
- URL
28+
- URLs
29+
- CSV
30+
- JSON
31+
- YAML
32+
- TOML
33+
- TLS
34+
- SSL
35+
- TCP
36+
- UDP
37+
- gRPC
38+
- OAuth
39+
- JWT
40+
- REST
41+
- MQTT
42+
- OPC
43+
- SNMP
44+
# Cloud providers
45+
- AWS
46+
- GCP
47+
- Azure
48+
- S3
49+
# Computing terms
50+
- CPU
51+
- GPU
52+
- RAM
53+
- SSD
54+
- HDD
55+
- DNS
56+
- IP
57+
- IPv4
58+
- IPv6
59+
- IoT
60+
- UI
61+
- ID
62+
- IDs
63+
- UUID
64+
- UUIDs
65+
- EOF
66+
# SQL_INFO_SQL_KEYWORDS
1067
# Source: https://github.com/influxdata/influxdb_iox/blob/4f9c901dcfece5fcc4d17cfecb6ec45a0dccda5a/flightsql/src/sql_info
1168
- absolute
1269
- action
Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
extends: spelling
22
message: "Did you really mean '%s'?"
33
level: warning
4+
# Exclude from spell checking:
5+
# - code: fenced code blocks (```...```)
6+
# - raw: inline code (`...`)
7+
# - table.*: table headers and cells
48
scope:
9+
- ~code
10+
- ~raw
511
- ~table.header
612
- ~table.cell
713
ignore:
@@ -10,6 +16,12 @@ ignore:
1016
- InfluxDataDocs/Terms/ignore.txt
1117
- InfluxDataDocs/Terms/query-functions.txt
1218
filters:
13-
# Allow product-specific Branding.yml configurations to handle [Ss]erverless while also allowing serverless as a valid dictionary word.
19+
# Allow product-specific Branding.yml configurations to handle [Ss]erverless
20+
# while also allowing serverless as a valid dictionary word.
1421
- '[Ss]erverless'
15-
22+
# Ignore URL paths (e.g., /api/v2/write, /kapacitor/v1/api/v2/tasks)
23+
- '/[a-zA-Z0-9/_\-\.\{\}]+'
24+
# Ignore full URLs
25+
- 'https?://[^\s\)\]>"]+'
26+
# Ignore shortcode attribute values (e.g., endpoint="..." method="...")
27+
- '(?:endpoint|method|url|href|src|path)="[^"]+"'

0 commit comments

Comments
 (0)