-
Notifications
You must be signed in to change notification settings - Fork 15k
Closed
Labels
kind/cleanupCategorizes issue or PR as related to cleaning up code, process, or technical debt.Categorizes issue or PR as related to cleaning up code, process, or technical debt.lifecycle/staleDenotes an issue or PR has remained open with no activity and has become stale.Denotes an issue or PR has remained open with no activity and has become stale.priority/important-longtermImportant over the long term, but may not be staffed and/or may need multiple releases to complete.Important over the long term, but may not be staffed and/or may need multiple releases to complete.
Description
Problem:
The existing content is not completely compatible with the 0.6x.x releases of Hugo. Hugo 0.60.0 became compatible with CommonMark. Some existing content doesn't render the same way with Hugo < 0.60.0 as it does with Hugo ≥ 0.60.0
- Some localizations have
user-guide-migration-notice.md
files that don't render correctly. config.toml
has configuration that is specific to the BlackFriday renderer for Markdown.- The code highlighting setup is different
- Pages, including generated documentation, display differently because of changed interpretation of whitespace at the start of lines (indentation)
Specifically:- https://github.com/kubernetes/website/edit/master/content/en/docs/reference/kubectl/kubectl.md
- https://github.com/kubernetes/website/edit/master/content/en/docs/reference/kubectl/overview.md - The feature state shortcode does not render as expected with Hugo 0.6x.x
This is a tracking issue and will track at least the top 100 most commonly visited pages on this site.
Top 100 pages to check:
Legend
Checked items have been reviewed
- /
- /docs/reference/kubectl/cheatsheet/
-
⚠️ /docs/tasks/tools/install-kubectl/ - /docs/home/
-
⚠️ /docs/concepts/services-networking/service/ -
⚠️ /docs/concepts/workloads/controllers/deployment/ -
⚠️ /docs/concepts/services-networking/ingress/ -
⚠️ /docs/concepts/storage/persistent-volumes/ (feature state only) -
⚠️ /docs/tasks/tools/install-minikube/ (content in tabs) -
⚠️ /docs/setup/learning-environment/minikube/ - /docs/tutorials/kubernetes-basics/
- /docs/setup
-
⚠️ /docs/concepts/configuration/secret/ (feature state only) -
⚠️ /docs/concepts/storage/volumes/ (feature state only) - /docs/concepts/
- /docs/setup/production-environment/tools/kubeadm/install-kubeadm/
- /docs/concepts/overview/what-is-kubernetes/
- /docs/tasks/configure-pod-container/configure-pod-configmap/
- /docs/setup/production-environment/tools/kubeadm/create-cluster-kubeadm/
- /docs/reference/access-authn-authz/rbac/
- /docs/tasks/access-application-cluster/web-ui-dashboard/
- /docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/
- /docs/tutorials/
- /docs/concepts/configuration/assign-pod-node/
- /docs/tasks/access-application-cluster/configure-access-multiple-clusters/
- /docs/concepts/overview/components/
- /docs/tutorials/kubernetes-basics/create-cluster/cluster-intro/
- /docs/concepts/services-networking/connect-applications-service/
- /docs/concepts/workloads/pods/pod/
- /docs/concepts/configuration/manage-compute-resources-container/
- /docs/concepts/workloads/controllers/jobs-run-to-completion/
- /docs/concepts/overview/working-with-objects/namespaces/
- /docs/tasks/debug-application-cluster/get-shell-running-container/
- /docs/concepts/containers/images/
- /docs/concepts/workloads/pods/pod-overview/
- /docs/tutorials/hello-minikube/
- /docs/reference/access-authn-authz/authentication/
- /docs/tutorials/kubernetes-basics/deploy-app/deploy-intro/
- /docs/reference/kubectl/overview/
- /docs/concepts/overview/working-with-objects/labels/
- /docs/concepts/workloads/pods/pod-lifecycle/
- /docs/concepts/architecture/nodes/
- /docs/concepts/services-networking/dns-pod-service/
- /docs/reference/
- /docs/tasks/configure-pod-container/pull-image-private-registry/
- /docs/tutorials/kubernetes-basics/create-cluster/cluster-interactive/
- /docs/tasks/configure-pod-container/configure-persistent-volume-storage/
- /docs/tasks/inject-data-application/define-environment-variable-container/
- /docs/tutorials/stateless-application/expose-external-ip-address/
- /docs/setup/production-environment/container-runtimes/
- /docs/tutorials/kubernetes-basics/explore/explore-intro/
- /docs/concepts/workloads/controllers/statefulset/
- /docs/tasks/
- /docs/tasks/run-application/horizontal-pod-autoscale/
- /docs/concepts/storage/storage-classes/
- /docs/tasks/configure-pod-container/configure-service-account/
- /docs/concepts/configuration/taint-and-toleration/
- /docs/concepts/services-networking/network-policies/
- /docs/tasks/configure-pod-container/security-context/
- /docs/concepts/workloads/controllers/replicaset/
- /docs/setup/release/notes/
- /docs/tasks/inject-data-application/define-command-argument-container/
- /docs/concepts/overview/kubernetes-api/
- /docs/concepts/overview/working-with-objects/kubernetes-objects/
- /docs/tasks/access-application-cluster/port-forward-access-application-cluster/
- /docs/tutorials/kubernetes-basics/expose/expose-intro/
- /docs/concepts/services-networking/ingress-controllers/
- /docs/concepts/workloads/pods/init-containers/
- /docs/tutorials/kubernetes-basics/deploy-app/deploy-interactive/
- /docs/concepts/cluster-administration/networking/
- /docs/tasks/job/automated-tasks-with-cron-jobs/
- /case-studies/
- /docs/concepts/workloads/controllers/daemonset/
- /docs/tasks/access-application-cluster/access-cluster/
- /training/
- /docs/concepts/policy/pod-security-policy/
- /docs/concepts/cluster-administration/logging/
- /docs/tasks/run-application/run-stateless-application-deployment/
- /docs/concepts/configuration/organize-cluster-access-kubeconfig/
- /docs/concepts/configuration/overview/
- /docs/concepts/workloads/controllers/cron-jobs/
- /docs/tasks/access-application-cluster/create-external-load-balancer/
- /docs/tasks/administer-cluster/dns-debugging-resolution/
- /docs/tasks/tls/managing-tls-in-a-cluster/
- /docs/setup/production-environment/tools/kubeadm/high-availability/
- /docs/tasks/run-application/horizontal-pod-autoscale-walkthrough/
- /docs/tasks/access-application-cluster/list-all-running-container-images/
- /docs/tutorials/kubernetes-basics/update/update-intro/
- /docs/concepts/extend-kubernetes/api-extension/custom-resources/
- /docs/reference/command-line-tools-reference/kube-apiserver/
- /case-studies/chinaunicom/
- /docs/concepts/cluster-administration/manage-deployment/
- /docs/reference/command-line-tools-reference/kubelet/
- /docs/tasks/administer-cluster/access-cluster-api/
- /docs/tasks/inject-data-application/distribute-credentials-secure/
- /zh/docs/home/
- /zh/
- /docs/tasks/administer-cluster/kubeadm/kubeadm-upgrade/
- /docs/tasks/debug-application-cluster/
- /docs/tutorials/stateful-application/basic-stateful-set/
Additional Information:
This issue heavily draws on work started in PR #19907 (thanks @jimangel!)
#19028 (comment) captures more detail
/kind cleanup
/priority important-longterm
zacharysarah and jimangelzacharysarah
Metadata
Metadata
Assignees
Labels
kind/cleanupCategorizes issue or PR as related to cleaning up code, process, or technical debt.Categorizes issue or PR as related to cleaning up code, process, or technical debt.lifecycle/staleDenotes an issue or PR has remained open with no activity and has become stale.Denotes an issue or PR has remained open with no activity and has become stale.priority/important-longtermImportant over the long term, but may not be staffed and/or may need multiple releases to complete.Important over the long term, but may not be staffed and/or may need multiple releases to complete.