summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Dodson <sdodson@redhat.com>2017-12-12 10:56:36 -0500
committerGitHub <noreply@github.com>2017-12-12 10:56:36 -0500
commit6fa3a11083892e9e6a268dd1deae32d3fc823fd3 (patch)
tree329a1ebe955cc7da287eddfa0b29a6cf6a69cd70
parent01ae634a0bf89fe840006f9139f8ffd20e09afc8 (diff)
parent7503aa2775fc28a6611d1b3ef12c78549927122c (diff)
downloadopenshift-6fa3a11083892e9e6a268dd1deae32d3fc823fd3.tar.gz
openshift-6fa3a11083892e9e6a268dd1deae32d3fc823fd3.tar.bz2
openshift-6fa3a11083892e9e6a268dd1deae32d3fc823fd3.tar.xz
openshift-6fa3a11083892e9e6a268dd1deae32d3fc823fd3.zip
Merge pull request #6408 from mgugino-upstream-stage/update-readme
Clarify version selection in README
-rw-r--r--README.md21
1 files changed, 14 insertions, 7 deletions
diff --git a/README.md b/README.md
index cc88b60bf..1740504eb 100644
--- a/README.md
+++ b/README.md
@@ -16,20 +16,27 @@ tracked by
[#2720](https://github.com/openshift/openshift-ansible/issues/2720).
## Getting the correct version
+When choosing an openshift release, ensure that the necessary origin packages
+are available in your distribution's repository. By default, openshift-ansible
+will not configure extra repositories for testing or staging packages for
+end users.
-The
+We recommend using a release branch. We maintain stable branches
+corresponding to upstream Origin releases, e.g.: we guarantee an
+openshift-ansible 3.2 release will fully support an origin
+[1.2 release](https://github.com/openshift/openshift-ansible/tree/release-1.2).
+
+The most recent branch will often receive minor feature backports and
+fixes. Older branches will receive only critical fixes.
+
+In addition to the release branches, the master branch
[master branch](https://github.com/openshift/openshift-ansible/tree/master)
tracks our current work **in development** and should be compatible
with the
[Origin master branch](https://github.com/openshift/origin/tree/master)
(code in development).
-In addition to the master branch, we maintain stable branches
-corresponding to upstream Origin releases, e.g.: we guarantee an
-openshift-ansible 3.2 release will fully support an origin
-[1.2 release](https://github.com/openshift/openshift-ansible/tree/release-1.2).
-The most recent branch will often receive minor feature backports and
-fixes. Older branches will receive only critical fixes.
+
**Getting the right openshift-ansible release**