From 3f1c93cccf72a3ab28f2f97e259f199c7e715c96 Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Fri, 2 Oct 2020 06:49:43 +0200 Subject: [PATCH] Add link to ansible docs page for this collection (#1022) * Add link to ansible docs page for this collection. * Also mention docs from README. --- README.md | 7 +++++-- galaxy.yml | 2 +- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0f823d8dd2..af708eba81 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,12 @@ # Community General Collection -[![Run Status](https://api.shippable.com/projects/5e664a167c32620006c9fa50/badge?branch=main)](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) +[![Run Status](https://api.shippable.com/projects/5e664a167c32620006c9fa50/badge?branch=main)](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) 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. +You can find [documentation for this collection on the Ansible docs site](https://docs.ansible.com/ansible/latest/collections/community/general/). + ## Tested with Ansible Tested with the current Ansible 2.9 and 2.10 releases and the current development version of Ansible. Ansible versions before 2.9.10 are not supported. @@ -14,7 +17,7 @@ Some modules and plugins require external libraries. Please check the requiremen ## Included content -Please check the included content on the [Ansible Galaxy page for this collection](https://galaxy.ansible.com/community/general). +Please check the included content on the [Ansible Galaxy page for this collection](https://galaxy.ansible.com/community/general) or the [documentation on the Ansible docs site](https://docs.ansible.com/ansible/latest/collections/community/general/). ## Using this collection diff --git a/galaxy.yml b/galaxy.yml index c9ff6d2fc9..e435dc9414 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -14,7 +14,7 @@ dependencies: community.kubernetes: '>=1.0.0' google.cloud: '>=1.0.0' repository: https://github.com/ansible-collections/community.general -#documentation: https://github.com/ansible-collection-migration/community.general/tree/main/docs +documentation: https://docs.ansible.com/ansible/latest/collections/community/general/ homepage: https://github.com/ansible-collections/community.general issues: https://github.com/ansible-collections/community.general/issues #type: flatmap