From 76b49aa16a702493236d3f8aebf221fb2ddba32b Mon Sep 17 00:00:00 2001 From: PaulRMellor <47596553+PaulRMellor@users.noreply.github.com> Date: Tue, 5 Nov 2024 22:58:47 -0500 Subject: [PATCH] docs(review): minor edits to the docs from review (#10804) Signed-off-by: prmellor --- ...l.kafka.listener.GenericKafkaListenerConfiguration.adoc | 2 +- .../deploying/con-strimzi-installation-methods.adoc | 7 +++---- .../modules/managing/proc-cluster-recovery-volume-zk.adoc | 2 +- documentation/shared/attributes.adoc | 2 +- 4 files changed, 6 insertions(+), 7 deletions(-) diff --git a/documentation/api/io.strimzi.api.kafka.model.kafka.listener.GenericKafkaListenerConfiguration.adoc b/documentation/api/io.strimzi.api.kafka.model.kafka.listener.GenericKafkaListenerConfiguration.adoc index 11afb848759..d63ca9d9f6e 100644 --- a/documentation/api/io.strimzi.api.kafka.model.kafka.listener.GenericKafkaListenerConfiguration.adoc +++ b/documentation/api/io.strimzi.api.kafka.model.kafka.listener.GenericKafkaListenerConfiguration.adoc @@ -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. diff --git a/documentation/modules/deploying/con-strimzi-installation-methods.adoc b/documentation/modules/deploying/con-strimzi-installation-methods.adoc index d27500d043e..67492e1ad8d 100644 --- a/documentation/modules/deploying/con-strimzi-installation-methods.adoc +++ b/documentation/modules/deploying/con-strimzi-installation-methods.adoc @@ -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. diff --git a/documentation/modules/managing/proc-cluster-recovery-volume-zk.adoc b/documentation/modules/managing/proc-cluster-recovery-volume-zk.adoc index 8f32c351fce..e26c18205c7 100644 --- a/documentation/modules/managing/proc-cluster-recovery-volume-zk.adoc +++ b/documentation/modules/managing/proc-cluster-recovery-volume-zk.adoc @@ -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 diff --git a/documentation/shared/attributes.adoc b/documentation/shared/attributes.adoc index 17818d8ee34..d78d345e74c 100644 --- a/documentation/shared/attributes.adoc +++ b/documentation/shared/attributes.adoc @@ -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