From 0ceeb7a1bd4d7aa16d5fd3dcf027ab9911044226 Mon Sep 17 00:00:00 2001 From: Luc Perkins Date: Tue, 25 Sep 2018 09:04:23 -0700 Subject: [PATCH] Remove unused scripts (#10152) --- .travis.yml | 1 - skip_title_check.txt | 74 ------------------------------------------ skip_toc_check.txt | 75 ------------------------------------------- verify-docs-format.sh | 62 ----------------------------------- 4 files changed, 212 deletions(-) delete mode 100644 skip_title_check.txt delete mode 100644 skip_toc_check.txt delete mode 100755 verify-docs-format.sh diff --git a/.travis.yml b/.travis.yml index f114d1dc79..d55f55fd40 100644 --- a/.travis.yml +++ b/.travis.yml @@ -19,4 +19,3 @@ install: script: - go test -v k8s.io/website/content/en/examples -#- ./verify-docs-format.sh diff --git a/skip_title_check.txt b/skip_title_check.txt deleted file mode 100644 index 9d4b06fc55..0000000000 --- a/skip_title_check.txt +++ /dev/null @@ -1,74 +0,0 @@ -# Put files you want to skip "title:" check here: -docs/reference/generated/README.md -docs/reference/generated/federation/v1/operations.html -docs/reference/generated/federation/v1/definitions.html -docs/reference/generated/federation/extensions/v1beta1/operations.html -docs/reference/generated/federation/extensions/v1beta1/definitions.html -docs/sitemap.md -docs/reference/setup-tools/kubeadm/generated/README.md -docs/reference/setup-tools/kubeadm/generated/kubeadm.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_all.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_kube-dns.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_kube-proxy.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_all.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_cluster-info.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_create.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node_allow-auto-approve.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node_allow-post-csrs.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_all.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver-etcd-client.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver-kubelet-client.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_ca.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-ca.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-healthcheck-client.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-peer.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-server.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_front-proxy-ca.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_front-proxy-client.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_sa.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_all.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_apiserver.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_controller-manager.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_scheduler.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_etcd.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_etcd_local.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_admin.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_all.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_controller-manager.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_kubelet.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_scheduler.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_user.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_mark-master.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight_master.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight_node.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_selfhosting.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_selfhosting_convert-from-staticpods.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_upload-config.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_completion.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_config.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-file.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-flags.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_config_view.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_init.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_join.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_reset.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_token.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_token_create.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_token_delete.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_token_generate.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_token_list.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_apply.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_plan.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_version.md diff --git a/skip_toc_check.txt b/skip_toc_check.txt deleted file mode 100644 index abc03e4f7d..0000000000 --- a/skip_toc_check.txt +++ /dev/null @@ -1,75 +0,0 @@ -# Put files you want to skip table of contents entry check here: -docs/concepts/example-concept-template.md -docs/reference/generated/README.md -docs/search.md -docs/sitemap.md -docs/tasks/example-task-template.md -docs/tutorials/example-tutorial-template.md -docs/reference/setup-tools/kubeadm/generated/README.md -docs/reference/setup-tools/kubeadm/generated/kubeadm.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_all.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_kube-dns.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_addon_kube-proxy.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_all.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_cluster-info.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_create.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node_allow-auto-approve.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_bootstrap-token_node_allow-post-csrs.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_all.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver-etcd-client.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver-kubelet-client.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_apiserver.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_ca.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-ca.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-healthcheck-client.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-peer.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_etcd-server.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_front-proxy-ca.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_front-proxy-client.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_certs_sa.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_all.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_apiserver.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_controller-manager.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_controlplane_scheduler.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_etcd.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_etcd_local.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_admin.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_all.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_controller-manager.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_kubelet.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_scheduler.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_kubeconfig_user.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_mark-master.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight_master.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_preflight_node.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_selfhosting.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_selfhosting_convert-from-staticpods.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_alpha_phase_upload-config.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_completion.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_config.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-file.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_config_upload_from-flags.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_config_view.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_init.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_join.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_reset.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_token.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_token_create.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_token_delete.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_token_generate.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_token_list.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_apply.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_upgrade_plan.md -docs/reference/setup-tools/kubeadm/generated/kubeadm_version.md -docs/user-journeys/users/cluster-operator/_advanced.md diff --git a/verify-docs-format.sh b/verify-docs-format.sh deleted file mode 100755 index dfdf4bbac3..0000000000 --- a/verify-docs-format.sh +++ /dev/null @@ -1,62 +0,0 @@ -#!/bin/bash - -no_entry=false -no_entry_counter=0 -no_title=false -no_title_counter=0 - -# Verify all docs/.../*.md files -# Skip checking autogenerated files in some folders -# (docs/api-reference/v1.5, docs/user-guide/kubectl/v1.5, and -# docs/resources-reference/v1.5) -for file in `find docs -name "*.md" -type f`; do - # Skip checking all files in the following folders - if [[ "${file}" == "docs/api-reference/v1."* ]] || - [[ "${file}" == "docs/user-guide/kubectl/v1."* ]] || - [[ "${file}" == "docs/resources-reference/v1."* ]]; then - continue - fi - - # 1. TOC check: - # Check they are referenced in at least one of _data/*.yml files. - # Skip checking files in skip_toc_check.txt - if ! grep -q "${file}" skip_toc_check.txt; then - path=${file%.*} - # abc/index.md should point to abc, not abc/index - path=${path%%index} - if ! grep -q "${path}" _data/*.yml; then - echo "Error: ${file} doesn't have an entry in the table of contents under _data/*.yml" - no_entry=true - no_entry_counter=$[no_entry_counter+1] - fi - fi - - # 2. Title check: - # Check they have a proper title. - # Skip checking files in skip_title_check.txt. - # Title should start with "title:" and can have several spaces/tabs between - # non-space/tab content. They should also be inside the markdown header. - # For example, "title:", " title: abc", and "title:" aren't valid, - # but "title: abc", "title:def" and "title: def ghi" are both valid. - if [[ "${file}" == "docs/user-guide/kubectl/kubectl"* ]]; then - # Skip checking auto-generated kubectl docs since its first heading matches title - continue - fi - if ! grep -q "${file}" skip_title_check.txt; then - if ! grep -q "^title:\s*[^\s]" ${file}; then - echo "Error: ${file} doesn't have a proper title defined!" - no_title=true - no_title_counter=$[no_title_counter+1] - fi - fi -done - -if ${no_entry}; then - echo "Found ${no_entry_counter} files without entries. For how to fix it, see http://kubernetes.io/docs/home/contribute/write-new-topic/#creating-an-entry-in-the-table-of-contents" - exit 1 -fi - -if ${no_title}; then - echo "Found ${no_title_counter} files without titles." - exit 1 -fi