Skip to content

Commit

Permalink
Updates and improvements based on Alison's feedback.
Browse files Browse the repository at this point in the history
  • Loading branch information
sarahlwelton committed Feb 15, 2024
1 parent 352766e commit a88984d
Show file tree
Hide file tree
Showing 7 changed files with 116 additions and 7 deletions.
5 changes: 4 additions & 1 deletion ValeStyles/Couchbase/An.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,7 @@ exceptions:
- '[Aa] <<[BbCcDdFfGgHhJjKkLlMmNnPpQqRrSsTtVvWwXxYyZz].+>>'
- '[Aa] [Oo]ne'
- '[Aa] [Oo]nce'
- '[Aa] [Uu]nit\s'
- '[Aa] [Uu]nit\s'
- '[Aa] [Uu]nique'
- '[Aa] [Uu][Ss][Ee]'
- '[Aa] [Uu]niversal'
86 changes: 86 additions & 0 deletions ValeStyles/Couchbase/UnexplainedAcronym.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,75 +10,161 @@ second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)'
# ... with the exception of these:
exceptions:
- NET
- ALL
- AND
- API
- ASCII
- ASP
- ANY
- CALL
- CASE
- CAST
- CBQ
- CLI
- COPY
- COVER
- CPU
- CSS
- CSV
- cURL
- DEBUG
- DESC
- DITA
- DOC
- DOM
- DROP
- DPI
- EACH
- ELSE
- END
- EVERY
- FALSE
- FAQ
- FETCH
- FIRST
- FLUSH
- FOR
- FORCE
- FROM
- GCC
- GDB
- GET
- GIF
- GNU
- GPU
- GRANT
- GROUP
- GTK
- GUI
- HASH
- HTML
- HTTP
- HTTPS
- IDE
- IF
- ILIKE
- INDEX
- INFER
- INNER
- INTO
- IP
- JAR
- JIRA
- JOIN
- JPEG
- JPG
- JSON
- JSX
- KEY
- KEYS
- KNOWN
- LAST
- LDAP
- LEFT
- LET
- LESS
- LEVEL
- LIKE
- LIMIT
- LLDB
- MAP
- MERGE
- MINUS
- NET
- NEST
- NOT
- NOTE
- NULL
- NULLS
- NVDA
- ORDER
- OSS
- OUTER
- OVER
- PARSE
- PATH
- PDF
- PHP
- PNG
- POOL
- POST
- PROBE
- RAM
- RANGE
- RAW
- REALM
- REPL
- REST
- RIGHT
- ROLE
- ROOT
- ROW
- ROWS
- RSA
- SCM
- SCOPE
- SCSS
- SDK
- SELECT
- SELF
- SEMI
- SET
- SHOW
- SOME
- SQL
- SSH
- START
- SSL
- SVG
- TBD
- THEN
- TIES
- TIP
- TCP
- TLS
- TODO
- TRAN
- TRUE
- UUID
- UNDER
- UNION
- UNSET
- URI
- URL
- USB
- USE
- USER
- UTF
- VALUE
- VIA
- VIEW
- WHEN
- WHERE
- WHILE
- WITH
- WORK
- XML
- XOR
- XSS
- YAML
- ZIP
1 change: 1 addition & 0 deletions styleguidepages/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
** xref:capitalization.adoc[]
** xref:contractions.adoc[]
** xref:less-fewer.adoc[]
** xref:may-can.adoc[]
** xref:only.adoc[]
** xref:there-is.adoc[]
** xref:which-that.adoc[]
Expand Down
7 changes: 5 additions & 2 deletions styleguidepages/modules/ROOT/pages/general.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ The following are some general principles of writing in the Couchbase Style:
* <<Use Plain Language and Contractions>>
* <<Use Simple Sentences and Short Paragraphs>>
As well, try to write using ventilated prose.
This means entering every sentence on a new line in your AsciiDoc files.

== Write in American English

Use American English spelling, not British or Canadian English. The Vale automated spellcheck uses an American English dictionary.
Expand All @@ -18,7 +21,7 @@ If you need to check the spelling of a word, refer to the https://www.merriam-we
If Vale flags a product name or other technical industry term as incorrect:

* If it's a phrase or single word that must have specific capitalization, add it to the `Vocab\Couchbase\accept.txt` file.
* If it's a phrase that needs a specific arrangement of hyphens or spaces and the capitalization doesn't matter, add it to the `Couchbase\Terminology.yml` Vale Style.
* If it's a phrase that needs a specific arrangement of hyphens or spaces and the capitalization does not matter, add it to the `Couchbase\Terminology.yml` Vale Style.

== Write in the Present Tense

Expand Down Expand Up @@ -97,7 +100,7 @@ Here are some tips to help you with active voice:

* Think about what's actually _doing_ the action you're describing. Emphasize the actor.
* Find or push back for more information if you cannot identify the actor. Ask the developer what's actually doing what in a scenario.
* If the sentence doesn't make sense in active voice or you lose the correct emphasis, you can use the passive voice.
* If the sentence does not make sense in active voice or you lose the correct emphasis, you can use the passive voice.

For more information about active voice, see https://developers.google.com/style/voice[Active voice^] in the Google Developer Style Guide.

Expand Down
11 changes: 11 additions & 0 deletions styleguidepages/modules/ROOT/pages/may-can.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
= May vs. Can

Do not use *may* and *can* interchangeably.
They mean different things:

* Use *may* to convey a possibility, or something that could or might happen.
+
For example, it *may* rain tomorrow.
* Use *can* to convey ability, or something that the user is able to accomplish.
+
For example, a user *can* delete a database.
7 changes: 5 additions & 2 deletions styleguidepages/modules/ROOT/pages/parentheses.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,13 @@

Use parentheses sparingly.

Don't use parentheses to set off an aside or comment in text. Use an xref:dashes.adoc[em dash], instead.
Do not use parentheses to set off an aside or comment in text. Use an xref:dashes.adoc[em dash], instead.

You must use parentheses when you mention an unfamiliar acronym for the first time in your documentation. For example, `the Alphabet Biscuit Club (ABC)`.

Parentheses are always acceptable when used inside code blocks.

Don't add parentheses to xref:headings.adoc[].
Do not add parentheses to xref:headings.adoc[].

NOTE: Parentheses are acceptable in situations where you may be describing a SQL++ statement with an optional keyword.
When in doubt, use your best judgment around parentheses, and ignore the Vale flags.
6 changes: 4 additions & 2 deletions styleguidepages/modules/ROOT/pages/quotation-marks.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
= Quotation Marks

Don't use quotation marks outside of inline code or code blocks.
Do not use quotation marks outside of inline code or code blocks.

Use other emphasis options, such as xref:bold.adoc[] or xref:monospace-highlight.adoc[].
Use other emphasis options, such as xref:bold.adoc[] or xref:monospace-highlight.adoc[].

NOTE: When you're writing JSON, you will use quotation marks everywhere. Make sure to enclose your JSON in a code block or use xref:monospace-highlight.adoc[].

0 comments on commit a88984d

Please sign in to comment.