Making changes based on EA review issues. Updating multiple rules and style guide pages

sarahlwelton · sarahlwelton · commit 4b16424fd9fb · 2025-07-28T12:24:53.000-04:00
diff --git a/ValeStyles/Couchbase/DirectionalLanguage.yml b/ValeStyles/Couchbase/DirectionalLanguage.yml
@@ -6,11 +6,11 @@ link: https://docs.couchbase.com/styleguide/directional-language.html
 tokens: 
   - left
   - right
-  - (?<=\bmove\s+)\bup\b
+  - '(?<=\bmove\s+)\bup\b'
   - '(?<!(sign|set|back|signing|setting|backing)\s)up(?!\sto)'
   - '(?<!(shut)\s)down'
-  - below
-  - above
+  - '\b(?:above|below|over) the\b'
+  - 'is (?:above|below|over)\b'
 # exceptions:
 #   - '(?<=set\s)up'
 #   - 'up(?=\sto)'
diff --git a/ValeStyles/Couchbase/Italics.yml b/ValeStyles/Couchbase/Italics.yml
@@ -5,4 +5,5 @@ link: https://docs.couchbase.com/styleguide/italic.html
 scope: 
   - raw
 tokens:
-  - '(?<!`)\b_\w.*?_\b(?!`)'
+  - '(?<!`)\b_\w.*?_\b(?!`)'
+  - '\|\s*_(.*?)_'
diff --git a/ValeStyles/Couchbase/Numbers.yml b/ValeStyles/Couchbase/Numbers.yml
@@ -0,0 +1,26 @@
+extends: existence
+message: Write all numbers as numerals.
+level: error
+link: https://docs.couchbase.com/styleguide/numbers.html
+
+tokens:
+  - one
+  - two
+  - three
+  - four
+  - five
+  - six
+  - seven
+  - eight
+  - nine
+  - ten
+  - eleven
+  - twelve
+  - thirteen
+  - fourteen
+  - fifteen
+  - sixteen
+  - seventeen
+  - eighteen
+  - nineteen
+  - twenty
diff --git a/ValeStyles/Couchbase/ReferTo.yml b/ValeStyles/Couchbase/ReferTo.yml
@@ -1,7 +1,7 @@
 extends: existence
 message: Introduce links with 'For more information, see {link}'.
 level: error
-# link: TBD
+link: https://docs.couchbase.com/styleguide/links.html
 
 tokens: 
   - 'Refer to'
diff --git a/ValeStyles/Google/WordList.yml b/ValeStyles/Google/WordList.yml
@@ -21,8 +21,8 @@ swap:
   'Google (?:I\-O|IO)': Google I/O
   'tap (?:&|and) hold': touch & hold
   'un(?:check|select)': clear
-  above: preceding|later
-  '(?:to access|access the)': see|edit|find|use|view
+  #above: preceding|later
+  '(?:to access|access the)': see|edit|find|open|use|view
   account name: username
   action bar: app bar
   admin: administrator
diff --git a/ValeStyles/config/vocabularies/Couchbase/accept.txt b/ValeStyles/config/vocabularies/Couchbase/accept.txt
@@ -40,6 +40,8 @@ Couchbase Monitoring and Observability Stack
 Couchbase Server
 Couchbase
 Couchstore
+CPU
+CPUs
 curl
 Database Change Protocol
 datacenter
@@ -84,6 +86,8 @@ Java
 JavaScript
 JIRA
 JSON
+JVM
+JVMs
 Kafka
 [Kk]eyspace
 Kroki
@@ -129,6 +133,7 @@ rack awareness
 RA
 RBAC
 Read Committed
+[Rr]ebalance
 [Rr]ebase
 [Rr]epositories
 [Rr]etryable
@@ -173,6 +178,7 @@ vBuckets
 VBucketServerMap
 Views Service
 [Vv]irtualization
+[Vv]irtualized
 vmstat
 VMware
 Vue
diff --git a/styleguide/modules/ROOT/pages/directional-language.adoc b/styleguide/modules/ROOT/pages/directional-language.adoc
@@ -17,4 +17,4 @@ If the automatic Vale rule flags a use of directional language:
 
 * If the usage is describing values, such as `a value above 10` or `a value below 20`, rewrite the sentence to use `a value greater than 10` or `a value less than 20`, respectively.
 
-* If the usage is in a valid phrase, such as `back up`, let the tooling team know so that an exception can be added to the rule. 
+* If the usage is in a valid phrase, such as `back up`, let the tooling team know so that an exception can be added to the rule.
diff --git a/styleguide/modules/ROOT/pages/links.adoc b/styleguide/modules/ROOT/pages/links.adoc
@@ -1,8 +1,14 @@
 = Links
 
-Follow the https://developers.google.com/style/link-text[Google Developer Style Guide^]'s guidance on how to write link text. In general, make it clear where a user ends up after they click a link. 
+Follow the https://developers.google.com/style/link-text[Google Developer Style Guide^]'s guidance on how to write link text.
+In general, make it clear where a user ends up after they click a link.
 
-NOTE: This doesn't mean to just use the URL as the displayed link text. Try to write effective and useful link text for all links.
+NOTE: This does not mean to just use the URL as the displayed link text.
+Try to write effective and useful link text for all links.
+
+Introduce all links with `For more information, see {link}.`
+Do not use `Refer to`, `For more details`, or other constructions.
+If you need to use another construction, try to have a good justification for that specific use case, and still try to keep the `For x, see y` construction.
 
 Keep the following formatting and conventions in mind for <<internal>> and <<external>> in the Couchbase Documentation. 
 
diff --git a/styleguide/modules/ROOT/pages/numbers.adoc b/styleguide/modules/ROOT/pages/numbers.adoc
@@ -1,10 +1,11 @@
 = Numbers 
 
-Contrary to the https://developers.google.com/style/numbers[Google Style Guide^], we have decided to write out all numbers in the Couchbase Documentation. 
+Contrary to the https://developers.google.com/style/numbers[Google Style Guide^], Couchbase style writes all numbers, regardless of size, as numerals instead of words.
 
-Always use the numeral, no matter the size of the number. 
+Always use the numeral, no matter the size of the number.
 
 For example: 
 
 * `1 or more`
-* `2-day total`
+* `2-day total`
+* `3-node cluster`

Original file line number	Diff line number	Diff line change
`@@ -17,4 +17,4 @@ If the automatic Vale rule flags a use of directional language:`
`17`	`17`
`18`	`18`	* If the usage is describing values, such as `a value above 10` or `a value below 20`, rewrite the sentence to use `a value greater than 10` or `a value less than 20`, respectively.
`19`	`19`
`20`		-* If the usage is in a valid phrase, such as `back up`, let the tooling team know so that an exception can be added to the rule.
	`20`	+* If the usage is in a valid phrase, such as `back up`, let the tooling team know so that an exception can be added to the rule.