github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-08-10 04:27:54 +00:00
Code Issues Projects Releases Wiki Activity

Make READMEs clearer wrt versions

Browse Source
This commit is contained in:
Tim Hockin 2015-07-07 16:22:34 -07:00
parent e445e836b1
commit 82b246e487
3 changed files with 13 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -92,8 +92,13 @@ fi
echo "+++ Versioning documentation and examples"
# Update the docs to match this version.
$SED -ri -e "s/HEAD/${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_PATCH}/" docs/README.md
$SED -ri -e "s/HEAD/${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_PATCH}/" examples/README.md
DOCS_TO_EDIT=(docs/README.md examples/README.md)
for DOC in "${DOCS_TO_EDIT[@]}"; do
$SED -ri \
-e "s/HEAD/${NEW_VERSION}/" \
-e "/<!-- BEGIN STRIP_FOR_RELEASE -->/,/<!-- END STRIP_FOR_RELEASE -->/d" \
"${DOC}"
done
# Update API descriptions to match this version.
$SED -ri -e "s|(releases.k8s.io)/HEAD|\1/${NEW_VERSION}|" pkg/api/v[0-9]*/types.go

9
docs/README.md
View File

@ -1,12 +1,7 @@
# Kubernetes Documentation
# Kubernetes Documentation: v0.21.1
**Note**
This documentation is current for 0.21.0.
Documentation for previous releases is available in their respective branches:
* [v0.19.0](https://github.com/GoogleCloudPlatform/kubernetes/tree/master/release-0.19.0/docs)
* [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)
## Where to start
* The [User's guide](user-guide.md) is for anyone who wants to run programs and
services on an existing Kubernetes cluster.

12
examples/README.md
View File

@ -1,14 +1,10 @@
# Examples
# Kubernetes Examples: v0.21.1
This directory contains a number of different examples of how to run applications with Kubernetes.
**Note**
This documentation is current for 0.21.0.
##
Examples for previous releases is available in their respective branches:
* [v0.19.0](https://github.com/GoogleCloudPlatform/kubernetes/tree/master/release-0.19.0/examples)
* [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)
This directory contains a number of different examples of how to run
applications with Kubernetes.
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/examples/README.md?pixel)]()