Skip to content

Commit d8035ec

Browse files
authored
add topic partitions to style guide (#98)
* add topic partitions to style guide * fix * lowercase ACL * remove description * suggestion
1 parent 8543903 commit d8035ec

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

meta-docs/STYLE-GUIDE.adoc

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -918,8 +918,8 @@ For details about creating Asciidoc tables, see https://docs.asciidoctor.org/asc
918918
|(s)
919919
|Do not use to indicate an optional plural. Use the plural.
920920
|
921-
|Access control list (ACL)
922-
|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).
921+
|access control list (ACL)
922+
|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).
923923
All subsequent references on the page.
924924
|
925925
|as well as
@@ -931,7 +931,7 @@ All subsequent references on the page.
931931

932932
Correct: The rest of this section is based on the assumption that the HTTP proxy port is 8082.
933933

934-
|
934+
935935
|backend
936936
|Do not use "back end."
937937
|
@@ -1100,6 +1100,9 @@ Incorrect: To enable Shadow Indexing on a cluster, set the following parameters
11001100
|topic
11011101
|A topic is a stream of related events. A doc topic is content in Redpanda product doc library.
11021102
|
1103+
|topic partition
1104+
|Write as 2 words, not 1 hyphenated word.
1105+
|Incorrect: topic-partition (hyphenated)
11031106
|truststore
11041107
|Write as one word. Capitalization might depend on context. Match when it is in a parameter.
11051108
|

0 commit comments

Comments
 (0)