summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Gugino <mgugino@redhat.com>2017-12-08 14:13:32 -0500
committerMichael Gugino <mgugino@redhat.com>2017-12-08 14:13:32 -0500
commit7503aa2775fc28a6611d1b3ef12c78549927122c (patch)
treefd9f40c002954f82a8d6be778327ff007a5e878e
parent091acb2cd3d0ab2a6019d9e96a22e6fed1c0ca9a (diff)
downloadopenshift-7503aa2775fc28a6611d1b3ef12c78549927122c.tar.gz
openshift-7503aa2775fc28a6611d1b3ef12c78549927122c.tar.bz2
openshift-7503aa2775fc28a6611d1b3ef12c78549927122c.tar.xz
openshift-7503aa2775fc28a6611d1b3ef12c78549927122c.zip
Clarify version selection in README
This commit helps usher users into selecting the correct release for them.
-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**