github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-29 14:37:00 +00:00
Code Issues Projects Releases Wiki Activity

Add some text about the docs being sync'd to HEAD

Browse Source 
Add pointers to the release branch files.
Clone docs when creating a new release.
This commit is contained in:
Brendan Burns 2015-06-04 21:18:30 -07:00
parent fc80fd6860
commit e051497be9
3 changed files with 34 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
build/mark-new-version.sh
View File

@ -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}"

7
docs/README.md
View File

@ -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.

13
examples/README.md Normal file
View File

@ -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)]()