summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRodolfo Carvalho <rhcarvalho@gmail.com>2016-11-04 13:52:32 +0100
committerRodolfo Carvalho <rhcarvalho@gmail.com>2016-11-08 14:19:14 +0100
commitac42a0bb8c873ec95c9b99972fefec95127cd49b (patch)
tree986821cb8a792bbf092dcad1a2708148baf817af
parent68aad3986f698cbe1385b65b8802063a614d8530 (diff)
downloadopenshift-ac42a0bb8c873ec95c9b99972fefec95127cd49b.tar.gz
openshift-ac42a0bb8c873ec95c9b99972fefec95127cd49b.tar.bz2
openshift-ac42a0bb8c873ec95c9b99972fefec95127cd49b.tar.xz
openshift-ac42a0bb8c873ec95c9b99972fefec95127cd49b.zip
README: improve markdown formatting
-rw-r--r--README.md19
1 files changed, 11 insertions, 8 deletions
diff --git a/README.md b/README.md
index c3d78f5fe..b4c801a8d 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,13 @@
[![Join the chat at https://gitter.im/openshift/openshift-ansible](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/openshift/openshift-ansible)
-#OpenShift Ansible
+# OpenShift Ansible
This repo contains Ansible code for OpenShift. This repo and the origin RPMs
that it installs currently require a package that provides `docker`. Currently
the RPMs provided from dockerproject.org do not provide this requirement, though
they may in the future.
-##Branches and tags
+## Branches and tags
The master branch tracks our current work and should be compatible with both
Origin master branch and the most recent Origin stable release. Currently that's
@@ -20,22 +20,24 @@ Releases are tagged periodically from active branches and are versioned 3.x
corresponding to Origin releases 1.x. We unfortunately started with 3.0 and it's
not practical to start over at 1.0.
-##Setup
+## Setup
+
- Install base dependencies:
- Requirements:
- Ansible >= 2.1.0 though 2.2 is preferred for performance reasons.
- Jinja >= 2.7
- Fedora:
- ```
+ ```
dnf install -y ansible-2.1.0.0 pyOpenSSL python-cryptography
- ```
+ ```
- OSX:
- ```
+ ```
# Install ansible 2.1.0.0 and python 2
brew install ansible python
- ```
+ ```
+
- Setup for a specific cloud:
- [AWS](http://github.com/openshift/openshift-ansible/blob/master/README_AWS.md)
- [GCE](http://github.com/openshift/openshift-ansible/blob/master/README_GCE.md)
@@ -57,7 +59,8 @@ not practical to start over at 1.0.
- [playbooks/](https://github.com/openshift/openshift-ansible/tree/master/playbooks) - houses host-type Ansible playbooks (launch, config, destroy, vars)
- [roles/](https://github.com/openshift/openshift-ansible/tree/master/roles) - shareable Ansible tasks
-##Contributing
+## Contributing
+
- [Best Practices Guide](https://github.com/openshift/openshift-ansible/blob/master/docs/best_practices_guide.adoc)
- [Core Concepts](https://github.com/openshift/openshift-ansible/blob/master/docs/core_concepts_guide.adoc)
- [Style Guide](https://github.com/openshift/openshift-ansible/blob/master/docs/style_guide.adoc)