internet/kubernetes.core
3
0
Fork 0
mirror of https://github.com/ansible-collections/kubernetes.core.git synced 2026-03-26 21:33:02 +00:00
Code Issues Projects Releases Wiki Activity

Add docs for doc autogeneration (#98)

Browse Source 
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
This commit is contained in:
Abhijeet Kasurde
2021-05-21 10:49:01 +05:30
committed by GitHub
parent 2d6a120032
commit f9ee1f05b8
1 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
CONTRIBUTING.md
View File

@@ -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 /<PATH_OF_COLLECTION>/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