From 120960b9540c7d59c071be66477a2ccc5004973b Mon Sep 17 00:00:00 2001 From: irfanurrehman Date: Tue, 22 Aug 2017 06:22:50 +0530 Subject: [PATCH] Make kubefed docs similar to rest of the docs in docs/admin (#4934) * Change update-imported.docs.sh for kubefed docs * Stop skipping title check for kubefed docs * Update kubefed docs with titles --- docs/admin/kubefed.md | 4 ++++ docs/admin/kubefed_init.md | 4 ++++ docs/admin/kubefed_join.md | 4 ++++ docs/admin/kubefed_options.md | 4 ++++ docs/admin/kubefed_unjoin.md | 4 ++++ docs/admin/kubefed_version.md | 4 ++++ skip_title_check.txt | 6 ------ update-imported-docs.sh | 3 ++- 8 files changed, 26 insertions(+), 7 deletions(-) diff --git a/docs/admin/kubefed.md b/docs/admin/kubefed.md index a733eac59e..5d670e438e 100644 --- a/docs/admin/kubefed.md +++ b/docs/admin/kubefed.md @@ -1,3 +1,7 @@ +--- +title: kubefed +notitle: true +--- ## kubefed kubefed controls a Kubernetes Cluster Federation diff --git a/docs/admin/kubefed_init.md b/docs/admin/kubefed_init.md index 656cdde6ee..056fd1025c 100644 --- a/docs/admin/kubefed_init.md +++ b/docs/admin/kubefed_init.md @@ -1,3 +1,7 @@ +--- +title: kubefed init +notitle: true +--- ## kubefed init Initialize a federation control plane diff --git a/docs/admin/kubefed_join.md b/docs/admin/kubefed_join.md index 1f57e75af4..22fafdfedd 100644 --- a/docs/admin/kubefed_join.md +++ b/docs/admin/kubefed_join.md @@ -1,3 +1,7 @@ +--- +title: kubefed join +notitle: true +--- ## kubefed join Join a cluster to a federation diff --git a/docs/admin/kubefed_options.md b/docs/admin/kubefed_options.md index 9784b3226f..54e26b3977 100644 --- a/docs/admin/kubefed_options.md +++ b/docs/admin/kubefed_options.md @@ -1,3 +1,7 @@ +--- +title: kubefed options +notitle: true +--- ## kubefed options Print the list of flags inherited by all commands diff --git a/docs/admin/kubefed_unjoin.md b/docs/admin/kubefed_unjoin.md index db2cec33d2..0eae42292e 100644 --- a/docs/admin/kubefed_unjoin.md +++ b/docs/admin/kubefed_unjoin.md @@ -1,3 +1,7 @@ +--- +title: kubefed unjoin +notitle: true +--- ## kubefed unjoin Unjoin a cluster from a federation diff --git a/docs/admin/kubefed_version.md b/docs/admin/kubefed_version.md index 1bcdf5e417..0e8c194db4 100644 --- a/docs/admin/kubefed_version.md +++ b/docs/admin/kubefed_version.md @@ -1,3 +1,7 @@ +--- +title: kubefed version +notitle: true +--- ## kubefed version Print the client and server version information diff --git a/skip_title_check.txt b/skip_title_check.txt index 915ce048a2..29d3195ed9 100644 --- a/skip_title_check.txt +++ b/skip_title_check.txt @@ -4,12 +4,6 @@ docs/getting-started-guides/docker.md docs/getting-started-guides/docker-multinode.md docs/user-guide/configmap/README.md docs/user-guide/downward-api/README.md -docs/admin/kubefed_unjoin.md -docs/admin/kubefed_init.md -docs/admin/kubefed.md -docs/admin/kubefed_join.md -docs/admin/kubefed_options.md -docs/admin/kubefed_version.md docs/api-reference/extensions/v1beta1/definitions.md docs/api-reference/extensions/v1beta1/operations.md docs/api-reference/v1/definitions.md diff --git a/update-imported-docs.sh b/update-imported-docs.sh index cc52baeb89..717bb90ffc 100755 --- a/update-imported-docs.sh +++ b/update-imported-docs.sh @@ -136,7 +136,7 @@ done <_data/overrides.yml ) -BINARIES="federation-apiserver.md federation-controller-manager.md kube-apiserver.md kube-controller-manager.md kube-proxy.md kube-scheduler.md kubelet.md" +BINARIES="federation-apiserver.md federation-controller-manager.md kube-apiserver.md kube-controller-manager.md kube-proxy.md kube-scheduler.md kubelet.md kubefed.md kubefed_init.md kubefed_join.md kubefed_options.md kubefed_unjoin.md kubefed_version.md" ( cd docs/admin @@ -149,6 +149,7 @@ BINARIES="federation-apiserver.md federation-controller-manager.md kube-apiserve ---' "$bin" done ) + mv -- "${APIREFDESDIR}" "${APIREFSRCDIR}" mv -- "${KUBECTLDESDIR}" "${KUBECTLSRCDIR}" rm -rf -- "${TMPDIR}" "${K8SREPO}"