From e051497be9fc81888522296d6143afd1292993c2 Mon Sep 17 00:00:00 2001 From: Brendan Burns Date: Thu, 4 Jun 2015 21:18:30 -0700 Subject: [PATCH] Add some text about the docs being sync'd to HEAD Add pointers to the release branch files. Clone docs when creating a new release. --- build/mark-new-version.sh | 14 ++++++++++++++ docs/README.md | 7 +++++++ examples/README.md | 13 +++++++++++++ 3 files changed, 34 insertions(+) create mode 100644 examples/README.md diff --git a/build/mark-new-version.sh b/build/mark-new-version.sh index c2eb7de5e70..c45fdeeecc8 100755 --- a/build/mark-new-version.sh +++ b/build/mark-new-version.sh @@ -91,6 +91,20 @@ fi VERSION_FILE="${KUBE_ROOT}/pkg/version/base.go" +RELEASE_DIR=release-${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_PATCH} +echo "+++ Cloning documentation and examples into ${RELEASE_DIR}/..." +mkdir ${RELEASE_DIR} +cp -r docs ${RELEASE_DIR}/docs +cp -r examples ${RELEASE_DIR}/examples + +# Update the docs to match this version. +perl -pi -e "s/HEAD/${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_PATCH}/" ${RELEASE_DIR}/docs/README.md +perl -pi -e "s/HEAD/${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_PATCH}/" ${RELEASE_DIR}/examples/README.md + +${KUBE_ROOT}/hack/run-gendocs.sh +git add ${RELEASE_DIR} +git commit -m "Cloning docs for ${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_PATCH}" + GIT_MINOR="${VERSION_MINOR}.${VERSION_PATCH}" echo "+++ Updating to ${NEW_VERSION}" "$SED" -r -i -e "s/gitMajor\s+string = \"[^\"]*\"/gitMajor string = \"${VERSION_MAJOR}\"/" "${VERSION_FILE}" diff --git a/docs/README.md b/docs/README.md index efae5cf368a..2d113d2b482 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,5 +1,12 @@ # Kubernetes Documentation +**Note** +This documentation is current for HEAD. + +Documentation for previous releases is available in their respective branches: + * [v0.18.1](https://github.com/GoogleCloudPlatform/kubernetes/tree/release-0.18/docs) + * [v0.17.1](https://github.com/GoogleCloudPlatform/kubernetes/tree/release-0.17/docs) + * The [User's guide](user-guide.md) is for anyone who wants to run programs and services on an exisiting Kubernetes cluster. * The [Cluster Admin's guide](cluster-admin-guide.md) is for anyone setting up a Kubernetes cluster or administering it. diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 00000000000..9171e284b7e --- /dev/null +++ b/examples/README.md @@ -0,0 +1,13 @@ +# Examples + +This directory contains a number of different examples of how to run applications with Kubernetes. + +**Note** +This documentation is current for HEAD. + +Examples for previous releases is available in their respective branches: + * [v0.18.1](https://github.com/GoogleCloudPlatform/kubernetes/tree/release-0.18/examples) + * [v0.17.1](https://github.com/GoogleCloudPlatform/kubernetes/tree/release-0.17/examples) + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/examples/README.md?pixel)]()