From e2bd4b34ed66803a8c7beb5c260db4ff36516108 Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Thu, 2 Jul 2020 06:44:08 +0200 Subject: [PATCH] Adjust README to template's README. (#601) --- README.md | 80 ++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 50 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 4b63d308f2..504534e601 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,24 @@ +# Community General Collection + [![Run Status](https://api.shippable.com/projects/5e664a167c32620006c9fa50/badge?branch=master)](https://app.shippable.com/github/ansible-collections/community.general/dashboard) [![Codecov](https://img.shields.io/codecov/c/github/ansible-collections/community.general)](https://codecov.io/gh/ansible-collections/community.general) -# Ansible Collection: community.general +This repo contains the `community.general` Ansible Collection. The collection includes many modules and plugins supported by Ansible community which are not part of more specialized community collections. -This repo contains the `community.general` Ansible Collection. +## Tested with Ansible -The collection includes the modules and plugins supported by Ansible community. +Tested with the current Ansible 2.10 release and the current development version of Ansible. +We do not actively test against Ansible 2.9, but the collection should be mostly functional with 2.9 as well. Ansible versions before 2.9.10 are not supported. -## Installation and Usage +## External requirements -### Installing the Collection from Ansible Galaxy +Some modules and plugins require external libraries. Please check the requirements for each plugin or module you use in the documentation to find out which requirements are needed. + +## Included content + +Please check the included content on the [Ansible Galaxy page for this collection](https://galaxy.ansible.com/community/general). + +## Using this collection Before using the General community collection, you need to install the collection with the `ansible-galaxy` CLI: @@ -22,34 +31,19 @@ collections: - name: community.general ``` -## Testing and Development +See [Ansible Using collections](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html) for more details. -If you want to develop new content for this collection or improve what is already here, the easiest way to work on the collection is to clone it into one of the configured [`COLLECTIONS_PATHS`](https://docs.ansible.com/ansible/latest/reference_appendices/config.html#collections-paths), and work on it there. +## Contributing to this collection -You can find more information in the [developer guide for collections](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#contributing-to-collections) +If you want to develop new content for this collection or improve what is already here, the easiest way to work on the collection is to clone it into one of the configured [`COLLECTIONS_PATH`](https://docs.ansible.com/ansible/latest/reference_appendices/config.html#collections-paths), and work on it there. -### Testing with `ansible-test` +You can find more information in the [developer guide for collections](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#contributing-to-collections), and in the [Ansible Community Guide](https://docs.ansible.com/ansible/latest/community/index.html). + +### Running tests See [here](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#testing-collections). -## Release notes - -See [here](https://github.com/ansible-collections/community.general/tree/master/CHANGELOG.rst). - -## Publishing New Version - -Basic instructions without release branches: - -1. Create `changelogs/fragments/.yml` with `release_summary:` section (which must be a string, not a list). -2. Run `antsibull-changelog release --collection-flatmap yes` -3. Make sure `CHANGELOG.rst` and `changelogs/changelog.yaml` are added to git, and the deleted fragments have been removed. -4. Tag the commit with ``. Push changes and tag to the main repository. - -## More Information - -TBD - -## Communication +### Communication We have a dedicated Working Group for Ansible development. @@ -62,8 +56,34 @@ For more information about communities, meetings and agendas see [Community Wiki For more information about [communication](https://docs.ansible.com/ansible/latest/community/communication.html) -## License +### Publishing New Version -GNU General Public License v3.0 or later +Basic instructions without release branches: -See [LICENSE](COPYING) to see the full text. +1. Create `changelogs/fragments/.yml` with `release_summary:` section (which must be a string, not a list). +2. Run `antsibull-changelog release --collection-flatmap yes` +3. Make sure `CHANGELOG.rst` and `changelogs/changelog.yaml` are added to git, and the deleted fragments have been removed. +4. Tag the commit with ``. Push changes and tag to the main repository. + +## Release notes + +See the [changelog](https://github.com/ansible-collections/community.general/blob/master/CHANGELOG.rst). + +## Roadmap + +See [this issue](https://github.com/ansible-collections/community.general/issues/582) for information on releasing, versioning and deprecation. + +In general, we plan to release a major version every six months, and minor versions every two months. Major versions can contain breaking changes, while minor versions only contain new features and bugfixes. + +## More information + +- [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 Community code of conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html) + +## Licensing + +GNU General Public License v3.0 or later. + +See [COPYING](https://www.gnu.org/licenses/gpl-3.0.txt) to see the full text.