diff options
author | Rodolfo Carvalho <rhcarvalho@gmail.com> | 2017-04-24 15:36:39 +0200 |
---|---|---|
committer | Rodolfo Carvalho <rhcarvalho@gmail.com> | 2017-04-27 11:54:12 +0200 |
commit | 9fd022f65d1df98f50c8bcc445c63d026f8d87b8 (patch) | |
tree | 4dc17968667db2d2b6e490988ebccaf643e17b58 /CONTRIBUTING.md | |
parent | 8734fb6a7e9ceba9f78a8d435bf06459582aed05 (diff) | |
download | openshift-9fd022f65d1df98f50c8bcc445c63d026f8d87b8.tar.gz openshift-9fd022f65d1df98f50c8bcc445c63d026f8d87b8.tar.bz2 openshift-9fd022f65d1df98f50c8bcc445c63d026f8d87b8.tar.xz openshift-9fd022f65d1df98f50c8bcc445c63d026f8d87b8.zip |
Move repo structure to a separate document
Reduces the clutter in CONTRIBUTING.md.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 56 |
1 files changed, 1 insertions, 55 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9be34bcab..95bca6a2d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,61 +10,7 @@ Before submitting code changes, get familiarized with these documents: - [Core Concepts](https://github.com/openshift/openshift-ansible/blob/master/docs/core_concepts_guide.adoc) - [Best Practices Guide](https://github.com/openshift/openshift-ansible/blob/master/docs/best_practices_guide.adoc) - [Style Guide](https://github.com/openshift/openshift-ansible/blob/master/docs/style_guide.adoc) - -## Repository structure - -### Ansible - -``` -. -├── inventory Contains dynamic inventory scripts, and examples of -│ Ansible inventories. -├── library Contains Python modules used by the playbooks. -├── playbooks Contains Ansible playbooks targeting multiple use cases. -└── roles Contains Ansible roles, units of shared behavior among - playbooks. -``` - -#### Ansible plugins - -These are plugins used in playbooks and roles: - -``` -. -├── ansible-profile -├── callback_plugins -├── filter_plugins -└── lookup_plugins -``` - -### Scripts - -``` -. -├── bin [DEPRECATED] Contains the `bin/cluster` script, a -│ wrapper around the Ansible playbooks that ensures proper -│ configuration, and facilitates installing, updating, -│ destroying and configuring OpenShift clusters. -│ Note: this tool is kept in the repository for legacy -│ reasons and will be removed at some point. -└── utils Contains the `atomic-openshift-installer` command, an - interactive CLI utility to install OpenShift across a - set of hosts. -``` - -### Documentation - -``` -. -└── docs Contains documentation for this repository. -``` - -### Tests - -``` -. -└── test Contains tests. -``` +- [Repository Structure](docs/repo_structure.md) ## Running tests |