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 1 commit
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
3 changes: 3 additions & 0 deletions meta-docs/STYLE-GUIDE.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
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 without hyphens. A topic may be partitioned through multiple brokers. A "topic partition" represents this logical separation on Redpanda. It is managed by Raft, applying voting mechanisms such as Round Robin. In contrast, other Kafka applications use ZooKeeper to manage their partitions. In Redpanda this is managed natively by Raft.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
|Write without hyphens. A topic may be partitioned through multiple brokers. A "topic partition" represents this logical separation on Redpanda. It is managed by Raft, applying voting mechanisms such as Round Robin. In contrast, other Kafka applications use ZooKeeper to manage their partitions. In Redpanda this is managed natively by Raft.
|Write as 2 words, not 1 hyphenated word.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@paulo please also fix the formatting of the word list table while you're in this file!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed. see https://github.com/redpanda-data/docs-site/blob/style-guide/meta-docs/STYLE-GUIDE.adoc

|Incorrect: topic-partition (hyphenated)
|truststore
|Write as one word. Capitalization might depend on context. Match when it is in a parameter.
|
Expand Down