diff --git a/meta-docs/STYLE-GUIDE.adoc b/meta-docs/STYLE-GUIDE.adoc index 570ae1f..b933398 100644 --- a/meta-docs/STYLE-GUIDE.adoc +++ b/meta-docs/STYLE-GUIDE.adoc @@ -918,8 +918,8 @@ For details about creating Asciidoc tables, see https://docs.asciidoctor.org/asc |(s) |Do not use to indicate an optional plural. Use the plural. | -|Access control list (ACL) -|Spell it out the first time you introduce it on a page, with the acronym in parentheses. After that, you can just use the acronym. Always capitalize the acronym. Do not capitalize access control list unless it’s the first word in a sentence. The plural is ACLs. First time you introduce it on a page: access control list (ACL), access control lists (ACLs). +|access control list (ACL) +|Lowercase. Spell it out the first time you introduce it on a page, with the acronym in parentheses. After that, you can just use the acronym. Always capitalize the acronym. Do not capitalize access control list unless it’s the first word in a sentence. The plural is ACLs. First time you introduce it on a page: access control list (ACL), access control lists (ACLs). All subsequent references on the page. | |as well as @@ -931,7 +931,7 @@ All subsequent references on the page. Correct: The rest of this section is based on the assumption that the HTTP proxy port is 8082. -| + |backend |Do not use "back end." | @@ -1100,6 +1100,9 @@ Incorrect: To enable Shadow Indexing on a cluster, set the following parameters |topic |A topic is a stream of related events. A doc topic is content in Redpanda product doc library. | +|topic partition +|Write as 2 words, not 1 hyphenated word. +|Incorrect: topic-partition (hyphenated) |truststore |Write as one word. Capitalization might depend on context. Match when it is in a parameter. |