--- # How this works: https://hackmd.io/s/how-to-create-slide-deck Title: Ansible Community Docs Update type: slide slideOptions: transition: slide --- ## Ansible Community Documentation Update #### Ansible Contributor Summit, April 2022 --- ## What's been happening in docsland lately? * Simplified module/plugin tables * Installation guide update * Collection contributor docs * Edit on GitHub is back! --- ### Slimmed down module/plugin tables * Changed cumbersome raw HTML to rst * Automatically adjusts to list for smaller screens * simplified view ---- ![](https://i.imgur.com/hGqUmq7.png) ![](https://i.imgur.com/XKf4Dl6.png) --- ### Installation guide update * Trimmed down to focus on [`pip install`](https://docs.ansible.com/ansible/devel/installation_guide/intro_installation.html) * Optional secondary page for a curated set of other install options * See it [here](https://docs.ansible.com/ansible/devel/installation_guide/intro_installation.html) and the [discussion topic](https://github.com/ansible-community/community-topics/issues/83) for details --- ### Collection contributor docs updates * Adds information on: * Creating your first PR * Testing collections * Becoming a maintainer * Explaining the Steering Committee ![](https://i.imgur.com/UmXCq4H.png) ---- ### Collection contributor docs updates ![](https://i.imgur.com/NIAysVz.png) --- ## Edit on Github is back! * opt-in by each collection owner * Add a [docs/docsite/links.yml](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections_structure.html#docs-directory) to your collection ![](https://i.imgur.com/LKHGAdQ.png) ---- ### More links per collection ![](https://i.imgur.com/w9hABXe.png) ---- ### docs/docsite/links.yml ![](https://i.imgur.com/3VvO5zo.png) --- ## Where are we going next? * [Community docs priorities](https://github.com/ansible-community/community-topics/issues/81) for the next 2 years * [Archiving EOL docs](https://github.com/ansible-community/community-topics/issues/78) to remove them from search results * [~~Semantic markup~~](https://github.com/ansible-community/community-topics/issues/53) - on hold. ---- ### Documentation Priorities * Deeper details for collection contributors * Better getting started guides * Improve findability and search results ---- ### Archiving EOL Docs * Moving doc versions to a new docs.ansible.com/archive * Keeps the docs available for those using older releases * Removes these old releases from google results etc --- ## How to join us! * [DaWGs](https://github.com/ansible/community/issues/643) (Documentation working group) - meets on Tuesdays 15:00 UTC on matrix/irc docs channels * [Issues](https://github.com/ansible/ansible/issues?q=is%3Aopen+is%3Aissue+label%3Adocs) including [easyfix](https://github.com/ansible/ansible/issues?q=is%3Aopen+is%3Aissue+label%3Adocs+label%3Aeasyfix) - PRs welcome! * [PRs](https://github.com/ansible/ansible/pulls?q=is%3Aopen+is%3Apr+label%3Adocs) - reviews always welcome --- ## Thanks! ![](https://i.imgur.com/8Om2EAI.png)