Skip to content

Commit

Permalink
add topic partitions to style guide (#98)
Browse files Browse the repository at this point in the history
* add topic partitions to style guide

* fix

* lowercase ACL

* remove description

* suggestion
  • Loading branch information
Deflaimun authored Dec 9, 2024
1 parent 8543903 commit d8035ec
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions meta-docs/STYLE-GUIDE.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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."
|
Expand Down Expand Up @@ -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.
|
Expand Down

0 comments on commit d8035ec

Please sign in to comment.