Skip to content

Commit

Permalink
docs(review): minor edits to the docs from review (#10804)
Browse files Browse the repository at this point in the history
Signed-off-by: prmellor <[email protected]>
  • Loading branch information
PaulRMellor authored Nov 6, 2024
1 parent 2af12e0 commit 76b49aa
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ listeners:
# ...
----

Instead of specifying the `host` property for every broker, you can also use an `hostTemplate` to generate them automatically.
Instead of specifying the `host` property for every broker, you can also use a `hostTemplate` to generate them automatically.
The `hostTemplate` supports the following variables:

* The `{nodeId}` variable is replaced with the ID of the Kafka node to which the template is applied.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,16 @@ You can deploy Strimzi on Kubernetes {KubernetesVersion} using one of the follow

|xref:deploy-tasks_str[Deployment files (YAML files)]
a|xref:downloads-{context}[Download the deployment files] to manually deploy Strimzi components.
For the greatest flexibility, choose this method.

|xref:deploying-strimzi-from-operator-hub-str[OperatorHub.io]
|Deploy the Strimzi Cluster operator through the OperatorHub.io, then deploy Strimzi components using custom resources.
This method provides a standard configuration and allows you to take advantage of automatic updates.

ifdef::Section[]
|xref:deploying-cluster-operator-helm-chart-str[Helm chart]
|Use a Helm chart to deploy the Cluster Operator, then deploy Strimzi components using custom resources.
Helm charts provide a convenient way to manage the installation of applications.
endif::Section[]

|===

For the greatest flexibility, choose the installation artifacts method.
The OperatorHub.io method provides a standard configuration and allows you to take advantage of automatic updates.
Helm charts provide a convenient way to manage the installation of applications.
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ WARNING: If the User Operator is enabled and Kafka users are not recreated, user
In this procedure, it is essential that PVs are mounted into the correct PVC to avoid data corruption.
A `volumeName` is specified for the PVC and this must match the name of the PV.

For more information, see xref:ref-persistent-storage-{context}[Persistent storage].
For more information, see xref:assembly-storage-{context}[].

.Procedure

Expand Down
2 changes: 1 addition & 1 deletion documentation/shared/attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@
:PodSecurityProvidersConfig: link:https://github.com/strimzi/strimzi-kafka-operator/blob/main/api/src/main/resources/META-INF/services/io.strimzi.plugin.security.profiles.PodSecurityProvider[Provider configuration file^]

//OpenShift documentation
:OpenShiftDocs: link:https://docs.openshift.com[OpenShift documentation^]
:OpenShiftDocs: link:https://docs.redhat.com/en/documentation/openshift_container_platform/[OpenShift documentation^]

// Container image names and repositories
:DockerOrg: quay.io/strimzi
Expand Down

0 comments on commit 76b49aa

Please sign in to comment.