From 0d7ec93861fa5786a9971202300a859a0a554231 Mon Sep 17 00:00:00 2001 From: Tim Hockin Date: Tue, 7 Jul 2015 15:41:43 -0700 Subject: [PATCH 1/2] reflow lines --- docs/README.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/docs/README.md b/docs/README.md index 7794e486f50..49396cc7d59 100644 --- a/docs/README.md +++ b/docs/README.md @@ -10,20 +10,26 @@ http://releases.k8s.io/vX.Y.Z/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. +* The [User's guide](user-guide.md) is for anyone who wants to run programs and + services on an existing Kubernetes cluster. -* The [Cluster Admin's guide](cluster-admin-guide.md) is for anyone setting up a Kubernetes cluster or administering it. +* 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 [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 [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. +* 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) -* 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)]() From 3d97d82655842e487c833aff6a19ccd2cb8bef4b Mon Sep 17 00:00:00 2001 From: Tim Hockin Date: Tue, 7 Jul 2015 16:22:34 -0700 Subject: [PATCH 2/2] Make READMEs clearer wrt versions --- build/mark-new-version.sh | 9 +++++++-- docs/README.md | 21 ++++++++++++--------- examples/README.md | 22 ++++++++++++++-------- 3 files changed, 33 insertions(+), 19 deletions(-) diff --git a/build/mark-new-version.sh b/build/mark-new-version.sh index 44c7eb2091c..1c445c0332f 100755 --- a/build/mark-new-version.sh +++ b/build/mark-new-version.sh @@ -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 "//,//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 diff --git a/docs/README.md b/docs/README.md index 49396cc7d59..ad3f4b00454 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,14 +1,17 @@ -# Kubernetes Documentation +# Kubernetes Documentation: HEAD -**Note** -This documentation is current for HEAD. + -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) +

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

+ +Documentation for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + +## 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. diff --git a/examples/README.md b/examples/README.md index 8649953c2ef..651a034f306 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,14 +1,20 @@ -# Examples +# Kubernetes Examples: HEAD -This directory contains a number of different examples of how to run applications with Kubernetes. + -**Note** -This documentation is current for HEAD. +

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

-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) +Examples for specific releases can be found at +[releases.k8s.io](http://releases.k8s.io). + + + +## + +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)]()