From eb5d48c0d8d49a06dd4462328ab872c82a376601 Mon Sep 17 00:00:00 2001 From: Sebastian Gumprich Date: Sun, 30 May 2021 13:40:35 +0200 Subject: [PATCH 1/3] add info about documentation --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 1b780bf3..d6438619 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,19 @@ collections: - t_systems_mms.icinga_director ``` +## Documentation + +To see the documentation for the module `icinga_host` run the following command on the cli: + +``` +ansible-doc t_systems_mms.icinga_director.icinga_host +``` + +You can also find the complete documentation for the modules on the Ansible documentation: + +[https://docs.ansible.com/ansible/latest/collections/t_systems_mms/icinga_director/index.html#plugins-in-t-systems-mms-icinga-director]() + + ## Examples using the modules See the `examples` directory for a complete list of examples. From 5f75cedd135ca05b4f6e75af11a9f5aa27d19c2d Mon Sep 17 00:00:00 2001 From: Sebastian Gumprich Date: Fri, 4 Jun 2021 09:16:16 +0200 Subject: [PATCH 2/3] Update README.md Co-authored-by: schurzi --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d6438619..caf63222 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,10 @@ collections: ## Documentation -To see the documentation for the module `icinga_host` run the following command on the cli: +Our modules include documentation. +To display it you can use the `ansible-doc` command. + +For example, to see the documentation for the module `icinga_host` run the following command on the cli: ``` ansible-doc t_systems_mms.icinga_director.icinga_host From 9ef4b68e6469372ecec53a6eeaaebd763257cdb9 Mon Sep 17 00:00:00 2001 From: Sebastian Gumprich Date: Fri, 4 Jun 2021 09:16:48 +0200 Subject: [PATCH 3/3] Update README.md Co-authored-by: schurzi --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index caf63222..1942cd35 100644 --- a/README.md +++ b/README.md @@ -61,7 +61,7 @@ ansible-doc t_systems_mms.icinga_director.icinga_host You can also find the complete documentation for the modules on the Ansible documentation: -[https://docs.ansible.com/ansible/latest/collections/t_systems_mms/icinga_director/index.html#plugins-in-t-systems-mms-icinga-director]() + ## Examples using the modules