docs: stop tracking placeholder documentation

The placeholder documentation introduces a couple of problems: - it complicates the contributor-experience (forces the CI to run N times before the contributor finds out that they need to call an .sh script and include certain files from docs/) - it forces CLI related pull requests for tools like kubeadm and kubectl to require top level approval from docs/OWNERS as such PRs still need to touch the .generated_docs file Stop tracking the placeholder documentation by applying the following actions: - remove the utility set-placeholder-gen-docs() - make verify-generated-docs.sh only generate in a temporary folder and not match .generated_docs - mark generate-docs.sh as an alias for update-generated-docs.sh - remove all current placeholder files in docs folders admin, man, user-guide, yaml - ignore the above folders and .generated_docs in a .gitignore file
NJU-JYH · Jan 25, 2019 · 54e8d73 · 54e8d73
1 parent 697c231
commit 54e8d73
Show file tree

Hide file tree

Showing 444 changed files with 10 additions and 1,819 deletions.
diff --git a/docs/.generated_docs b/docs/.generated_docs
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1,5 @@
+.generated_docs
+admin/
+man/
+user-guide/
+yaml/
diff --git a/docs/admin/OWNERS b/docs/admin/OWNERS
diff --git a/docs/admin/cloud-controller-manager.md b/docs/admin/cloud-controller-manager.md
diff --git a/docs/admin/kube-apiserver.md b/docs/admin/kube-apiserver.md
diff --git a/docs/admin/kube-controller-manager.md b/docs/admin/kube-controller-manager.md
diff --git a/docs/admin/kube-proxy.md b/docs/admin/kube-proxy.md
diff --git a/docs/admin/kube-scheduler.md b/docs/admin/kube-scheduler.md
diff --git a/docs/admin/kubeadm.md b/docs/admin/kubeadm.md
diff --git a/docs/admin/kubeadm_alpha.md b/docs/admin/kubeadm_alpha.md
diff --git a/docs/admin/kubeadm_alpha_certs.md b/docs/admin/kubeadm_alpha_certs.md
diff --git a/docs/admin/kubeadm_alpha_certs_renew.md b/docs/admin/kubeadm_alpha_certs_renew.md
diff --git a/docs/admin/kubeadm_alpha_certs_renew_all.md b/docs/admin/kubeadm_alpha_certs_renew_all.md
diff --git a/docs/admin/kubeadm_alpha_certs_renew_apiserver-etcd-client.md b/docs/admin/kubeadm_alpha_certs_renew_apiserver-etcd-client.md
diff --git a/docs/admin/kubeadm_alpha_certs_renew_apiserver-kubelet-client.md b/docs/admin/kubeadm_alpha_certs_renew_apiserver-kubelet-client.md
diff --git a/docs/admin/kubeadm_alpha_certs_renew_apiserver.md b/docs/admin/kubeadm_alpha_certs_renew_apiserver.md
diff --git a/docs/admin/kubeadm_alpha_certs_renew_etcd-healthcheck-client.md b/docs/admin/kubeadm_alpha_certs_renew_etcd-healthcheck-client.md
diff --git a/docs/admin/kubeadm_alpha_certs_renew_etcd-peer.md b/docs/admin/kubeadm_alpha_certs_renew_etcd-peer.md
diff --git a/docs/admin/kubeadm_alpha_certs_renew_etcd-server.md b/docs/admin/kubeadm_alpha_certs_renew_etcd-server.md
diff --git a/docs/admin/kubeadm_alpha_certs_renew_front-proxy-client.md b/docs/admin/kubeadm_alpha_certs_renew_front-proxy-client.md
diff --git a/docs/admin/kubeadm_alpha_kubeconfig.md b/docs/admin/kubeadm_alpha_kubeconfig.md
diff --git a/docs/admin/kubeadm_alpha_kubeconfig_user.md b/docs/admin/kubeadm_alpha_kubeconfig_user.md
diff --git a/docs/admin/kubeadm_alpha_kubelet.md b/docs/admin/kubeadm_alpha_kubelet.md
diff --git a/docs/admin/kubeadm_alpha_kubelet_config.md b/docs/admin/kubeadm_alpha_kubelet_config.md
diff --git a/docs/admin/kubeadm_alpha_kubelet_config_download.md b/docs/admin/kubeadm_alpha_kubelet_config_download.md
diff --git a/docs/admin/kubeadm_alpha_kubelet_config_enable-dynamic.md b/docs/admin/kubeadm_alpha_kubelet_config_enable-dynamic.md
diff --git a/docs/admin/kubeadm_alpha_preflight.md b/docs/admin/kubeadm_alpha_preflight.md
diff --git a/docs/admin/kubeadm_alpha_preflight_node.md b/docs/admin/kubeadm_alpha_preflight_node.md
diff --git a/docs/admin/kubeadm_alpha_selfhosting.md b/docs/admin/kubeadm_alpha_selfhosting.md
diff --git a/docs/admin/kubeadm_alpha_selfhosting_pivot.md b/docs/admin/kubeadm_alpha_selfhosting_pivot.md
diff --git a/docs/admin/kubeadm_completion.md b/docs/admin/kubeadm_completion.md
diff --git a/docs/admin/kubeadm_config.md b/docs/admin/kubeadm_config.md
diff --git a/docs/admin/kubeadm_config_images.md b/docs/admin/kubeadm_config_images.md
diff --git a/docs/admin/kubeadm_config_images_list.md b/docs/admin/kubeadm_config_images_list.md
diff --git a/docs/admin/kubeadm_config_images_pull.md b/docs/admin/kubeadm_config_images_pull.md
diff --git a/docs/admin/kubeadm_config_migrate.md b/docs/admin/kubeadm_config_migrate.md
diff --git a/docs/admin/kubeadm_config_print.md b/docs/admin/kubeadm_config_print.md
diff --git a/docs/admin/kubeadm_config_print_init-defaults.md b/docs/admin/kubeadm_config_print_init-defaults.md
diff --git a/docs/admin/kubeadm_config_print_join-defaults.md b/docs/admin/kubeadm_config_print_join-defaults.md
diff --git a/docs/admin/kubeadm_config_upload.md b/docs/admin/kubeadm_config_upload.md
diff --git a/docs/admin/kubeadm_config_upload_from-file.md b/docs/admin/kubeadm_config_upload_from-file.md
diff --git a/docs/admin/kubeadm_config_upload_from-flags.md b/docs/admin/kubeadm_config_upload_from-flags.md
diff --git a/docs/admin/kubeadm_config_view.md b/docs/admin/kubeadm_config_view.md
diff --git a/docs/admin/kubeadm_init.md b/docs/admin/kubeadm_init.md
diff --git a/docs/admin/kubeadm_init_phase.md b/docs/admin/kubeadm_init_phase.md
diff --git a/docs/admin/kubeadm_init_phase_addon.md b/docs/admin/kubeadm_init_phase_addon.md
diff --git a/docs/admin/kubeadm_init_phase_addon_all.md b/docs/admin/kubeadm_init_phase_addon_all.md
diff --git a/docs/admin/kubeadm_init_phase_addon_coredns.md b/docs/admin/kubeadm_init_phase_addon_coredns.md
diff --git a/docs/admin/kubeadm_init_phase_addon_kube-proxy.md b/docs/admin/kubeadm_init_phase_addon_kube-proxy.md
diff --git a/docs/admin/kubeadm_init_phase_bootstrap-token.md b/docs/admin/kubeadm_init_phase_bootstrap-token.md
diff --git a/docs/admin/kubeadm_init_phase_certs.md b/docs/admin/kubeadm_init_phase_certs.md
diff --git a/docs/admin/kubeadm_init_phase_certs_all.md b/docs/admin/kubeadm_init_phase_certs_all.md
diff --git a/docs/admin/kubeadm_init_phase_certs_apiserver-etcd-client.md b/docs/admin/kubeadm_init_phase_certs_apiserver-etcd-client.md
diff --git a/docs/admin/kubeadm_init_phase_certs_apiserver-kubelet-client.md b/docs/admin/kubeadm_init_phase_certs_apiserver-kubelet-client.md
diff --git a/docs/admin/kubeadm_init_phase_certs_apiserver.md b/docs/admin/kubeadm_init_phase_certs_apiserver.md
diff --git a/docs/admin/kubeadm_init_phase_certs_ca.md b/docs/admin/kubeadm_init_phase_certs_ca.md
diff --git a/docs/admin/kubeadm_init_phase_certs_etcd-ca.md b/docs/admin/kubeadm_init_phase_certs_etcd-ca.md
diff --git a/docs/admin/kubeadm_init_phase_certs_etcd-healthcheck-client.md b/docs/admin/kubeadm_init_phase_certs_etcd-healthcheck-client.md
diff --git a/docs/admin/kubeadm_init_phase_certs_etcd-peer.md b/docs/admin/kubeadm_init_phase_certs_etcd-peer.md
diff --git a/docs/admin/kubeadm_init_phase_certs_etcd-server.md b/docs/admin/kubeadm_init_phase_certs_etcd-server.md
diff --git a/docs/admin/kubeadm_init_phase_certs_front-proxy-ca.md b/docs/admin/kubeadm_init_phase_certs_front-proxy-ca.md
diff --git a/docs/admin/kubeadm_init_phase_certs_front-proxy-client.md b/docs/admin/kubeadm_init_phase_certs_front-proxy-client.md
diff --git a/docs/admin/kubeadm_init_phase_certs_sa.md b/docs/admin/kubeadm_init_phase_certs_sa.md
diff --git a/docs/admin/kubeadm_init_phase_control-plane.md b/docs/admin/kubeadm_init_phase_control-plane.md
diff --git a/docs/admin/kubeadm_init_phase_control-plane_all.md b/docs/admin/kubeadm_init_phase_control-plane_all.md
diff --git a/docs/admin/kubeadm_init_phase_control-plane_apiserver.md b/docs/admin/kubeadm_init_phase_control-plane_apiserver.md
diff --git a/docs/admin/kubeadm_init_phase_control-plane_controller-manager.md b/docs/admin/kubeadm_init_phase_control-plane_controller-manager.md
diff --git a/docs/admin/kubeadm_init_phase_control-plane_scheduler.md b/docs/admin/kubeadm_init_phase_control-plane_scheduler.md
diff --git a/docs/admin/kubeadm_init_phase_etcd.md b/docs/admin/kubeadm_init_phase_etcd.md
diff --git a/docs/admin/kubeadm_init_phase_etcd_local.md b/docs/admin/kubeadm_init_phase_etcd_local.md
diff --git a/docs/admin/kubeadm_init_phase_kubeconfig.md b/docs/admin/kubeadm_init_phase_kubeconfig.md
diff --git a/docs/admin/kubeadm_init_phase_kubeconfig_admin.md b/docs/admin/kubeadm_init_phase_kubeconfig_admin.md
diff --git a/docs/admin/kubeadm_init_phase_kubeconfig_all.md b/docs/admin/kubeadm_init_phase_kubeconfig_all.md
diff --git a/docs/admin/kubeadm_init_phase_kubeconfig_controller-manager.md b/docs/admin/kubeadm_init_phase_kubeconfig_controller-manager.md
diff --git a/docs/admin/kubeadm_init_phase_kubeconfig_kubelet.md b/docs/admin/kubeadm_init_phase_kubeconfig_kubelet.md
diff --git a/docs/admin/kubeadm_init_phase_kubeconfig_scheduler.md b/docs/admin/kubeadm_init_phase_kubeconfig_scheduler.md
diff --git a/docs/admin/kubeadm_init_phase_kubelet-start.md b/docs/admin/kubeadm_init_phase_kubelet-start.md
diff --git a/docs/admin/kubeadm_init_phase_mark-control-plane.md b/docs/admin/kubeadm_init_phase_mark-control-plane.md
diff --git a/docs/admin/kubeadm_init_phase_preflight.md b/docs/admin/kubeadm_init_phase_preflight.md
diff --git a/docs/admin/kubeadm_init_phase_upload-config.md b/docs/admin/kubeadm_init_phase_upload-config.md
diff --git a/docs/admin/kubeadm_init_phase_upload-config_all.md b/docs/admin/kubeadm_init_phase_upload-config_all.md
diff --git a/docs/admin/kubeadm_init_phase_upload-config_kubeadm.md b/docs/admin/kubeadm_init_phase_upload-config_kubeadm.md
diff --git a/docs/admin/kubeadm_init_phase_upload-config_kubelet.md b/docs/admin/kubeadm_init_phase_upload-config_kubelet.md
diff --git a/docs/admin/kubeadm_join.md b/docs/admin/kubeadm_join.md
diff --git a/docs/admin/kubeadm_reset.md b/docs/admin/kubeadm_reset.md
diff --git a/docs/admin/kubeadm_token.md b/docs/admin/kubeadm_token.md
diff --git a/docs/admin/kubeadm_token_create.md b/docs/admin/kubeadm_token_create.md
diff --git a/docs/admin/kubeadm_token_delete.md b/docs/admin/kubeadm_token_delete.md
diff --git a/docs/admin/kubeadm_token_generate.md b/docs/admin/kubeadm_token_generate.md
diff --git a/docs/admin/kubeadm_token_list.md b/docs/admin/kubeadm_token_list.md
diff --git a/docs/admin/kubeadm_upgrade.md b/docs/admin/kubeadm_upgrade.md
diff --git a/docs/admin/kubeadm_upgrade_apply.md b/docs/admin/kubeadm_upgrade_apply.md
diff --git a/docs/admin/kubeadm_upgrade_diff.md b/docs/admin/kubeadm_upgrade_diff.md
diff --git a/docs/admin/kubeadm_upgrade_node.md b/docs/admin/kubeadm_upgrade_node.md
diff --git a/docs/admin/kubeadm_upgrade_node_config.md b/docs/admin/kubeadm_upgrade_node_config.md
diff --git a/docs/admin/kubeadm_upgrade_node_experimental-control-plane.md b/docs/admin/kubeadm_upgrade_node_experimental-control-plane.md
diff --git a/docs/admin/kubeadm_upgrade_plan.md b/docs/admin/kubeadm_upgrade_plan.md
diff --git a/docs/admin/kubeadm_version.md b/docs/admin/kubeadm_version.md