Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add topic partitions to style guide #98

Merged
merged 5 commits into from
Dec 9, 2024
Merged

add topic partitions to style guide #98

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
91fed43
add topic partitions to style guide
Deflaimun Dec 9, 2024
93c9f10
fix
Deflaimun Dec 9, 2024
e627203
lowercase ACL
Deflaimun Dec 9, 2024
38c76e5
remove description
Deflaimun Dec 9, 2024
35e0553
suggestion
Deflaimun Dec 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions meta-docs/STYLE-GUIDE.adoc
View file
Open in desktop
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