summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 8 insertions, 6 deletions
diff --git a/README.md b/README.md
index 20f571ccc..2bdaefd4c 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,8 @@
-openshift-ansible
-========================
+#openshift-ansible
This repo contains OpenShift Ansible code.
-Setup
------
+##Setup
- Install base dependencies:
- Fedora:
```
@@ -30,10 +28,14 @@ Setup
- [How to build the openshift-ansible rpms](BUILD.md)
- Directory Structure:
- - [cloud.rb](cloud.rb) - light wrapper around Ansible
- [bin/cluster](bin/cluster) - python script to easily create OpenShift 3 clusters
+ - [docs](docs) - Documentation for the project
- [filter_plugins/](filter_plugins) - custom filters used to manipulate data in Ansible
- [inventory/](inventory) - houses Ansible dynamic inventory scripts
- - [lib/](lib) - library components of cloud.rb
- [playbooks/](playbooks) - houses host-type Ansible playbooks (launch, config, destroy, vars)
- [roles/](roles) - shareable Ansible tasks
+
+##Contributing
+
+###Feature Roadmap
+Our Feature Roadmap is available on the OpenShift Origin Infrastructure [Trello board](https://trello.com/b/nbkIrqKa/openshift-origin-infrastructure). All ansible items will be tagged with [installv3].