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

docs(review): minor edits to the docs from review #10804

Merged
merged 2 commits into from
Nov 6, 2024
Merged

docs(review): minor edits to the docs from review #10804

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6724c89
docs(review): minor edits to the docs from review
PaulRMellor Nov 5, 2024
459a2b5
docs(review): updates openshift docs link
PaulRMellor Nov 5, 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
2 changes: 1 addition & 1 deletion ...o.strimzi.api.kafka.model.kafka.listener.GenericKafkaListenerConfiguration.adoc
View file
Open in desktop
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
7 changes: 3 additions & 4 deletions documentation/modules/deploying/con-strimzi-installation-methods.adoc
View file
Open in desktop
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.
2 changes: 1 addition & 1 deletion documentation/modules/managing/proc-cluster-recovery-volume-zk.adoc
View file
Open in desktop
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
View file
Open in desktop
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
Loading