docs: Various fixes for commands syntax and typos#484
Open
izmalk wants to merge 8 commits intocanonical:mainfrom
Open
docs: Various fixes for commands syntax and typos#484izmalk wants to merge 8 commits intocanonical:mainfrom
izmalk wants to merge 8 commits intocanonical:mainfrom
Conversation
Updated the edge deployment to stable for the tutorial. Tested the affected parts. Claude Opus 4.6.
Delete ZK leftovers. Fix how-to guides commands syntax and typos.
izmalk
added
documentation
There was a problem hiding this comment.
Pull request overview
This PR fixes documentation command syntax and typos across multiple how-to guides, and removes leftover ZooKeeper references where the docs are Kafka-only.
Changes:
- Corrects several Juju/CLI command examples (e.g.,
grant-secret, command substitutions, file paths, line continuations). - Removes/adjusts ZooKeeper references from Kafka-focused how-to guides.
- Fixes typos in action/command names and binding examples.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/how-to/upgrade.md | Updates rollback command example to use a shell variable. |
| docs/how-to/tls-encryption.md | Fixes juju grant-secret example to include the target application. |
| docs/how-to/schemas-serialisation.md | Removes ZooKeeper prerequisite and fixes a broken multi-line curl example. |
| docs/how-to/monitoring.md | Removes ZooKeeper monitoring instructions and refines COS integration commands/examples. |
| docs/how-to/manage-units.md | Corrects broker client properties path and adjusts quoting for topic listing command. |
| docs/how-to/deploy/deploy-spaces.md | Fixes a spaces binding typo (client vs clients). |
| docs/how-to/create-mtls-client-credentials.md | Fixes typo in get-ca-certificate action name. |
| docs/how-to/cluster/migrate.md | Fixes SECRET assignment to use proper command substitution. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+115
to
+119
| Deploy the `cos-lite` bundle in a Kubernetes environment and integrate Charmed Apache Kafka to the COS offers, as shown above in the [Enable Monitoring](how-to-monitoring-enable-monitoring) section. | ||
| This guide will refer to the models that charms are deployed into as: | ||
|
|
||
| * `<cos-model>` for the model containing observability charms (and deployed on K8s) | ||
| * `<apps-model>` for the model containing Charmed Apache Kafka and Charmed Apache ZooKeeper | ||
| * `<apps-model>` for other optional charms (e.g. TLS-certificates operators, `grafana-agent`, `data-integrator`, etc.). | ||
| * `<apps-model>` for the model containing Charmed Apache Kafka and other optional charms (e.g. TLS-certificates operators, `grafana-agent`, `data-integrator`, etc.). |
There was a problem hiding this comment.
The placeholder naming is inconsistent within this doc: this section introduces <cos-model>, but earlier commands use <cos_model_name> (underscore) and <k8s_cos_controller>. Please standardize the placeholders throughout to avoid readers mixing model/controller identifiers when copying commands.
izmalk
changed the title
Minor wording. Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Vladimir Izmalkov <48120135+izmalk@users.noreply.github.com>
This file contains hidden or 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
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.
Description
I've noticed and fixed a few typos in commands used in our how-to guides.
Deleted ZK leftovers.
Fixed how-to guides' commands' syntax and typos.
Checklist