github/kubernetes
4
0
Fork 0
Code Issues Pull Requests Packages 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 0d7ec93861
commit 3d97d82655
3 changed files with 33 additions and 19 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

21
docs/README.md
View File

@ -1,14 +1,17 @@
# Kubernetes Documentation
# Kubernetes Documentation: HEAD
**Note**
This documentation is current for HEAD.
<!-- BEGIN STRIP_FOR_RELEASE -->
Documentation for previous releases is available at
http://releases.k8s.io/vX.Y.Z/docs.
* [releases.k8s.io/v0.20.0](http://releases.k8s.io/v0.20.0/docs)
* [releases.k8s.io/v0.19.0](http://releases.k8s.io/v0.19.0/docs)
* [releases.k8s.io/v0.18.1](http://releases.k8s.io/v0.18.1/docs)
* [releases.k8s.io/v0.17.1](http://releases.k8s.io/v0.17.1/docs)
<h1>*** PLEASE NOTE: This documentation applies to the HEAD of the source
tree only. If you are using a released version of Kubernetes, you almost
certainly want the docs that go with that version.</h1>
<strong>Documentation for specific releases can be found at
[releases.k8s.io](http://releases.k8s.io).</strong>
<!-- END STRIP_FOR_RELEASE -->
## 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.

22
examples/README.md
View File

@ -1,14 +1,20 @@
# Examples
# Kubernetes Examples: HEAD
This directory contains a number of different examples of how to run applications with Kubernetes.
<!-- BEGIN STRIP_FOR_RELEASE -->
**Note**
This documentation is current for HEAD.
<h1>*** PLEASE NOTE: These examples apply to the HEAD of the source
tree only. If you are using a released version of Kubernetes, you almost
certainly want the examples that go with that version.</h1>
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)
<strong>Examples for specific releases can be found at
[releases.k8s.io](http://releases.k8s.io).</strong>
<!-- END STRIP_FOR_RELEASE -->
##
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)]()