Consistent naming of Kubernetes docs (#215)

.github/crd-config/templates/asciidoctor/operator/type.tpl

@@ -8,7 +8,7 @@
 {{ $type.Doc }}
 
 {{ if eq $type.Name "RedpandaClusterSpec" }}
-For descriptions and default values, see xref:redpanda-helm-spec.adoc[].
+For descriptions and default values, see xref:k-redpanda-helm-spec.adoc[].
 {{ end }}
 
 {{ if $type.References -}}

.github/workflows/generate-crd.yml

@@ -37,12 +37,12 @@ jobs:
       # Generate Operator CRD documentation.
       - name: Generate Operator CRD Docs
         run: |
-          crd-ref-docs --source-path=./redpanda/src/go/k8s/api/redpanda/v1alpha1 --max-depth=10 --templates-dir=./redpanda-docs/.github/crd-config/templates/asciidoctor/operator --config=./redpanda-docs/.github/crd-config/config.yaml --renderer=asciidoctor --output-path=./redpanda-docs/modules/reference/pages/crd.adoc
+          crd-ref-docs --source-path=./redpanda/src/go/k8s/api/redpanda/v1alpha1 --max-depth=10 --templates-dir=./redpanda-docs/.github/crd-config/templates/asciidoctor/operator --config=./redpanda-docs/.github/crd-config/config.yaml --renderer=asciidoctor --output-path=./redpanda-docs/modules/reference/pages/k-crd.adoc
 
       # Generate Topic CRD documentation.
       - name: Generate Operator CRD Docs
         run: |
-          crd-ref-docs --source-path=./redpanda/src/go/k8s/api/cluster.redpanda.com/v1alpha1 --max-depth=10 --templates-dir=./redpanda-docs/.github/crd-config/templates/asciidoctor/topic --config=./redpanda-docs/.github/crd-config/config.yaml --renderer=asciidoctor --output-path=./redpanda-docs/modules/reference/pages/topic-crd.adoc
+          crd-ref-docs --source-path=./redpanda/src/go/k8s/api/cluster.redpanda.com/v1alpha1 --max-depth=10 --templates-dir=./redpanda-docs/.github/crd-config/templates/asciidoctor/topic --config=./redpanda-docs/.github/crd-config/config.yaml --renderer=asciidoctor --output-path=./redpanda-docs/modules/reference/pages/k-topic-crd.adoc
 
       # Check for any changes made in the documentation.
       - name: Check if changes were made

.github/workflows/generate-helm-spec.yml

@@ -52,33 +52,33 @@ jobs:
       # Convert the generated Markdown Helm documentation to AsciiDoc format using pandoc.
       - name: Convert Markdown to AsciiDoc
         run: |
-          pandoc ./helm-charts/charts/redpanda/README.md -t asciidoc -o ./redpanda-docs/modules/reference/pages/redpanda-helm-spec.adoc
-          pandoc ./helm-charts/charts/console/README.md -t asciidoc -o ./redpanda-docs/modules/reference/pages/console-helm-spec.adoc
-          pandoc ./helm-charts/charts/connectors/README.md -t asciidoc -o ./redpanda-docs/modules/reference/pages/connector-helm-spec.adoc
+          pandoc ./helm-charts/charts/redpanda/README.md -t asciidoc -o ./redpanda-docs/modules/reference/pages/k-redpanda-helm-spec.adoc
+          pandoc ./helm-charts/charts/console/README.md -t asciidoc -o ./redpanda-docs/modules/reference/pages/k-console-helm-spec.adoc
+          pandoc ./helm-charts/charts/connectors/README.md -t asciidoc -o ./redpanda-docs/modules/reference/pages/k-connector-helm-spec.adoc
 
       - name: Modify third-level headings format
         run: |
-          sed -i 's/\(\[[0-9]*\)\]\./\1\\]\./g' ./redpanda-docs/modules/reference/pages/redpanda-helm-spec.adoc
-          sed -i 's/\(\[[0-9]*\)\]\./\1\\]\./g' ./redpanda-docs/modules/reference/pages/console-helm-spec.adoc
-          sed -i 's/\(\[[0-9]*\)\]\./\1\\]\./g' ./redpanda-docs/modules/reference/pages/connector-helm-spec.adoc
-          sed -i 's/\(\[[0-9]*\)\]\]/\1\\]\]/g' ./redpanda-docs/modules/reference/pages/redpanda-helm-spec.adoc
-          sed -i 's/\(\[[0-9]*\)\]\]/\1\\]\]/g' ./redpanda-docs/modules/reference/pages/console-helm-spec.adoc
-          sed -i 's/\(\[[0-9]*\)\]\]/\1\\]\]/g' ./redpanda-docs/modules/reference/pages/connector-helm-spec.adoc
-          sed -i 's/=== \(http\([^[]\|\%5[BbDd]\)*\)\[\([^]]*\)\]/=== link:++\1++\[\3\]/' ./redpanda-docs/modules/reference/pages/redpanda-helm-spec.adoc
-          sed -i 's/=== \(http\([^[]\|\%5[BbDd]\)*\)\[\([^]]*\)\]/=== link:++\1++\[\3\]/' ./redpanda-docs/modules/reference/pages/console-helm-spec.adoc
-          sed -i 's/=== \(http\([^[]\|\%5[BbDd]\)*\)\[\([^]]*\)\]/=== link:++\1++\[\3\]/' ./redpanda-docs/modules/reference/pages/connector-helm-spec.adoc
+          sed -i 's/\(\[[0-9]*\)\]\./\1\\]\./g' ./redpanda-docs/modules/reference/pages/k-redpanda-helm-spec.adoc
+          sed -i 's/\(\[[0-9]*\)\]\./\1\\]\./g' ./redpanda-docs/modules/reference/pages/k-console-helm-spec.adoc
+          sed -i 's/\(\[[0-9]*\)\]\./\1\\]\./g' ./redpanda-docs/modules/reference/pages/k-connector-helm-spec.adoc
+          sed -i 's/\(\[[0-9]*\)\]\]/\1\\]\]/g' ./redpanda-docs/modules/reference/pages/k-redpanda-helm-spec.adoc
+          sed -i 's/\(\[[0-9]*\)\]\]/\1\\]\]/g' ./redpanda-docs/modules/reference/pages/k-console-helm-spec.adoc
+          sed -i 's/\(\[[0-9]*\)\]\]/\1\\]\]/g' ./redpanda-docs/modules/reference/pages/k-connector-helm-spec.adoc
+          sed -i 's/=== \(http\([^[]\|\%5[BbDd]\)*\)\[\([^]]*\)\]/=== link:++\1++\[\3\]/' ./redpanda-docs/modules/reference/pages/k-redpanda-helm-spec.adoc
+          sed -i 's/=== \(http\([^[]\|\%5[BbDd]\)*\)\[\([^]]*\)\]/=== link:++\1++\[\3\]/' ./redpanda-docs/modules/reference/pages/k-console-helm-spec.adoc
+          sed -i 's/=== \(http\([^[]\|\%5[BbDd]\)*\)\[\([^]]*\)\]/=== link:++\1++\[\3\]/' ./redpanda-docs/modules/reference/pages/k-connector-helm-spec.adoc
 
       - name: Correct AsciiDoc format
         run: |
           # Correct the title format
-          sed -i 's/^== # \(.*\)/= \1/' ./redpanda-docs/modules/reference/pages/redpanda-helm-spec.adoc
-          sed -i 's/^== # \(.*\)/= \1/' ./redpanda-docs/modules/reference/pages/console-helm-spec.adoc
-          sed -i 's/^== # \(.*\)/= \1/' ./redpanda-docs/modules/reference/pages/connector-helm-spec.adoc
+          sed -i 's/^== # \(.*\)/= \1/' ./redpanda-docs/modules/reference/pages/k-redpanda-helm-spec.adoc
+          sed -i 's/^== # \(.*\)/= \1/' ./redpanda-docs/modules/reference/pages/k-console-helm-spec.adoc
+          sed -i 's/^== # \(.*\)/= \1/' ./redpanda-docs/modules/reference/pages/k-connector-helm-spec.adoc
 
           # Correct the description format
-          sed -i 's/^== description: \(.*\)/:description: \1/' ./redpanda-docs/modules/reference/pages/redpanda-helm-spec.adoc
-          sed -i 's/^== description: \(.*\)/:description: \1/' ./redpanda-docs/modules/reference/pages/console-helm-spec.adoc
-          sed -i 's/^== description: \(.*\)/:description: \1/' ./redpanda-docs/modules/reference/pages/connector-helm-spec.adoc
+          sed -i 's/^== description: \(.*\)/:description: \1/' ./redpanda-docs/modules/reference/pages/k-redpanda-helm-spec.adoc
+          sed -i 's/^== description: \(.*\)/:description: \1/' ./redpanda-docs/modules/reference/pages/k-console-helm-spec.adoc
+          sed -i 's/^== description: \(.*\)/:description: \1/' ./redpanda-docs/modules/reference/pages/k-connector-helm-spec.adoc
 
       # Check if any changes were made in the documentation.
       - name: Check if changes were made

modules/ROOT/nav.adoc

@@ -42,10 +42,10 @@
 * xref:deploy:index.adoc[Deploy]
 ** xref:deploy:deployment-option/self-hosted/index.adoc[Self-Hosted]
 *** xref:deploy:deployment-option/self-hosted/kubernetes/index.adoc[Kubernetes]
-**** xref:deploy:deployment-option/self-hosted/kubernetes/kubernetes-production-deployment.adoc[Overview]
-**** xref:deploy:deployment-option/self-hosted/kubernetes/production-workflow.adoc[Deployment Workflow]
-**** xref:deploy:deployment-option/self-hosted/kubernetes/kubernetes-cluster-requirements.adoc[Requirements and Recommendations]
-**** xref:deploy:deployment-option/self-hosted/kubernetes/kubernetes-tune-workers.adoc[Tune Worker Nodes]
+**** xref:deploy:deployment-option/self-hosted/kubernetes/k-deployment-overview.adoc[Overview]
+**** xref:deploy:deployment-option/self-hosted/kubernetes/k-production-workflow.adoc[Deployment Workflow]
+**** xref:deploy:deployment-option/self-hosted/kubernetes/k-requirements.adoc[Requirements and Recommendations]
+**** xref:deploy:deployment-option/self-hosted/kubernetes/k-tune-workers.adoc[Tune Worker Nodes]
 **** xref:deploy:deployment-option/self-hosted/kubernetes/kubernetes-deploy.adoc[Deploy Redpanda]
 **** xref:deploy:deployment-option/self-hosted/kubernetes/k-deploy-connectors.adoc[Deploy Connectors]
 **** xref:deploy:deployment-option/self-hosted/kubernetes/k-high-availability.adoc[High Availability]
@@ -112,57 +112,57 @@
 ** xref:upgrade:rolling-upgrade.adoc[Upgrade Redpanda in Linux]
 ** xref:upgrade:k-rolling-upgrade.adoc[Upgrade Redpanda in Kubernetes]
 ** xref:upgrade:k-compatibility.adoc[]
-** xref:manage:kubernetes/upgrade-kubernetes.adoc[Upgrade Kubernetes on Worker Nodes Running Redpanda]
+** xref:manage:kubernetes/k-upgrade-kubernetes.adoc[Upgrade Kubernetes on Worker Nodes Running Redpanda]
 ** xref:upgrade:deprecated/index.adoc[Deprecated Features]
 ** xref:upgrade:migrate/index.adoc[Migrate]
 *** xref:upgrade:migrate/data-migration.adoc[]
 *** xref:upgrade:migrate/kubernetes/helm-to-operator.adoc[]
 *** xref:upgrade:migrate/kubernetes/operator.adoc[]
 * xref:manage:index.adoc[Manage]
 ** xref:manage:kubernetes/index.adoc[Kubernetes]
-*** xref:manage:kubernetes/configure-helm-chart.adoc[Customize the Helm Chart]
-*** xref:manage:kubernetes/cluster-property-configuration.adoc[Cluster Properties]
-*** xref:manage:kubernetes/manage-topics.adoc[Manage Topics]
-*** xref:manage:kubernetes/manage-connectors.adoc[Manage Connectors]
+*** xref:manage:kubernetes/k-configure-helm-chart.adoc[Customize the Helm Chart]
+*** xref:manage:kubernetes/k-cluster-property-configuration.adoc[Cluster Properties]
+*** xref:manage:kubernetes/k-manage-topics.adoc[Manage Topics]
+*** xref:manage:kubernetes/k-manage-connectors.adoc[Manage Connectors]
 *** xref:manage:kubernetes/storage/index.adoc[Storage]
-**** xref:manage:kubernetes/storage/volume-types.adoc[Volume Types]
-**** xref:manage:kubernetes/storage/configure-storage.adoc[Configure Storage]
-***** xref:manage:kubernetes/storage/configure-persistent-storage.adoc[PersistentVolume]
-***** xref:manage:kubernetes/storage/configure-hostpath.adoc[hostPath]
-***** xref:manage:kubernetes/storage/configure-emptydir.adoc[emptyDir]
+**** xref:manage:kubernetes/storage/k-volume-types.adoc[Volume Types]
+**** xref:manage:kubernetes/storage/k-configure-storage.adoc[Configure Storage]
+***** xref:manage:kubernetes/storage/k-persistent-storage.adoc[PersistentVolume]
+***** xref:manage:kubernetes/storage/k-hostpath.adoc[hostPath]
+***** xref:manage:kubernetes/storage/k-emptydir.adoc[emptyDir]
 **** xref:manage:kubernetes/tiered-storage-kubernetes/index.adoc[Tiered Storage]
-***** xref:manage:kubernetes/storage/tiered-storage.adoc[Tiered Storage]
-***** xref:manage:kubernetes/storage/data-archiving.adoc[Data Archiving]
-**** xref:manage:kubernetes/storage/resize-persistentvolumes.adoc[Expand PersistentVolumes]
-**** xref:manage:kubernetes/storage/delete-persistentvolume.adoc[Delete PersistentVolumes]
+***** xref:manage:kubernetes/storage/tiered-storage/k-tiered-storage.adoc[Tiered Storage]
+***** xref:manage:kubernetes/storage/tiered-storage/k-data-archiving.adoc[Data Archiving]
+**** xref:manage:kubernetes/storage/k-resize-persistentvolumes.adoc[Expand PersistentVolumes]
+**** xref:manage:kubernetes/storage/k-delete-persistentvolume.adoc[Delete PersistentVolumes]
 *** xref:manage:kubernetes/networking/index.adoc[Networking and Connectivity]
-**** xref:manage:kubernetes/networking/networking-and-connectivity.adoc[Overview]
-**** xref:manage:kubernetes/networking/connect-to-redpanda.adoc[Connect to Redpanda]
-**** xref:manage:kubernetes/networking/configure-listeners.adoc[Configure Listeners]
+**** xref:manage:kubernetes/networking/k-networking-and-connectivity.adoc[Overview]
+**** xref:manage:kubernetes/networking/k-connect-to-redpanda.adoc[Connect to Redpanda]
+**** xref:manage:kubernetes/networking/k-configure-listeners.adoc[Configure Listeners]
 **** xref:manage:kubernetes/networking/external/index.adoc[External Access]
-***** xref:manage:kubernetes/networking/configure-external-access-nodeport.adoc[Use a NodePort Service]
-***** xref:manage:kubernetes/networking/configure-external-access-loadbalancer.adoc[Use LoadBalancer Services]
-***** xref:manage:kubernetes/networking/custom-services.adoc[Use Custom Services]
+***** xref:manage:kubernetes/networking/external/k-nodeport.adoc[Use a NodePort Service]
+***** xref:manage:kubernetes/networking/external/k-loadbalancer.adoc[Use LoadBalancer Services]
+***** xref:manage:kubernetes/networking/external/k-custom-services.adoc[Use Custom Services]
 *** xref:manage:kubernetes/security/index.adoc[Security]
 **** xref:manage:kubernetes/security/tls/index.adoc[TLS Encryption]
-***** xref:manage:kubernetes/security/tls/use-cert-manager.adoc[Use cert-manager]
-***** xref:manage:kubernetes/security/tls/use-secrets.adoc[Use Secrets]
-**** xref:manage:kubernetes/security/authentication/sasl-kubernetes.adoc[Authentication]
-*** xref:manage:kubernetes/kubernetes-rack-awareness.adoc[Rack Awareness]
-*** xref:manage:kubernetes/remote-read-replicas.adoc[Remote Read Replicas]
-*** xref:manage:kubernetes/manage-resources.adoc[Manage Pod Resources]
-*** xref:manage:kubernetes/scale.adoc[Scale]
-*** xref:manage:kubernetes/decommission-brokers.adoc[Decommission Brokers]
+***** xref:manage:kubernetes/security/tls/k-cert-manager.adoc[Use cert-manager]
+***** xref:manage:kubernetes/security/tls/k-secrets.adoc[Use Secrets]
+**** xref:manage:kubernetes/security/authentication/k-authentication.adoc[Authentication]
+*** xref:manage:kubernetes/k-rack-awareness.adoc[Rack Awareness]
+*** xref:manage:kubernetes/k-remote-read-replicas.adoc[Remote Read Replicas]
+*** xref:manage:kubernetes/k-manage-resources.adoc[Manage Pod Resources]
+*** xref:manage:kubernetes/k-scale-redpanda.adoc[Scale]
+*** xref:manage:kubernetes/k-decommission-brokers.adoc[Decommission Brokers]
 *** xref:manage:kubernetes/k-whole-cluster-restore.adoc[Whole Cluster Restore]
 *** xref:manage:kubernetes/k-recovery-mode.adoc[Recovery Mode]
 *** xref:manage:kubernetes/monitoring/index.adoc[Monitor]
-**** xref:manage:kubernetes/monitoring/monitor-redpanda.adoc[Redpanda]
-**** xref:manage:kubernetes/monitoring/monitor-connectors.adoc[Connectors]
+**** xref:manage:kubernetes/monitoring/k-monitor-redpanda.adoc[Redpanda]
+**** xref:manage:kubernetes/monitoring/k-monitor-connectors.adoc[Connectors]
 *** xref:manage:kubernetes/k-rolling-restart.adoc[Rolling Restart]
-*** xref:manage:kubernetes/resilience-testing.adoc[Resilience Testing]
+*** xref:manage:kubernetes/k-resilience-testing.adoc[Resilience Testing]
 *** xref:manage:kubernetes/troubleshooting/index.adoc[Troubleshooting]
-**** xref:manage:kubernetes/troubleshooting/troubleshoot.adoc[]
-**** xref:manage:kubernetes/troubleshooting/diagnostics-bundle.adoc[Diagnostics Bundle]
+**** xref:manage:kubernetes/troubleshooting/k-troubleshoot.adoc[]
+**** xref:manage:kubernetes/troubleshooting/k-diagnostics-bundle.adoc[Diagnostics Bundle]
 ** xref:manage:cluster-maintenance/index.adoc[Cluster Maintenance]
 *** xref:manage:cluster-maintenance/cluster-property-configuration.adoc[]
 *** xref:manage:cluster-maintenance/node-property-configuration.adoc[]
@@ -228,14 +228,14 @@
 *** xref:api:ROOT:pandaproxy-schema-registry.adoc[]
 *** xref:api:ROOT:admin-api.adoc[]
 *** xref:reference:data-transform-api.adoc[]
-** xref:reference:kubernetes-index.adoc[Kubernetes]
-*** xref:reference:kubernetes-helm-index.adoc[]
-**** xref:reference:redpanda-helm-spec.adoc[]
-**** xref:reference:console-helm-spec.adoc[]
-**** xref:reference:connector-helm-spec.adoc[]
-*** xref:reference:kubernetes-crd-index.adoc[]
-**** xref:reference:crd.adoc[]
-**** xref:reference:topic-crd.adoc[]
+** xref:reference:k-index.adoc[Kubernetes]
+*** xref:reference:k-helm-index.adoc[]
+**** xref:reference:k-redpanda-helm-spec.adoc[]
+**** xref:reference:k-console-helm-spec.adoc[]
+**** xref:reference:k-connector-helm-spec.adoc[]
+*** xref:reference:k-crd-index.adoc[]
+**** xref:reference:k-crd.adoc[]
+**** xref:reference:k-topic-crd.adoc[]
 ** xref:reference:monitor-metrics.adoc[Monitoring Metrics]
 *** xref:reference:public-metrics-reference.adoc[Public Metrics Reference]
 *** xref:reference:internal-metrics-reference.adoc[Internal Metrics Reference]

modules/deploy/pages/deployment-option/cloud/managed-connectors/monitor-connectors.adoc

@@ -1,6 +1,6 @@
 = Monitor Connectors
 :description: Use metrics to monitor the health of your Redpanda managed connectors.
-:page-context-links: [{"name": "Cloud", "to": "deploy:deployment-option/cloud/managed-connectors/monitor-connectors.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/monitoring/monitor-connectors.adoc" } ]
+:page-context-links: [{"name": "Cloud", "to": "deploy:deployment-option/cloud/managed-connectors/monitor-connectors.adoc" },{"name": "Kubernetes", "to": "manage:kubernetes/monitoring/k-monitor-connectors.adoc" } ]
 :page-cloud: true
 
 include::manage:partial$monitor-connectors.adoc[]

modules/deploy/pages/deployment-option/self-hosted/kubernetes/aks-guide.adoc

@@ -28,7 +28,7 @@ helm version
 
 == Create an AKS cluster
 
-Your AKS cluster must have one worker node available for each Redpanda broker that you plan to deploy in your Redpanda cluster. You also need to run the worker nodes on a machine type that supports the xref:./kubernetes-cluster-requirements.adoc[requirements and recommendations] for production deployments.
+Your AKS cluster must have one worker node available for each Redpanda broker that you plan to deploy in your Redpanda cluster. You also need to run the worker nodes on a machine type that supports the xref:./k-requirements.adoc[requirements and recommendations] for production deployments.
 
 In this step, you create an AKS cluster with three nodes on https://learn.microsoft.com/en-us/azure/virtual-machines/lsv3-series[Standard_L8s_v3 Azure Virtual Machines (Azure VMs)]. Deploying three nodes allows your AKS cluster to support a Redpanda cluster with three brokers. The Standard_L8s_v3 Azure VMs come with:
 

modules/deploy/pages/deployment-option/self-hosted/kubernetes/eks-guide.adoc

@@ -242,7 +242,7 @@ helm version
 
 == Create an EKS cluster
 
-Your EKS cluster must have one worker node available for each Redpanda broker that you plan to deploy in your Redpanda cluster. You also need to run the worker nodes on an EC2 instance type that supports the xref:./kubernetes-cluster-requirements.adoc[requirements and recommendations] for production deployments.
+Your EKS cluster must have one worker node available for each Redpanda broker that you plan to deploy in your Redpanda cluster. You also need to run the worker nodes on an EC2 instance type that supports the xref:./k-requirements.adoc[requirements and recommendations] for production deployments.
 
 In this step, you create an EKS cluster with three nodes on https://aws.amazon.com/ec2/instance-types/c5/[`c5d.2xlarge` instance types]. Deploying three nodes allows your EKS cluster to support a Redpanda cluster with three brokers. The `c5d.2xlarge` instance type comes with:
 

modules/deploy/pages/deployment-option/self-hosted/kubernetes/get-started-dev.adoc

@@ -1,6 +1,6 @@
 = Get Started with Redpanda in Kubernetes
 :description: Find guides for setting up a three-broker Redpanda cluster in different Kubernetes platforms.
-:page-aliases: quickstart:kubernetes-qs-dev.adoc, getting-started:quick-start-kubernetes.adoc, get-started:quick-start/kubernetes-qs-dev.adoc, quickstart:index.adoc, quickstart:index/index.adoc
+:page-aliases: quickstart:kubernetes-qs-dev.adoc, getting-started:quick-start-kubernetes.adoc, get-started:quick-start/kubernetes-qs-dev.adoc, quickstart:index.adoc, quickstart:index/index.adoc, quickstart:kubernetes-qs-cloud.adoc, getting-started:kubernetes-qs-cloud.adoc
 
 For end-to-end guides on secure deployments of Redpanda on managed Kubernetes services, see:
 
@@ -9,7 +9,7 @@ For end-to-end guides on secure deployments of Redpanda on managed Kubernetes se
 * xref:./gke-guide.adoc[Google Kubernetes Engine] (GKE)
 * xref:./local-guide.adoc[Local (kind or minikube)]
 
-Or, if you're ready to go into production, see the xref:./production-workflow.adoc[production deployment workflow].
+Or, if you're ready to go into production, see the xref:./k-production-workflow.adoc[production deployment workflow].
 
 include::shared:partial$suggested-reading.adoc[]