add topic partitions to style guide #98
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for redpanda-documentation ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
4 tasks
micheleRP
reviewed
Dec 9, 2024
meta-docs/STYLE-GUIDE.adoc
Outdated
| @@ -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. | |||
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
@paulo please also fix the formatting of the word list table while you're in this file!
There was a problem hiding this comment.
micheleRP
approved these changes
Dec 9, 2024
|
Wrote the definition here in the glossary entry |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.