Skip to content

Commit

Permalink
Updated docs to use the term zoo keeper correctly (#137)
Browse files Browse the repository at this point in the history
* Updated docs to use the term ZooKeeper correctly

---------

Signed-off-by: Roshan Goswami <[email protected]>
  • Loading branch information
csengineer1990 authored Oct 19, 2023
1 parent b5ce337 commit b20737c
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 5 deletions.
3 changes: 2 additions & 1 deletion .github/vale/styles/Klaw/branding.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,5 @@ swap:
"(?i)ssl": SSL
"(?<!Klaw )cluster api": Klaw Cluster API
"(?i)kafka[ -]?connect": Kafka Connect
"(?i)api": API
"(?i)zookeeper": ZooKeeper
"(?i)api": API
2 changes: 1 addition & 1 deletion .github/vale/vale.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ The words in our custom spelling are **case sensitive**!
#### Adding word to custom dictionary

If the word is correctly written, you can add extend our vocabulary. Add the word you
need in the file `spelling-klaw-vocabulary.txt`. After you added your word, sort the lines alphabetically (except the first one). Make sure you add the correct capitalization, as the words are case-sensitive. Adding "ZooKeeper" for example will still show an error for "zookeeper", which is something we want.
need in the file `spelling-klaw-vocabulary.txt`. After you added your word, sort the lines alphabetically (except the first one). Make sure you add the correct capitalization, as the words are case-sensitive.

##### When not to add a word

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -99,12 +99,12 @@ Failures are an inevitable part of any system, and Kafka applications
are no different. These failures can occur at different levels,
including client-side issues where event deserialization creates
problems for consumers, as well as infrastructure-related issues that
result in the loss of zookeeper/Kafka configurations.
result in the loss of ZooKeeper/Kafka configurations.

In the context of infrastructure failures, let's consider a scenario
with 1000 topics, each possessing a unique configuration stored in a
zookeeper. Now, imagine a situation where a disaster strikes, causing
the zookeeper to crash and be unable to recover. This raises a critical
ZooKeeper. Now, imagine a situation where a disaster strikes, causing
the ZooKeeper to crash and be unable to recover. This raises a critical
question: how swiftly can you retrieve the information and reboot your
server? It's not just about having methods to store information but
also about strategically implementing storage and retrieval processes
Expand Down

0 comments on commit b20737c

Please sign in to comment.