From c645b7d732e3dee777e53be0f521d4ceb9be4c09 Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Mon, 5 Oct 2020 08:55:15 +0200 Subject: [PATCH] Add link to ansible docs page for this collection (#114) * Add link to ansible docs page for this collection. * Also mention docs from README. --- README.md | 5 +++++ galaxy.yml | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7a7047d5..907cdc77 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,12 @@ # Ansible Community Crypto Collection + [![Shippable build status](https://api.shippable.com/projects/5e66776ca27f990007073a42/badge?branch=main)](https://app.shippable.com/projects/5e66776ca27f990007073a42) [![Codecov](https://img.shields.io/codecov/c/github/ansible-collections/community.crypto)](https://codecov.io/gh/ansible-collections/community.crypto) Provides modules for [Ansible](https://www.ansible.com/community) for various cryptographic operations. +You can find [documentation for this collection on the Ansible docs site](https://docs.ansible.com/ansible/latest/collections/community/crypto/). + ## Tested with Ansible Tested with both 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. @@ -48,6 +51,8 @@ Most modules require a recent enough version of [the Python cryptography library - get_certificate - luks_device +You can also find a list of all modules with documentation on the [Ansible docs site](https://docs.ansible.com/ansible/latest/collections/community/crypto/). + ## Using this collection Before using the crypto community collection, you need to install the collection with the `ansible-galaxy` CLI: diff --git a/galaxy.yml b/galaxy.yml index bba3e6f8..d334ac49 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -21,7 +21,7 @@ tags: - openssh - pkcs12 repository: https://github.com/ansible-collections/community.crypto -#documentation: https://github.com/ansible-collection-migration/community.crypto/tree/main/docs +documentation: https://docs.ansible.com/ansible/latest/collections/community/crypto/ homepage: https://github.com/ansible-collections/community.crypto issues: https://github.com/ansible-collections/community.crypto/issues build_ignore: