Collection module documentation available now on docs.ansible.com for review
After significant months of effort, we have now restored the module-level documentation on docs.ansible.com! This effort required coordination between the Ansible docs team and the community team and developers to pull the module documentation from the collections on Galaxy and publish them on our docsite again. While there’s more work to do, we’d like all collection maintainers to take a look at your respective collections and let us know where you see problems:
- Go to https://docs.ansible.com/ansible/2.10/collections/index.html
- Verify your collection module and plugin documentation looks valid.
- See https://github.com/ansible-community/antsibull/issues for a list of known issues and enhancements we are already tracking. Before you open an issue, please drop into the #ansible-docs IRC channel to discuss/troubleshoot any problems you are seeing.
Known issues and Important Caveats
- The documentation reflect the version of each collection that is in the current Ansible 2.10 Alpha. We will update after each alpha release to pick up whatever collection version is in that release.
- On 2.10 official release, the documentation will stay fixed at the collection version in that release. We will not be able to update until the next Ansible release (2.10.1 for example).
- Boolean default is showing 0. This is fixed and will be updated in the docs soon.
- community.general module docs are not present yet. This should be fixed soon as well.