From 45b0917b6b1a5788b48256901fcc0248388ef6f5 Mon Sep 17 00:00:00 2001 From: Chao Xu Date: Fri, 23 Oct 2015 16:41:35 -0700 Subject: [PATCH] versionize the include directory in definitions.md and operations.md --- build/versionize-docs.sh | 8 ++++++++ docs/api-reference/extensions/v1beta1/definitions.md | 2 +- docs/api-reference/extensions/v1beta1/operations.md | 2 +- docs/api-reference/v1/definitions.md | 2 +- docs/api-reference/v1/operations.md | 2 +- 5 files changed, 12 insertions(+), 4 deletions(-) diff --git a/build/versionize-docs.sh b/build/versionize-docs.sh index 9d62f8635f0..aa45e26d57a 100755 --- a/build/versionize-docs.sh +++ b/build/versionize-docs.sh @@ -27,6 +27,9 @@ KUBE_ROOT=$(dirname "${BASH_SOURCE}")/.. NEW_VERSION=${1-} +# NEW_VERSION is expected to be vMajor.Minor.Micro. +MAJOR_AND_MINOR_VERSION=${NEW_VERSION%.*} + if [ "$#" -lt 1 ]; then echo "Usage: versionize-docs " exit 1 @@ -45,6 +48,8 @@ echo "+++ Versioning documentation and examples" # Update the docs to match this version. HTML_PREVIEW_PREFIX="https://htmlpreview.github.io/\?https://github.com/kubernetes/kubernetes" +# Update the include directory in definitions.md and operations.md. +DIRECTORY_KEY_WORDS="" md_dirs=(docs examples) md_files=() @@ -60,6 +65,9 @@ for doc in "${md_files[@]}"; do # Replace /HEAD in html preview links with /NEW_VERSION. $SED -ri -e "s|(${HTML_PREVIEW_PREFIX})/HEAD|\1/blob/${NEW_VERSION}|g" "${doc}" + # Replace with MAJOR_AND_MINOR_VERSION. + $SED -ri -e "s|${DIRECTORY_KEY_WORDS}|${MAJOR_AND_MINOR_VERSION}|g" "${doc}" + is_versioned_tag=" " diff --git a/docs/api-reference/extensions/v1beta1/definitions.md b/docs/api-reference/extensions/v1beta1/definitions.md index 11c41247dc3..173621eb8f7 100644 --- a/docs/api-reference/extensions/v1beta1/definitions.md +++ b/docs/api-reference/extensions/v1beta1/definitions.md @@ -31,7 +31,7 @@ Documentation for other releases can be found at -{% include extensions-v1beta1-definitions.html %} +{% include /extensions-v1beta1-definitions.html %} diff --git a/docs/api-reference/extensions/v1beta1/operations.md b/docs/api-reference/extensions/v1beta1/operations.md index abbbcc823b1..0845a6f13d8 100644 --- a/docs/api-reference/extensions/v1beta1/operations.md +++ b/docs/api-reference/extensions/v1beta1/operations.md @@ -31,7 +31,7 @@ Documentation for other releases can be found at -{% include extensions-v1beta1-operations.html %} +{% include /extensions-v1beta1-operations.html %} diff --git a/docs/api-reference/v1/definitions.md b/docs/api-reference/v1/definitions.md index 0903c82aeae..26b61ea9b17 100644 --- a/docs/api-reference/v1/definitions.md +++ b/docs/api-reference/v1/definitions.md @@ -31,7 +31,7 @@ Documentation for other releases can be found at -{% include v1-definitions.html %} +{% include /v1-definitions.html %} diff --git a/docs/api-reference/v1/operations.md b/docs/api-reference/v1/operations.md index 4e5596c212c..ceadb60eb24 100644 --- a/docs/api-reference/v1/operations.md +++ b/docs/api-reference/v1/operations.md @@ -31,7 +31,7 @@ Documentation for other releases can be found at -{% include v1-operations.html %} +{% include /v1-operations.html %}