Ansible community documentation priorities

[samccann]

Summary

This topic lists the priorities that we'll focus on for community Ansible documentation. We welcome your feedback on this to ensure we are focusing efforts where needed.

Priorities

This lists the high-level priorities in order for Ansible Community documentation (ansible-core and the Ansible package). (Note: 1, 2, and portions of 3 are the focus for 2022)

• 1. Migrate community-docs - port collection contributor guides from external repo so we can publish to docs.ansible.com. 
• 2. Update user getting started guide - improve the documentation that new users access first to provide a smoother onboarding experience.
• 3. Improve findability of our top guides and pages (user guide, Install guide, community guides).
• 4. Improve readability of top pages
• 5. Track GalaxyNG collection docs priorities - AH supports md for collection docs but the community uses RST. Need to ensure all per-collection documentation is visible in GalaxyNG.
• 6. Bring down PR docs-only backlog -
• 7. Bring down docs issues backlog - Prioritize those top 10 pages by website visits.
• 8. Search improvements - Current embedded search experience is subpar.
• 9. Improve our external search engine results (google etc) as that accounts for 90% of our referrer traffic.
• 10. Migrate collection developer guidelines - Some still exist in other repositories and should be ported and published to docs.ansible.com

Revamp documentation entry points based on persona - Currently our community documentation is not aligned with personas (from the community or enterprise perspective). This complicates the reader journey.

[samccann]

Items that have come up that are not on the priority list:

• unversioning docs - community guides, porting guides, release/maint pages aren't tied to a version. It's questionable whether developer guide is tied to a version since all code changes must go into devel.
• Archiving docs - creating a separate docsite to move EOL docs to that help our Search results.

[samccann]

#1 and #2 above are done!

[samccann]

Status update:
#5 is out of scope but internal issue created to track it.
#6 - pr queue at manageable level.
#9 is in process (archiving old EOL docs to remove from google search results).

[samccann]

2023 potential additional priorities:

1. Accessibility
2. Including other docs on docs.ansible.com for other Ansible projects.