From f9ee1f05b8cd91260c553e0c2fb0c75671732970 Mon Sep 17 00:00:00 2001 From: Abhijeet Kasurde Date: Fri, 21 May 2021 10:49:01 +0530 Subject: [PATCH] Add docs for doc autogeneration (#98) Signed-off-by: Abhijeet Kasurde --- CONTRIBUTING.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ed93b78c..c1d08f4d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -50,6 +50,21 @@ For general information on running the integration tests see the [Integration Tests page of the Module Development Guide](https://docs.ansible.com/ansible/devel/dev_guide/testing_integration.html#testing-integration), especially the section on configuration for cloud tests. For questions about writing tests the Ansible Kubernetes community can be found on Freenode IRC as detailed below. +### Updating documentation + +Modules and plugins documentation is autogenerated using ``collection_prep_add_docs`` command from [collection_prep](https://github.com/ansible-network/collection_prep) package. + +You can install ``collection_prep`` using + + # git clone https://github.com/ansible-network/collection_prep + # cd collection_prep + # pip install . + +After installation, you can update documentation + + # collection_prep_add_docs -p //kubernetes/core + +Review the changes and create a pull request using updated files. ### Code of Conduct The `kubernetes.core` collection follows the Ansible project's