---
# System prepended metadata

title: Ansible docs roadmap 2023
tags: [Documentation]

---

# Ansible docs roadmap 2023
###### tags: `Documentation`

- Identify key docsite personas
- Advocate for the Diataxis framework for project docs and offer to provide training
    **- implement first on user guide to verify its use and have an example to point other projects to.**
- Open doc.ansible publishing toolchain to community
- Figure out how to support Antsibull better
- CI / CD tooling that increases writing team velocity, preview builds
**- increase community participation in docs**
   - Community doc maintenance events - identify out of date content and then a hackfest
   - Bring down PR and issue backlog for docs.
   - improve completion time for new docs issues to xx days.
- Developer guide restructure similar to user guide
- Remove user guide stubs
- Set up `docs.ansible/project-name` for projects using read the docs for CI/CD.
- Migrate engineering teams from github pages to RTD and provide resources
- Improve the Sphinx Ansible theme, support >=Sphinx6
- Define community colour palette and support cohesive look and feel for project team docs across the Ansible ecosystem
- Figure out Galaxy and Galaxy NG and operations
    - includes removing old Galaxy content or updating it as it's not currently maintained
- Strategize how to include 'small hints' in the ansible/ansible user and dev guides to point readers to other related projects like lint, navigator, rulebook etc etc
    - implement that strategy :-)
- Improve troubleshooting/debugging details for users and developers
- Rework Controller docs with a community-first approach and offer up product-docs to the community

Modernize and improve content navigation on `docs.ansible`

**newly added**
- Update docs build requirements mid-cycle for each ansible-core release (Feb and Aug/Sept).
- Complete archive and redirects of EOL docs.
- monitor accessibility initiative and begin evaluation against docs.ansible.com and other project docsites.
- implement semantic markup before somebody cries
- Move remaining scenario guides to their relative collections (where applicable)
- reduce/remove all docs build warnings and maintain at that level.
- encourage collection owners to implement recent improvements on their collection pages (use of more tabs, etc)
- Revamp the appendix
- run a linkchecker and ..try not to cry
- Improve or replace existing search engine. 
    - determine what if anything we want to do to help other projects with their SEO etc.
- Develop Vale specific to ansible projects to help contributors write the docs.
- Provide docs updates that align with overall community 2023 goals and outreach (aka to align with Greg, Anwesha's proposals etc)
