Skip to content

CNTRLPLANE-3254: Sort how-to guides alphabetically and add CI enforcement #8248

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

Merged
openshift-merge-bot merged 3 commits into from
Apr 15, 2026
Merged

CNTRLPLANE-3254: Sort how-to guides alphabetically and add CI enforcement #8248

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f4feac7
docs: sort how-to guides alphabetically and group platforms
bryan-cox Apr 15, 2026
f41eec0
ci: add verify-docs-nav to enforce alphabetical nav ordering
bryan-cox Apr 15, 2026
fd1ede3
chore: fix pre-existing formatting in karpenter_test.go
bryan-cox Apr 15, 2026
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
6 changes: 5 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ verify-codecov: ## Validate codecov.yml against Codecov's API.
| tee /dev/stderr | grep -q "^Valid!"

.PHONY: verify-parallel
verify-parallel: verify-codespell verify-codecov lint cpo-container-sync run-gitlint
verify-parallel: verify-codespell verify-codecov lint cpo-container-sync run-gitlint verify-docs-nav

.PHONY: verify
verify: generate update staticcheck fmt vet
Expand Down Expand Up @@ -500,6 +500,10 @@ hypershift-install-aws-dev:
run-operator-locally-aws-dev:
@$(RUN_OPERATOR_LOCALLY_AWS)

.PHONY: verify-docs-nav
verify-docs-nav: ## Verify docs nav entries are sorted alphabetically.
python3 hack/verify-docs-nav-order.py

.PHONY: verify-codespell
verify-codespell: codespell ## Verify codespell.
@$(CODESPELL) --count --ignore-words=./.codespellignore --skip="./hack/tools/bin/codespell_dist,./docs/site/*,./vendor/*,./api/vendor/*,./hack/tools/vendor/*,./api/hypershift/v1alpha1/*,./support/thirdparty/*,./docs/content/reference/*,./hack/tools/bin/*,./cmd/install/assets/*,./go.sum,./hack/workspace/go.work.sum,./api/hypershift/v1beta1/zz_generated.featuregated-crd-manifests,./hack/tools/go.mod,./hack/tools/go.sum,./karpenter-operator/controllers/karpenter/assets/*.yaml,./dev/*"
Expand Down
11 changes: 11 additions & 0 deletions docs/content/contribute/contribute-docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,17 @@ to preview the site equivalent to the published site.
edit it manually. See the [API generation section](#generate-the-api-reference)
section for details.

## Adding how-to guides

When adding a new how-to guide, you must insert the entry in **alphabetical order**
by display title within the appropriate section of the `nav:` in
[`docs/mkdocs.yml`](https://github.com/openshift/hypershift/blob/main/docs/mkdocs.yml).
Platform-specific guides belong under the `Platform` section.

The `make verify` target includes a `verify-docs-nav` check that validates
alphabetical ordering. If your entry is out of order, the check will fail and
show the expected order.

## Preview the site locally

To start a live preview of the site which automatically rebuilds and refreshes in
Expand Down
11 changes: 11 additions & 0 deletions docs/content/reference/aggregated-docs.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

225 changes: 113 additions & 112 deletions docs/mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,135 +58,136 @@ nav:
- 'Getting started': getting-started.md
- 'How-to guides':
- how-to/index.md
- how-to/feature-gates.md
- 'Agentic SDLC': how-to/agentic-sdlc.md
- how-to/audit-log-persistence.md
- 'Automated Machine Management':
- how-to/automated-machine-management/index.md
- how-to/automated-machine-management/configure-machines.md
- how-to/automated-machine-management/performance-profiling.md
- how-to/automated-machine-management/node-tuning.md
- how-to/automated-machine-management/nodepool-lifecycle.md
- how-to/automated-machine-management/scale-to-zero-dataplane.md
- 'CI':
- 'AI-Assisted CI Jobs': how-to/ci/ai-assisted-ci-jobs.md
- how-to/ci/ci-infrastructure.md
- how-to/ci/checking-ci.md
- 'Documentation Preview': how-to/ci/docs-preview.md
- 'Common':
- how-to/common/exposing-services-from-hcp.md
- 'Global Pull Secret': how-to/common/global-pull-secret.md
- 'HCP Networking Requirements': how-to/common/hcp-networking-requirements.md
- how-to/common/multi-arch-on-hcp.md
- how-to/metrics-sets.md
- 'Configure OCP components':
- how-to/configure-ocp-components/index.md
- how-to/configure-ocp-components/kubeapi-server.md
- how-to/configure-ocp-components/custom-kas-kubeconfig.md
- how-to/configure-ocp-components/oauth-serving-certificates.md
- how-to/distribute-hosted-cluster-workloads.md
- how-to/upgrades.md
- how-to/restart-control-plane-components.md
- how-to/resource-based-control-plane-autoscaling.md
- how-to/pause-reconciliation.md
- how-to/configure-ocp-components/custom-kas-kubeconfig.md
- how-to/per-hostedcluster-dashboard.md
- how-to/metrics-sets.md
- how-to/troubleshooting-general.md
- 'Common':
- 'HCP Networking Requirements': how-to/common/hcp-networking-requirements.md
- how-to/common/exposing-services-from-hcp.md
- how-to/common/multi-arch-on-hcp.md
- 'Global Pull Secret': how-to/common/global-pull-secret.md
- 'Agentic SDLC': how-to/agentic-sdlc.md
- 'CI':
- how-to/ci/checking-ci.md
- how-to/ci/ci-infrastructure.md
- 'AI-Assisted CI Jobs': how-to/ci/ai-assisted-ci-jobs.md
- 'Documentation Preview': how-to/ci/docs-preview.md
- 'HyperShift Operator Install':
- how-to/install/index.md
- 'PKI and Certificates':
- how-to/pki/index.md
- how-to/pki/control-plane-certificates.md
- how-to/pki/break-glass-credentials.md
- 'Disaster Recovery':
- how-to/disaster-recovery/index.md
- 'Prerequisites': how-to/disaster-recovery/prerequisites.md
- how-to/disaster-recovery/dr-cli.md
- how-to/disaster-recovery/backup-and-restore-oadp.md
- how-to/disaster-recovery/backup-and-restore-oadp-1-5.md
- how-to/disaster-recovery/etcd-recovery.md
- 'Automated Machine Management':
- how-to/automated-machine-management/index.md
- how-to/automated-machine-management/scale-to-zero-dataplane.md
- how-to/automated-machine-management/nodepool-lifecycle.md
- how-to/automated-machine-management/node-tuning.md
- how-to/automated-machine-management/configure-machines.md
- how-to/automated-machine-management/performance-profiling.md
- 'AWS':
- how-to/aws/create-aws-hosted-cluster-arm-workers.md
- how-to/aws/create-infra-iam-separately.md
- how-to/aws/create-aws-hosted-cluster-multiple-zones.md
- how-to/aws/create-aws-hosted-cluster-autonode.md
- how-to/aws/deploy-aws-private-clusters.md
- how-to/aws/external-dns.md
- how-to/aws/etc-backup-restore.md
- how-to/aws/disaster-recovery.md
- how-to/aws/shared-vpc.md
- how-to/aws/define-custom-kube-api-name.md
- 'Global Pull Secret': how-to/aws/global-pull-secret.md
- 'Other SDN providers': how-to/aws/other-sdn-providers.md
- 'Troubleshooting':
- how-to/aws/troubleshooting/index.md
- how-to/aws/troubleshooting/debug-nodes.md
- how-to/aws/troubleshooting/troubleshooting-disaster-recovery.md
- 'Azure':
- how-to/azure/index.md
- 'Managed Azure':
- how-to/azure/create-azure-cluster-on-aks.md
- how-to/azure/create-azure-cluster-with-options.md
- how-to/azure/scheduler.md
- 'Self-managed Azure':
- how-to/azure/self-managed-azure-index.md
- how-to/azure/azure-workload-identity-setup.md
- how-to/azure/setup-management-cluster.md
- how-to/azure/create-self-managed-azure-cluster.md
- how-to/azure/create-iam-separately.md
- how-to/azure/create-infra-separately.md
- how-to/azure/deploy-azure-private-clusters.md
- 'Global Pull Secret': how-to/azure/global-pull-secret.md
- 'Troubleshooting':
- how-to/azure/troubleshooting/index.md
- how-to/azure/troubleshooting/debug-nodes.md
- 'GCP':
- how-to/gcp/index.md
- how-to/gcp/setup-management-cluster.md
- how-to/gcp/create-gcp-infra.md
- how-to/gcp/create-gcp-iam.md
- how-to/gcp/create-gcp-hosted-cluster.md
- how-to/gcp/e2e-gke-ci-job.md
- 'Agent':
- how-to/agent/create-agent-cluster.md
- how-to/agent/create-heterogeneous-nodepools.md
- 'Other SDN providers': how-to/agent/other-sdn-providers.md
- 'Exposing HCP Services': how-to/agent/exposing-services-from-hcp.md
- 'Global Pull Secret': how-to/agent/global-pull-secret.md
- 'Prerequisites': how-to/disaster-recovery/prerequisites.md
- 'Disconnected':
- how-to/disconnected/index.md
- how-to/disconnected/tls-certificates.md
- 'IDMS/ICSP Config for Management Cluster': how-to/disconnected/idms-icsp-for-management-clusters.md
- how-to/disconnected/image-content-sources.md
- how-to/disconnected/disconnected-workarounds.md
- how-to/disconnected/tls-certificates.md
- 'IDMS/ICSP Config for Management Cluster': how-to/disconnected/idms-icsp-for-management-clusters.md
- how-to/disconnected/known-issues.md
- 'Kubevirt':
- how-to/kubevirt/create-kubevirt-cluster.md
- how-to/kubevirt/ingress-and-dns.md
- how-to/kubevirt/configuring-storage.md
- how-to/kubevirt/configuring-network.md
- how-to/kubevirt/performance-tuning.md
- how-to/kubevirt/external-infrastructure.md
- how-to/kubevirt/gpu-devices.md
- how-to/kubevirt/troubleshooting-kubevirt-cluster.md
- 'Global Pull Secret': how-to/kubevirt/global-pull-secret.md
- 'OpenStack':
- how-to/openstack/index.md
- how-to/openstack/prerequisites.md
- how-to/openstack/hostedcluster.md
- how-to/openstack/az.md
- how-to/openstack/additional-ports.md
- how-to/openstack/performance-tuning.md
- how-to/openstack/destroy.md
- 'Global Pull Secret': how-to/openstack/global-pull-secret.md
- 'None':
- how-to/none/create-none-cluster.md
- 'Exposing HCP Services': how-to/agent/exposing-services-from-hcp.md
- 'Global Pull Secret': how-to/none/global-pull-secret.md
- 'PowerVS':
- how-to/powervs/create-cluster-powervs.md
- how-to/powervs/create-infra-separately.md
- how-to/powervs/prerequisites-and-env-guide.md
- 'Global Pull Secret': how-to/powervs/global-pull-secret.md
- how-to/distribute-hosted-cluster-workloads.md
- how-to/feature-gates.md
- 'HyperShift Operator Install':
- how-to/install/index.md
- how-to/pause-reconciliation.md
- 'PKI and Certificates':
- how-to/pki/index.md
- how-to/pki/break-glass-credentials.md
- how-to/pki/control-plane-certificates.md
- 'Platform':
- 'Agent':
- how-to/agent/create-agent-cluster.md
- how-to/agent/create-heterogeneous-nodepools.md
- 'Exposing HCP Services': how-to/agent/exposing-services-from-hcp.md
- 'Global Pull Secret': how-to/agent/global-pull-secret.md
- 'Other SDN providers': how-to/agent/other-sdn-providers.md
- 'AWS':
- how-to/aws/create-aws-hosted-cluster-arm-workers.md
- how-to/aws/create-aws-hosted-cluster-autonode.md
- how-to/aws/create-aws-hosted-cluster-multiple-zones.md
- how-to/aws/create-infra-iam-separately.md
- how-to/aws/define-custom-kube-api-name.md
- how-to/aws/deploy-aws-private-clusters.md
- how-to/aws/disaster-recovery.md
- how-to/aws/etc-backup-restore.md
- how-to/aws/external-dns.md
- 'Global Pull Secret': how-to/aws/global-pull-secret.md
- 'Other SDN providers': how-to/aws/other-sdn-providers.md
- how-to/aws/shared-vpc.md
- 'Troubleshooting':
- how-to/aws/troubleshooting/index.md
- how-to/aws/troubleshooting/troubleshooting-disaster-recovery.md
- how-to/aws/troubleshooting/debug-nodes.md
- 'Azure':
- how-to/azure/index.md
- 'Global Pull Secret': how-to/azure/global-pull-secret.md
- 'Managed Azure':
- how-to/azure/create-azure-cluster-with-options.md
- how-to/azure/create-azure-cluster-on-aks.md
- how-to/azure/scheduler.md
- 'Self-managed Azure':
- how-to/azure/self-managed-azure-index.md
- how-to/azure/azure-workload-identity-setup.md
- how-to/azure/create-self-managed-azure-cluster.md
- how-to/azure/create-iam-separately.md
- how-to/azure/create-infra-separately.md
- how-to/azure/deploy-azure-private-clusters.md
- how-to/azure/setup-management-cluster.md
- 'Troubleshooting':
- how-to/azure/troubleshooting/index.md
- how-to/azure/troubleshooting/debug-nodes.md
- 'GCP':
- how-to/gcp/index.md
- how-to/gcp/create-gcp-hosted-cluster.md
- how-to/gcp/create-gcp-iam.md
- how-to/gcp/create-gcp-infra.md
- how-to/gcp/e2e-gke-ci-job.md
- how-to/gcp/setup-management-cluster.md
- 'Kubevirt':
- how-to/kubevirt/configuring-network.md
- how-to/kubevirt/create-kubevirt-cluster.md
- how-to/kubevirt/external-infrastructure.md
- 'Global Pull Secret': how-to/kubevirt/global-pull-secret.md
- how-to/kubevirt/gpu-devices.md
- how-to/kubevirt/ingress-and-dns.md
- how-to/kubevirt/performance-tuning.md
- how-to/kubevirt/configuring-storage.md
- how-to/kubevirt/troubleshooting-kubevirt-cluster.md
- 'None':
- how-to/none/create-none-cluster.md
- 'Exposing HCP Services': how-to/none/exposing-services-from-hcp.md
- 'Global Pull Secret': how-to/none/global-pull-secret.md
Comment thread
coderabbitai[bot] marked this conversation as resolved.
- 'OpenStack':
- how-to/openstack/index.md
- how-to/openstack/additional-ports.md
- how-to/openstack/az.md
- how-to/openstack/hostedcluster.md
- how-to/openstack/destroy.md
- 'Global Pull Secret': how-to/openstack/global-pull-secret.md
- how-to/openstack/performance-tuning.md
- how-to/openstack/prerequisites.md
- 'PowerVS':
- how-to/powervs/create-cluster-powervs.md
- how-to/powervs/create-infra-separately.md
- 'Global Pull Secret': how-to/powervs/global-pull-secret.md
- how-to/powervs/prerequisites-and-env-guide.md
- how-to/resource-based-control-plane-autoscaling.md
- how-to/restart-control-plane-components.md
- how-to/troubleshooting-general.md
- how-to/upgrades.md
- 'Self-Managed Laboratories':
- 'MultiCluster Engine and Agent provider':
- labs/index.md
Expand Down
Loading
Loading