Update README (#7)

* modified:   README.md

* docs: change or remove controller specific documentation

---------

Co-authored-by: Brennan Paciorek <[email protected]>

README.md

@@ -1,3 +1,159 @@
-# Ansible Collection - infra.platform_configuration
+# Red Hat Communities of Practice infra.platform_configuration
 
-Documentation for the collection.
+![pre-commit tests](https://github.com/redhat-cop/infra.platform_configuration/actions/workflows/pre-commit.yml/badge.svg)
+![Release](https://github.com/redhat-cop/infra.platform_configuration/actions/workflows/release.yml/badge.svg)
+<!-- Further CI badges go here as above -->
+
+This Ansible collection allows for easy interaction with Ansible Automation Platform via Ansible roles using the Ansible Automation Platform modules.
+
+## Getting Help
+
+We are on the Ansible Forums and Matrix, if you want to discuss something, ask for help, or participate in the community, please use the #infra-config-as-code tag on the form, or post to the chat in Matrix.
+
+[Ansible Forums](https://forum.ansible.com/tag/infra-config-as-code)
+
+[Matrix Chat Room](https://matrix.to/#/#aap_config_as_code:ansible.com)
+
+## Requirements
+
+The ansible.platform collections MUST be installed in order for this collection to work. It is recommended they be invoked in the playbook in the following way.
+
+```yaml
+---
+- name: Playbook to configure ansible platform post installation
+  hosts: localhost
+  connection: local
+  vars:
+    gateway_validate_certs: true
+  collections:
+    - ansible.platform
+```
+
+## Links to Ansible Automation Platform Collections
+
+|                                      Collection Name                                         |                 Purpose                  |
+|:--------------------------------------------------------------------------------------------:|:----------------------------------------:|
+| [awx.awx/Ansible.controller repo](https://github.com/ansible/awx/tree/devel/awx_collection) |   Automation controller modules          |
+|        [Ansible Hub Configuration](https://github.com/ansible/automation_hub_collection)     |       Automation hub configuration       |
+
+## Links to other Validated Configuration Collections for Ansible Automation Platform
+
+|                                      Collection Name                                       |                 Purpose                  |
+|:------------------------------------------------------------------------------------------:|:----------------------------------------:|
+| [Controller Configuration](https://github.com/redhat-cop/controller_configuration) |   Automation controller configuration    |
+|   [AAP Platform Configuration](https://github.com/redhat-cop/infra.platform_configuration)   |  Configuration for platform wide configurations  |
+|             [EE Utilities](https://github.com/redhat-cop/ee_utilities)             | Execution Environment creation utilities |
+|     [AAP installation Utilities](https://github.com/redhat-cop/aap_utilities)      |  Ansible Automation Platform Utilities   |
+|   [AAP Configuration Template](https://github.com/redhat-cop/aap_configuration_template)   |  Configuration Template for this suite   |
+
+
+
+## Included content
+
+Click the `Content` button to see the list of content included in this collection.
+
+## Installing this collection
+
+You can install the infra.platform_configuration.collection with the Ansible Galaxy CLI:
+
+```console
+ansible-galaxy collection install infra.platform_configuration
+```
+
+You can also include it in a `requirements.yml` file and install it with `ansible-galaxy collection install -r requirements.yml`, using the format:
+
+```yaml
+---
+collections:
+  - name: infra.platform_configuration
+    # If you need a specific version of the collection, you can specify like this:
+    # version: ...
+```
+
+## Conversion from tower_configuration
+
+If you were using a version of redhat_cop.tower_configuration, please refer to our Conversion Guide here: [Conversion Guide](docs/CONVERSION_GUIDE.md)
+
+## Using this collection
+
+The ansible.platform collection must be invoked in the playbook in order for Ansible to pick up the correct modules to use.
+
+The following command will invoke the collection playbook. This is considered a starting point for the collection.
+
+```console
+ansible-playbook infra.platform_configuration.configure_platform.yml
+```
+
+Otherwise it will look for the modules only in your base installation. If there are errors complaining about "couldn't resolve module/action" this is the most likely cause.
+
+```yaml
+- name: Playbook to configure ansible platform post installation
+  hosts: localhost
+  connection: local
+  vars:
+    gateway_validate_certs: true
+  collections:
+    - ansible.platform
+```
+
+Define following vars here, or in `platform_configs/platform_auth.yml`
+`gateway_hostname: ansible-platform-web-svc-test-project.example.com`
+
+You can also specify authentication by a combination of either:
+
+- `gateway_hostname`, `gateway_username`, `gateway_password`
+- `gateway_hostname`, `gateway_oauthtoken`
+
+The OAuth2 token is the preferred method. You can obtain the token through the preferred `ansible.platform.token` module, or by creating one
+via the AAP browser interface.
+
+Gateway token module would be invoked with this code:
+
+```yaml
+    - name: Create a new token using platform username/password
+      ansible.platform.token:
+        description: 'Creating token to test platform jobs'
+        scope: "write"
+        state: present
+        gateway_host: "{{ gateway_hostname }}"
+        gateway_username: "{{ gateway_username }}"
+        gateway_password: "{{ gateway_password }}"
+
+```
+
+### See Also
+
+- [Ansible Using collections](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html) for more details.
+
+## Release and Upgrade Notes
+
+For details on changes between versions, please see [the changelog for this collection](CHANGELOG.rst).
+
+## Releasing, Versioning and Deprecation
+
+This collection follows [Semantic Versioning](https://semver.org/). More details on versioning can be found [in the Ansible docs](https://docs.ansible.com/ansible/latest/dev_guide/developing_collections.html#collection-versions).
+
+We plan to regularly release new minor or bugfix versions once new features or bugfixes have been implemented.
+
+Releasing the current major version happens from the `main` branch.
+
+## Roadmap
+
+Adding the ability to use direct output from the awx export command in the roles along with the current data model.
+
+## Contributing to this collection
+
+We welcome community contributions to this collection. If you find problems, please open an issue or create a PR against the [infra.platform_configuration collection repository](https://github.com/redhat-cop/infra.platform_configuration).
+More information about contributing can be found in our [Contribution Guidelines.](https://github.com/redhat-cop/infra.platform_configuration/blob/devel/.github/CONTRIBUTING.md)
+
+## Code of Conduct
+
+This collection follows the Ansible project's
+[Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html).
+Please read and familiarize yourself with this document.
+
+## Licensing
+
+GNU General Public License v3.0 or later.
+
+See [LICENSE](LICENSE) to see the full text.