Skip to content

Commit

Permalink
Attempt to sync README.md docs with community.aws where possible (#937)
Browse files Browse the repository at this point in the history
Attempt to sync README.md docs with community.aws where possible

SUMMARY
Minor drift has occurred between the amazon.aws and community.aws docs. Attempt to re-synchronise where appropriate
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
README.md
ADDITIONAL INFORMATION
See also: ansible-collections/community.aws#1359
Also sneaks in a fix to the PR link for the Python deprecation changelog entry

Reviewed-by: Joseph Torcasso <None>
Reviewed-by: Alina Buzachis <None>
  • Loading branch information
tremble authored Jul 19, 2022
1 parent db63e6a commit c595497
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 6 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ AWS related modules and plugins supported by the Ansible community are in the [c

This collection has been tested against following Ansible versions: **>=2.9.10**.

For collections that support Ansible 2.9, please ensure you update your `network_os` to use the
fully qualified collection name (for example, `cisco.ios.ios`).
Plugins and modules within a collection may be tested with only specific Ansible versions.
A collection may contain metadata that identifies these versions.
PEP440 is the schema used to describe the versions of Ansible.
Expand Down Expand Up @@ -111,6 +109,15 @@ collections:
- name: amazon.aws
```
A specific version of the collection can be installed by using the `version` keyword in the `requirements.yml` file:

```yaml
---
collections:
- name: amazon.aws
version: 3.1.1
```

The python module dependencies are not installed by `ansible-galaxy`. They can
be manually installed using pip:

Expand All @@ -122,7 +129,6 @@ or:

## Using this collection


You can either call modules by their Fully Qualified Collection Namespace (FQCN), such as `amazon.aws.ec2_instance`, or you can call modules by their short name if you list the `amazon.aws` collection in the playbook's `collections` keyword:

```yaml
Expand Down Expand Up @@ -151,11 +157,12 @@ You can either call modules by their Fully Qualified Collection Namespace (FQCN)

## 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 [Amazon AWS collection repository](https://github.com/ansible-collections/amazon.aws). See [Contributing to Ansible-maintained collections](https://docs.ansible.com/ansible/devel/community/contributing_maintained_collections.html#contributing-maintained-collections) for more details.
We welcome community contributions to this collection. If you find problems, please open an issue or create a PR against the [Amazon AWS collection repository](https://github.com/ansible-collections/amazon.aws).
See [Contributing to Ansible-maintained collections](https://docs.ansible.com/ansible/devel/community/contributing_maintained_collections.html#contributing-maintained-collections) for more details.

You can also join us on:

- IRC - the ``#ansible-aws`` [irc.libera.chat](https://libera.chat/) channel
- Libera.Chat IRC - the ``#ansible-aws`` [irc.libera.chat](https://libera.chat/) channel

### More information about contributing

Expand All @@ -176,6 +183,7 @@ You can also join us on:
- [Ansible Collection overview](https://github.com/ansible-collections/overview)
- [Ansible User guide](https://docs.ansible.com/ansible/latest/user_guide/index.html)
- [Ansible Developer guide](https://docs.ansible.com/ansible/latest/dev_guide/index.html)
- [Ansible Collection Developer Guide](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html)
- [Ansible Community code of conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html)

## Licensing
Expand Down
2 changes: 1 addition & 1 deletion changelogs/fragments/python.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ deprecated_features:
(https://aws.amazon.com/blogs/developer/python-support-policy-updates-for-aws-sdks-and-tools/)
support for Python less than 3.7 by this collection has been deprecated and will be removed in a
release after 2023-05-31
(https://github.com/ansible-collections/community.aws/pull/1360).
(https://github.com/ansible-collections/amazon.aws/pull/935).

0 comments on commit c595497

Please sign in to comment.