Change:
Instead, have a presubmit test that verifies that the docs can be generated. This will reduce the number of conflicts & rebases, therefore increase speed through the queue. Confirmed with that nothing depends on these docs at the moment. fyi, some manual process might have to change once this is in.
Yes, we want to generate the docs into , anyway. cc
Excellent. One closer step to YAML generation, I hope. :)
was interested in working on this.
Want to get started on this?
is this still a goal of ours?
I've seen a thread this week-end about that. I think docs have moved but we still need to generate them there.
can this issue be closed then?
related to ?
Issues go stale after 90d of inactivity. Mark the issue as fresh with . Stale issues rot after an additional 30d of inactivity and eventually close. Prevent issues from auto-closing with an comment. If this issue is safe to close now please do so with . Send feedback to sig-testing, kubernetes/test-infra and/or . /lifecycle stale
/remove-lifecycle stale /lifecycle frozen There's still cruft in the docs directory.
/remove-help I don't think this meets . Please add back via if I'm incorrect
/sig docs /sig release /remove-area test-infra /area build-release /area kubeadm /area kubectl All of the following dirs/files have the following content. Do we need them? This file is autogenerated, but we've stopped checking such files into the repository to reduce the need for rebases. Please run hack/generate- to populate this file. docs/admin: .md files for kube components and kubeadm commands man/man1: .1 files for same user-guide/kubectl: .md files for kubectl commands yaml/kubectl: .yaml files for kubectl commands
/help Now that we have /good-first-issue, I think this does meet the criteria for help wanted. Probably need to talk to someone from sig-docs and figure out if/how these are used.
This request has been marked as needing help from a contributor. Please ensure the request meets the requirements listed . If this request no longer meets these requirements, the label can be removed by commenting with the command. <detailsIn response to : /help Now that we have /good-first-issue, I think this does meet the criteria for help wanted. Probably need to talk to someone from sig-docs and figure out if/how these are used. Instructions for interacting with me using PR comments are available . If you have questions or suggestions related to my behavior, please file an issue against the repository. </details
/remove-priority important-soon /priority important-longterm This hasn't been committed to for any release cycle in a while. I hope someone does commit to it, but I personally cannot, so I'm bumping down to the "hopefully next time" priority. /kind cleanup in addition to docs This impacts merge velocity of any kubectl/kubeadm changes because the docs/OWNERS file is small. We're going to work around by adding OWNERS files for the relevant sigs to the relevant dirs. But if these files don't have to exist in the first place, that'd be even better.
as discovered today this would not work as OWNERS in sub-folders do not solve the problem with the /docs/.generated_docs file which is in the parent folder. i've been looking into a solution to remove the placeholders completely and make verify-docs only consist of kube::util::gen-docs. this will: ensure that godoc errors and such still block presubmits the contributors are not blocked having to commit placeholder files
/lifecycle active
Issues go stale after 90d of inactivity. Mark the issue as fresh with . Stale issues rot after an additional 30d of inactivity and eventually close. If this issue is safe to close now please do so with . Send feedback to sig-testing, kubernetes/test-infra and/or . /lifecycle stale
/remove-lifecycle stale /lifecycle active as PR is still in flight.

Discussion:
<del> docs/.generated_docs docs/admin/cloud-controller-manager.md docs/admin/kube-apiserver.md docs/admin/kube-controller-manager.md docs/admin/kube-proxy.md docs/admin/kube-scheduler.md docs/admin/kubeadm.md docs/admin/kubeadm_alpha.md docs/admin/kubeadm_alpha_certs.md docs/admin/kubeadm_alpha_certs_renew.md docs/admin/kubeadm_alpha_certs_renew_all.md docs/admin/kubeadm_alpha_certs_renew_apiserver-etcd-client.md docs/admin/kubeadm_alpha_certs_renew_apiserver-kubelet-client.md docs/admin/kubeadm_alpha_certs_renew_apiserver.md docs/admin/kubeadm_alpha_certs_renew_etcd-healthcheck-client.md docs/admin/kubeadm_alpha_certs_renew_etcd-peer.md docs/admin/kubeadm_alpha_certs_renew_etcd-server.md docs/admin/kubeadm_alpha_certs_renew_front-proxy-client.md docs/admin/kubeadm_alpha_kubeconfig.md docs/admin/kubeadm_alpha_kubeconfig_user.md docs/admin/kubeadm_alpha_kubelet.md docs/admin/kubeadm_alpha_kubelet_config.md docs/admin/kubeadm_alpha_kubelet_config_download.md docs/admin/kubeadm_alpha_kubelet_config_enable-dynamic.md docs/admin/kubeadm_alpha_preflight.md docs/admin/kubeadm_alpha_preflight_node.md docs/admin/kubeadm_alpha_selfhosting.md docs/admin/kubeadm_alpha_selfhosting_pivot.md docs/admin/kubeadm_completion.md docs/admin/kubeadm_config.md docs/admin/kubeadm_config_images.md docs/admin/kubeadm_config_images_list.md docs/admin/kubeadm_config_images_pull.md docs/admin/kubeadm_config_migrate.md docs/admin/kubeadm_config_print.md docs/admin/kubeadm_config_print_init-defaults.md docs/admin/kubeadm_config_print_join-defaults.md docs/admin/kubeadm_config_upload.md docs/admin/kubeadm_config_upload_from-file.md docs/admin/kubeadm_config_upload_from-flags.md docs/admin/kubeadm_config_view.md docs/admin/kubeadm_init.md docs/admin/kubeadm_init_phase.md docs/admin/kubeadm_init_phase_addon.md docs/admin/kubeadm_init_phase_addon_all.md docs/admin/kubeadm_init_phase_addon_coredns.md docs/admin/kubeadm_init_phase_addon_kube-proxy.md docs/admin/kubeadm_init_phase_bootstrap-token.md docs/admin/kubeadm_init_phase_certs.md docs/admin/kubeadm_init_phase_certs_all.md docs/admin/kubeadm_init_phase_certs_apiserver-etcd-client.md docs/admin/kubeadm_init_phase_certs_apiserver-kubelet-client.md docs/admin/kubeadm_init_phase_certs_apiserver.md docs/admin/kubeadm_init_phase_certs_ca.md docs/admin/kubeadm_init_phase_certs_etcd-ca.md docs/admin/kubeadm_init_phase_certs_etcd-healthcheck-client.md docs/admin/kubeadm_init_phase_certs_etcd-peer.md docs/admin/kubeadm_init_phase_certs_etcd-server.md docs/admin/kubeadm_init_phase_certs_front-proxy-ca.md docs/admin/kubeadm_init_phase_certs_front-proxy-client.md docs/admin/kubeadm_init_phase_certs_sa.md docs/admin/kubeadm_init_phase_control-plane.md docs/admin/kubeadm_init_phase_control-plane_all.md docs/admin/kubeadm_init_phase_control-plane_apiserver.md docs/admin/kubeadm_init_phase_control-plane_controller-manager.md docs/admin/kubeadm_init_phase_control-plane_scheduler.md docs/admin/kubeadm_init_phase_etcd.md docs/admin/kubeadm_init_phase_etcd_local.md docs/admin/kubeadm_init_phase_kubeconfig.md docs/admin/kubeadm_init_phase_kubeconfig_admin.md docs/admin/kubeadm_init_phase_kubeconfig_all.md docs/admin/kubeadm_init_phase_kubeconfig_controller-manager.md docs/admin/kubeadm_init_phase_kubeconfig_kubelet.md docs/admin/kubeadm_init_phase_kubeconfig_scheduler.md docs/admin/kubeadm_init_phase_kubelet-start.md docs/admin/kubeadm_init_phase_mark-control-plane.md docs/admin/kubeadm_init_phase_preflight.md docs/admin/kubeadm_init_phase_upload-config.md docs/admin/kubeadm_init_phase_upload-config_all.md docs/admin/kubeadm_init_phase_upload-config_kubeadm.md docs/admin/kubeadm_init_phase_upload-config_kubelet.md docs/admin/kubeadm_join.md docs/admin/kubeadm_reset.md docs/admin/kubeadm_token.md docs/admin/kubeadm_token_create.md docs/admin/kubeadm_token_delete.md docs/admin/kubeadm_token_generate.md docs/admin/kubeadm_token_list.md docs/admin/kubeadm_upgrade.md docs/admin/kubeadm_upgrade_apply.md docs/admin/kubeadm_upgrade_diff.md docs/admin/kubeadm_upgrade_node.md docs/admin/kubeadm_upgrade_node_config.md docs/admin/kubeadm_upgrade_node_experimental-control-plane.md docs/admin/kubeadm_upgrade_plan.md docs/admin/kubeadm_version.md docs/admin/kubelet.md docs/man/man1/cloud-controller-manager.1 docs/man/man1/kube-apiserver.1 docs/man/man1/kube-controller-manager.1 docs/man/man1/kube-proxy.1 docs/man/man1/kube-scheduler.1 docs/man/man1/kubeadm-alpha-certs-renew-all.1 docs/man/man1/kubeadm-alpha-certs-renew-apiserver-etcd-client.1 docs/man/man1/kubeadm-alpha-certs-renew-apiserver-kubelet-client.1 docs/man/man1/kubeadm-alpha-certs-renew-apiserver.1 docs/man/man1/kubeadm-alpha-certs-renew-etcd-healthcheck-client.1 docs/man/man1/kubeadm-alpha-certs-renew-etcd-peer.1 docs/man/man1/kubeadm-alpha-certs-renew-etcd-server.1 docs/man/man1/kubeadm-alpha-certs-renew-front-proxy-client.1 docs/man/man1/kubeadm-alpha-certs-renew.1 docs/man/man1/kubeadm-alpha-certs.1 docs/man/man1/kubeadm-alpha-kubeconfig-user.1 docs/man/man1/kubeadm-alpha-kubeconfig.1 docs/man/man1/kubeadm-alpha-kubelet-config-download.1 docs/man/man1/kubeadm-alpha-kubelet-config-enable-dynamic.1 docs/man/man1/kubeadm-alpha-kubelet-config.1 docs/man/man1/kubeadm-alpha-kubelet.1 docs/man/man1/kubeadm-alpha-phase.1 docs/man/man1/kubeadm-alpha-preflight-node.1 docs/man/man1/kubeadm-alpha-preflight.1 docs/man/man1/kubeadm-alpha-selfhosting-pivot.1 docs/man/man1/kubeadm-alpha-selfhosting.1 docs/man/man1/kubeadm-alpha.1 docs/man/man1/kubeadm-completion.1 docs/man/man1/kubeadm-config-images-list.1 docs/man/man1/kubeadm-config-images-pull.1 docs/man/man1/kubeadm-config-images.1 docs/man/man1/kubeadm-config-migrate.1 docs/man/man1/kubeadm-config-print-init-defaults.1 docs/man/man1/kubeadm-config-print-join-defaults.1 docs/man/man1/kubeadm-config-print.1 docs/man/man1/kubeadm-config-upload-from-file.1 docs/man/man1/kubeadm-config-upload-from-flags.1 docs/man/man1/kubeadm-config-upload.1 docs/man/man1/kubeadm-config-view.1 docs/man/man1/kubeadm-config.1 docs/man/man1/kubeadm-init-phase-addon-all.1 docs/man/man1/kubeadm-init-phase-addon-coredns.1 docs/man/man1/kubeadm-init-phase-addon-kube-proxy.1 docs/man/man1/kubeadm-init-phase-addon.1 docs/man/man1/kubeadm-init-phase-bootstrap-token.1 docs/man/man1/kubeadm-init-phase-certs-all.1 docs/man/man1/kubeadm-init-phase-certs-apiserver-etcd-client.1 docs/man/man1/kubeadm-init-phase-certs-apiserver-kubelet-client.1 docs/man/man1/kubeadm-init-phase-certs-apiserver.1 docs/man/man1/kubeadm-init-phase-certs-ca.1 docs/man/man1/kubeadm-init-phase-certs-etcd-ca.1 docs/man/man1/kubeadm-init-phase-certs-etcd-healthcheck-client.1 docs/man/man1/kubeadm-init-phase-certs-etcd-peer.1 docs/man/man1/kubeadm-init-phase-certs-etcd-server.1 docs/man/man1/kubeadm-init-phase-certs-front-proxy-ca.1 docs/man/man1/kubeadm-init-phase-certs-front-proxy-client.1 docs/man/man1/kubeadm-init-phase-certs-sa.1 docs/man/man1/kubeadm-init-phase-certs.1 docs/man/man1/kubeadm-init-phase-control-plane-all.1 docs/man/man1/kubeadm-init-phase-control-plane-apiserver.1 docs/man/man1/kubeadm-init-phase-control-plane-controller-manager.1 docs/man/man1/kubeadm-init-phase-control-plane-scheduler.1 docs/man/man1/kubeadm-init-phase-control-plane.1 docs/man/man1/kubeadm-init-phase-etcd-local.1 docs/man/man1/kubeadm-init-phase-etcd.1 docs/man/man1/kubeadm-init-phase-kubeconfig-admin.1 docs/man/man1/kubeadm-init-phase-kubeconfig-all.1 docs/man/man1/kubeadm-init-phase-kubeconfig-controller-manager.1 docs/man/man1/kubeadm-init-phase-kubeconfig-kubelet.1 docs/man/man1/kubeadm-init-phase-kubeconfig-scheduler.1 docs/man/man1/kubeadm-init-phase-kubeconfig.1 docs/man/man1/kubeadm-init-phase-kubelet-start.1 docs/man/man1/kubeadm-init-phase-mark-control-plane.1 docs/man/man1/kubeadm-init-phase-preflight.1 docs/man/man1/kubeadm-init-phase-upload-config-all.1 docs/man/man1/kubeadm-init-phase-upload-config-kubeadm.1 docs/man/man1/kubeadm-init-phase-upload-config-kubelet.1 docs/man/man1/kubeadm-init-phase-upload-config.1 docs/man/man1/kubeadm-init-phase.1 docs/man/man1/kubeadm-init.1 docs/man/man1/kubeadm-join.1 docs/man/man1/kubeadm-reset.1 docs/man/man1/kubeadm-token-create.1 docs/man/man1/kubeadm-token-delete.1 docs/man/man1/kubeadm-token-generate.1 docs/man/man1/kubeadm-token-list.1 docs/man/man1/kubeadm-token.1 docs/man/man1/kubeadm-upgrade-apply.1 docs/man/man1/kubeadm-upgrade-diff.1 docs/man/man1/kubeadm-upgrade-node-config.1 docs/man/man1/kubeadm-upgrade-node-experimental-control-plane.1 docs/man/man1/kubeadm-upgrade-node.1 docs/man/man1/kubeadm-upgrade-plan.1 docs/man/man1/kubeadm-upgrade.1 docs/man/man1/kubeadm-version.1 docs/man/man1/kubeadm.1 docs/man/man1/kubectl-alpha.1 docs/man/man1/kubectl-annotate.1 docs/man/man1/kubectl-api-resources.1 docs/man/man1/kubectl-api-versions.1 docs/man/man1/kubectl-apply-edit-last-applied.1 docs/man/man1/kubectl-apply-set-last-applied.1 docs/man/man1/kubectl-apply-view-last-applied.1 docs/man/man1/kubectl-apply.1 docs/man/man1/kubectl-attach.1 docs/man/man1/kubectl-auth-can-i.1 docs/man/man1/kubectl-auth-reconcile.1 docs/man/man1/kubectl-auth.1 docs/man/man1/kubectl-autoscale.1 docs/man/man1/kubectl-certificate-approve.1 docs/man/man1/kubectl-certificate-deny.1 docs/man/man1/kubectl-certificate.1 docs/man/man1/kubectl-cluster-info-dump.1 docs/man/man1/kubectl-cluster-info.1 docs/man/man1/kubectl-completion.1 docs/man/man1/kubectl-config-current-context.1 docs/man/man1/kubectl-config-delete-cluster.1 docs/man/man1/kubectl-config-delete-context.1 docs/man/man1/kubectl-config-get-clusters.1 docs/man/man1/kubectl-config-get-contexts.1 docs/man/man1/kubectl-config-rename-context.1 docs/man/man1/kubectl-config-set-cluster.1 docs/man/man1/kubectl-config-set-context.1 docs/man/man1/kubectl-config-set-credentials.1 docs/man/man1/kubectl-config-set.1 docs/man/man1/kubectl-config-unset.1 docs/man/man1/kubectl-config-use-context.1 docs/man/man1/kubectl-config-view.1 docs/man/man1/kubectl-config.1 docs/man/man1/kubectl-convert.1 docs/man/man1/kubectl-cordon.1 docs/man/man1/kubectl-cp.1 docs/man/man1/kubectl-create-clusterrole.1 docs/man/man1/kubectl-create-clusterrolebinding.1 docs/man/man1/kubectl-create-configmap.1 docs/man/man1/kubectl-create-deployment.1 docs/man/man1/kubectl-create-job.1 docs/man/man1/kubectl-create-namespace.1 docs/man/man1/kubectl-create-poddisruptionbudget.1 docs/man/man1/kubectl-create-priorityclass.1 docs/man/man1/kubectl-create-quota.1 docs/man/man1/kubectl-create-role.1 docs/man/man1/kubectl-create-rolebinding.1 docs/man/man1/kubectl-create-secret-docker-registry.1 docs/man/man1/kubectl-create-secret-generic.1 docs/man/man1/kubectl-create-secret-tls.1 docs/man/man1/kubectl-create-secret.1 docs/man/man1/kubectl-create-service-clusterip.1 docs/man/man1/kubectl-create-service-externalname.1 docs/man/man1/kubectl-create-service-loadbalancer.1 docs/man/man1/kubectl-create-service-nodeport.1 docs/man/man1/kubectl-create-service.1 docs/man/man1/kubectl-create-serviceaccount.1 docs/man/man1/kubectl-create.1 docs/man/man1/kubectl-delete.1 docs/man/man1/kubectl-describe.1 docs/man/man1/kubectl-diff.1 docs/man/man1/kubectl-drain.1 docs/man/man1/kubectl-edit.1 docs/man/man1/kubectl-exec.1 docs/man/man1/kubectl-explain.1 docs/man/man1/kubectl-expose.1 docs/man/man1/kubectl-get.1 docs/man/man1/kubectl-label.1 docs/man/man1/kubectl-logs.1 docs/man/man1/kubectl-options.1 docs/man/man1/kubectl-patch.1 docs/man/man1/kubectl-plugin-list.1 docs/man/man1/kubectl-plugin.1 docs/man/man1/kubectl-port-forward.1 docs/man/man1/kubectl-proxy.1 docs/man/man1/kubectl-replace.1 docs/man/man1/kubectl-rolling-update.1 docs/man/man1/kubectl-rollout-history.1 docs/man/man1/kubectl-rollout-pause.1 docs/man/man1/kubectl-rollout-resume.1 docs/man/man1/kubectl-rollout-status.1 docs/man/man1/kubectl-rollout-undo.1 docs/man/man1/kubectl-rollout.1 docs/man/man1/kubectl-run.1 docs/man/man1/kubectl-scale.1 docs/man/man1/kubectl-set-env.1 docs/man/man1/kubectl-set-image.1 docs/man/man1/kubectl-set-resources.1 docs/man/man1/kubectl-set-selector.1 docs/man/man1/kubectl-set-serviceaccount.1 docs/man/man1/kubectl-set-subject.1 docs/man/man1/kubectl-set.1 docs/man/man1/kubectl-taint.1 docs/man/man1/kubectl-top-node.1 docs/man/man1/kubectl-top-pod.1 docs/man/man1/kubectl-top.1 docs/man/man1/kubectl-uncordon.1 docs/man/man1/kubectl-version.1 docs/man/man1/kubectl-wait.1 docs/man/man1/kubectl.1 docs/man/man1/kubelet.1 docs/user-guide/kubectl/kubectl.md docs/user-guide/kubectl/kubectl_annotate.md docs/user-guide/kubectl/kubectl_api-resources.md docs/user-guide/kubectl/kubectl_api-versions.md docs/user-guide/kubectl/kubectl_apply.md docs/user-guide/kubectl/kubectl_apply_edit-last-applied.md docs/user-guide/kubectl/kubectl_apply_set-last-applied.md docs/user-guide/kubectl/kubectl_apply_view-last-applied.md docs/user-guide/kubectl/kubectl_attach.md docs/user-guide/kubectl/kubectl_auth.md docs/user-guide/kubectl/kubectl_auth_can-i.md docs/user-guide/kubectl/kubectl_auth_reconcile.md docs/user-guide/kubectl/kubectl_autoscale.md docs/user-guide/kubectl/kubectl_certificate.md docs/user-guide/kubectl/kubectl_certificate_approve.md docs/user-guide/kubectl/kubectl_certificate_deny.md docs/user-guide/kubectl/kubectl_cluster-info.md docs/user-guide/kubectl/kubectl_cluster-info_dump.md docs/user-guide/kubectl/kubectl_completion.md docs/user-guide/kubectl/kubectl_config.md docs/user-guide/kubectl/kubectl_config_current-context.md docs/user-guide/kubectl/kubectl_config_delete-cluster.md docs/user-guide/kubectl/kubectl_config_delete-context.md docs/user-guide/kubectl/kubectl_config_get-clusters.md docs/user-guide/kubectl/kubectl_config_get-contexts.md docs/user-guide/kubectl/kubectl_config_rename-context.md docs/user-guide/kubectl/kubectl_config_set-cluster.md docs/user-guide/kubectl/kubectl_config_set-context.md docs/user-guide/kubectl/kubectl_config_set-credentials.md docs/user-guide/kubectl/kubectl_config_set.md docs/user-guide/kubectl/kubectl_config_unset.md docs/user-guide/kubectl/kubectl_config_use-context.md docs/user-guide/kubectl/kubectl_config_view.md docs/user-guide/kubectl/kubectl_convert.md docs/user-guide/kubectl/kubectl_cordon.md docs/user-guide/kubectl/kubectl_cp.md docs/user-guide/kubectl/kubectl_create.md docs/user-guide/kubectl/kubectl_create_clusterrole.md docs/user-guide/kubectl/kubectl_create_clusterrolebinding.md docs/user-guide/kubectl/kubectl_create_configmap.md docs/user-guide/kubectl/kubectl_create_deployment.md docs/user-guide/kubectl/kubectl_create_job.md docs/user-guide/kubectl/kubectl_create_namespace.md docs/user-guide/kubectl/kubectl_create_poddisruptionbudget.md docs/user-guide/kubectl/kubectl_create_priorityclass.md docs/user-guide/kubectl/kubectl_create_quota.md docs/user-guide/kubectl/kubectl_create_role.md docs/user-guide/kubectl/kubectl_create_rolebinding.md docs/user-guide/kubectl/kubectl_create_secret.md docs/user-guide/kubectl/kubectl_create_secret_docker-registry.md docs/user-guide/kubectl/kubectl_create_secret_generic.md docs/user-guide/kubectl/kubectl_create_secret_tls.md docs/user-guide/kubectl/kubectl_create_service.md docs/user-guide/kubectl/kubectl_create_service_clusterip.md docs/user-guide/kubectl/kubectl_create_service_externalname.md docs/user-guide/kubectl/kubectl_create_service_loadbalancer.md docs/user-guide/kubectl/kubectl_create_service_nodeport.md docs/user-guide/kubectl/kubectl_create_serviceaccount.md docs/user-guide/kubectl/kubectl_delete.md docs/user-guide/kubectl/kubectl_describe.md docs/user-guide/kubectl/kubectl_diff.md docs/user-guide/kubectl/kubectl_drain.md docs/user-guide/kubectl/kubectl_edit.md docs/user-guide/kubectl/kubectl_exec.md docs/user-guide/kubectl/kubectl_explain.md docs/user-guide/kubectl/kubectl_expose.md docs/user-guide/kubectl/kubectl_get.md docs/user-guide/kubectl/kubectl_label.md docs/user-guide/kubectl/kubectl_logs.md docs/user-guide/kubectl/kubectl_options.md docs/user-guide/kubectl/kubectl_patch.md docs/user-guide/kubectl/kubectl_plugin.md docs/user-guide/kubectl/kubectl_plugin_list.md docs/user-guide/kubectl/kubectl_port-forward.md docs/user-guide/kubectl/kubectl_proxy.md docs/user-guide/kubectl/kubectl_replace.md docs/user-guide/kubectl/kubectl_rollout.md docs/user-guide/kubectl/kubectl_rollout_history.md docs/user-guide/kubectl/kubectl_rollout_pause.md docs/user-guide/kubectl/kubectl_rollout_resume.md docs/user-guide/kubectl/kubectl_rollout_status.md docs/user-guide/kubectl/kubectl_rollout_undo.md docs/user-guide/kubectl/kubectl_run.md docs/user-guide/kubectl/kubectl_scale.md docs/user-guide/kubectl/kubectl_set.md docs/user-guide/kubectl/kubectl_set_env.md docs/user-guide/kubectl/kubectl_set_image.md docs/user-guide/kubectl/kubectl_set_resources.md docs/user-guide/kubectl/kubectl_set_selector.md docs/user-guide/kubectl/kubectl_set_serviceaccount.md docs/user-guide/kubectl/kubectl_set_subject.md docs/user-guide/kubectl/kubectl_taint.md docs/user-guide/kubectl/kubectl_top.md docs/user-guide/kubectl/kubectl_top_node.md docs/user-guide/kubectl/kubectl_top_pod.md docs/user-guide/kubectl/kubectl_uncordon.md docs/user-guide/kubectl/kubectl_version.md docs/user-guide/kubectl/kubectl_wait.md docs/yaml/kubectl/kubectl.yaml docs/yaml/kubectl/kubectl_alpha.yaml docs/yaml/kubectl/kubectl_annotate.yaml docs/yaml/kubectl/kubectl_api-resources.yaml docs/yaml/kubectl/kubectl_api-versions.yaml docs/yaml/kubectl/kubectl_apply.yaml docs/yaml/kubectl/kubectl_attach.yaml docs/yaml/kubectl/kubectl_auth.yaml docs/yaml/kubectl/kubectl_autoscale.yaml docs/yaml/kubectl/kubectl_certificate.yaml docs/yaml/kubectl/kubectl_cluster-info.yaml docs/yaml/kubectl/kubectl_completion.yaml docs/yaml/kubectl/kubectl_config.yaml docs/yaml/kubectl/kubectl_convert.yaml docs/yaml/kubectl/kubectl_cordon.yaml docs/yaml/kubectl/kubectl_cp.yaml docs/yaml/kubectl/kubectl_create.yaml docs/yaml/kubectl/kubectl_delete.yaml docs/yaml/kubectl/kubectl_describe.yaml docs/yaml/kubectl/kubectl_diff.yaml docs/yaml/kubectl/kubectl_drain.yaml docs/yaml/kubectl/kubectl_edit.yaml docs/yaml/kubectl/kubectl_exec.yaml docs/yaml/kubectl/kubectl_explain.yaml docs/yaml/kubectl/kubectl_expose.yaml docs/yaml/kubectl/kubectl_get.yaml docs/yaml/kubectl/kubectl_label.yaml docs/yaml/kubectl/kubectl_logs.yaml docs/yaml/kubectl/kubectl_options.yaml docs/yaml/kubectl/kubectl_patch.yaml docs/yaml/kubectl/kubectl_plugin.yaml docs/yaml/kubectl/kubectl_port-forward.yaml docs/yaml/kubectl/kubectl_proxy.yaml docs/yaml/kubectl/kubectl_replace.yaml docs/yaml/kubectl/kubectl_rolling-update.yaml docs/yaml/kubectl/kubectl_rollout.yaml docs/yaml/kubectl/kubectl_run.yaml docs/yaml/kubectl/kubectl_scale.yaml docs/yaml/kubectl/kubectl_set.yaml docs/yaml/kubectl/kubectl_taint.yaml docs/yaml/kubectl/kubectl_top.yaml docs/yaml/kubectl/kubectl_uncordon.yaml docs/yaml/kubectl/kubectl_version.yaml docs/yaml/kubectl/kubectl_wait.yaml </del>

<ins> .generated_docs admin/ man/ user-guide/ yaml/ </ins>

<del> approvers: - luxas - timothysc - fabriziopandini reviewers: - luxas - timothysc - fabriziopandini labels: - kind/documentation </del>

<del> This file is autogenerated, but we've stopped checking such files into the repository to reduce the need for rebases. Please run hack/generate-docs.sh to populate this file. </del>

set -o nounset set -o pipefail <del> KUBE_ROOT=$(dirname "${BASH_SOURCE}")/.. source "${KUBE_ROOT}/hack/lib/init.sh" </del> <ins> KUBE_HACK_ROOT=$(dirname "${BASH_SOURCE}") </ins> <del> kube::golang::setup_env </del> <ins> echo "WARNING: hack/generate-docs.sh is an alias for hack/update-generated-docs.sh" echo "and will be removed in a future version." </ins> <del> BINS=( cmd/gendocs cmd/genkubedocs cmd/genman cmd/genyaml ) make -C "${KUBE_ROOT}" WHAT="${BINS[*]}" kube::util::ensure-temp-dir kube::util::gen-docs "${KUBE_TEMP}" # remove all of the old docs kube::util::remove-gen-docs # copy fresh docs into the repo. # the shopt is so that we get docs/.generated_docs from the glob. shopt -s dotglob cp -af "${KUBE_TEMP}"/* "${KUBE_ROOT}" shopt -u dotglob </del> <ins> "${KUBE_HACK_ROOT}"/update-generated-docs.sh </ins>

popd > /dev/null } <del> # Puts a placeholder for every generated doc. This makes the link checker work. kube::util::set-placeholder-gen-docs() { local list_file="${KUBE_ROOT}/docs/.generated_docs" if [[ -e "${list_file}" ]]; then # remove all of the old docs; we don't want to check them in. while read file; do if [[ "${list_file}" != "${KUBE_ROOT}/${file}" ]]; then cp "${KUBE_ROOT}/hack/autogenerated_placeholder.txt" "${KUBE_ROOT}/${file}" fi done <"${list_file}" # The docs/.generated_docs file lists itself, so we don't need to explicitly # delete it. fi } </del> # Removes previously generated docs-- we don't want to check them in. $KUBE_ROOT # must be set. kube::util::remove-gen-docs() {

shopt -s dotglob cp -af "${KUBE_TEMP}"/* "${KUBE_ROOT}" shopt -u dotglob <del> # Replace with placeholder docs kube::util::set-placeholder-gen-docs </del>

kube::util::ensure-temp-dir <ins> # just verify the generation process </ins> kube::util::gen-docs "${KUBE_TEMP}" <del> # Verify the list matches the expected list (diff should be empty) if ! diff "${KUBE_ROOT}/docs/.generated_docs" "${KUBE_TEMP}/docs/.generated_docs"; then echo "List of generated docs doesn't match a freshly built list. Please run hack/update-generated-docs.sh" exit 1 fi # Verify the files in the repo all contain the boilerplate instead of the actual # content. while read file; do # Ignore docs/.generated_docs-- it should not have the boilerplate! [[ "${file}" == "docs/.generated_docs" ]] && continue # Search for "hack/generate-docs.sh" as a proxy for the boilerplate content, # since the munger adds a bunch of other stuff. if [[ "$(grep "hack/generate-docs.sh" "${KUBE_ROOT}/${file}")" == "" ]]; then echo "${file} doesn't seem to have the correct boilerplate content for an autogenerated file." echo "Please run hack/update-generated-docs.sh" exit 1 fi done <"${KUBE_ROOT}/docs/.generated_docs" </del>