github/kubernetes
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #10896 from thockin/docs-versioning-2

Browse Source 
Make READMEs even more obviously versioned.
This commit is contained in:
Victor Marmol
2015-07-08 16:24:40 -07:00
parent f427b997ca 3d97d82655
commit dd378f148b
3 changed files with 46 additions and 26 deletions
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" echo "+++ Versioning documentation and examples"
# Update the docs to match this version. # Update the docs to match this version.
$SED -ri -e "s/HEAD/${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_PATCH}/" docs/README.md DOCS_TO_EDIT=(docs/README.md examples/README.md)
$SED -ri -e "s/HEAD/${VERSION_MAJOR}.${VERSION_MINOR}.${VERSION_PATCH}/" 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. # 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 $SED -ri -e "s|(releases.k8s.io)/HEAD|\1/${NEW_VERSION}|" pkg/api/v[0-9]*/types.go

41
docs/README.md
View File

@@ -1,29 +1,38 @@
# Kubernetes Documentation # Kubernetes Documentation: HEAD
**Note** <!-- BEGIN STRIP_FOR_RELEASE -->
This documentation is current for HEAD.
Documentation for previous releases is available at <h1>*** PLEASE NOTE: This documentation applies to the HEAD of the source
http://releases.k8s.io/vX.Y.Z/docs. tree only. If you are using a released version of Kubernetes, you almost
* [releases.k8s.io/v0.20.0](http://releases.k8s.io/v0.20.0/docs) certainly want the docs that go with that version.</h1>
* [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)
* The [User's guide](user-guide.md) is for anyone who wants to run programs and services on an existing Kubernetes cluster. <strong>Documentation for specific releases can be found at
[releases.k8s.io](http://releases.k8s.io).</strong>
* The [Cluster Admin's guide](cluster-admin-guide.md) is for anyone setting up a Kubernetes cluster or administering it. <!-- END STRIP_FOR_RELEASE -->
* The [Developer guide](developer-guide.md) is for anyone wanting to write programs that access the kubernetes API, ## Where to start
write plugins or extensions, or modify the core code of kubernetes.
* The [Kubectl Command Line Interface](kubectl.md) is a detailed reference on the `kubectl` CLI. * The [User's guide](user-guide.md) is for anyone who wants to run programs and
services on an existing Kubernetes cluster.
* The [API object documentation](http://kubernetes.io/third_party/swagger-ui/) is a detailed description of all fields found in core API objects. * The [Cluster Admin's guide](cluster-admin-guide.md) is for anyone setting up
a Kubernetes cluster or administering it.
* The [Developer guide](developer-guide.md) is for anyone wanting to write
programs that access the kubernetes API, write plugins or extensions, or
modify the core code of kubernetes.
* The [Kubectl Command Line Interface](kubectl.md) is a detailed reference on
the `kubectl` CLI.
* The [API object documentation](http://kubernetes.io/third_party/swagger-ui/)
is a detailed description of all fields found in core API objects.
* An overview of the [Design of Kubernetes](design) * An overview of the [Design of Kubernetes](design)
* There are example files and walkthroughs in the [examples](../examples) folder. * There are example files and walkthroughs in the [examples](../examples)
folder.
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/README.md?pixel)]() [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/README.md?pixel)]()

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** <h1>*** PLEASE NOTE: These examples apply to the HEAD of the source
This documentation is current for HEAD. 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: <strong>Examples for specific releases can be found at
* [v0.19.0](https://github.com/GoogleCloudPlatform/kubernetes/tree/master/release-0.19.0/examples) [releases.k8s.io](http://releases.k8s.io).</strong>
* [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) <!-- 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)]() [![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/examples/README.md?pixel)]()