Documentation Checklist: Ansible 10 release

[samccann]

trafficstars

Release checklist for Ansible 10 documentation. See follow on comment for full list.

[samccann]

Update the documentation and publish the 9 version of Ansible documentation. Tasks include:

Pre-release tasks:

• [x] Stage the release docs on test when beta is available.
• [x] Update the Release Status grid on the Release and Maintenance page in devel to link in changelogs ~~and mark Ansible 9 as EOL after 9.7(?)~~, update Ansible 9 longer lifecycle, and add Ansible 11 as in development.
• [x] backport to stable-2.17 and stable 2.16
• [x] Verify that the Ansible 10 porting guide has a link to the Ansible 10 changelog file in gitub.
• [x] Build docs and validate new collections docs after they are added to https://github.com/ansible-community/ansible-build-data
• [x] Verify that release/main page and porting pages are kept in sync between latest and devel
• [x] Make sure all server-side redirects are updated as necessary
• [x] update conf.py:
  • [x] Set 'latest_version', under html_context as follows: '10' if tags.has('ansible')
  • [x] Update version switcher to support Ansible 9 as well as devel and latest
  • [x] Verify core porting guide and roadmaps are listed under ‘exclude_patterns’.
  • [x] Merge to devel on release day only
  • [x] Backport to stable-2.17 and stable-2.16

In stable-2.17 branch:

• [x] update conf.py VERSION to '10' if tags.has('ansible') or tags.has('all') else'

Update the build and docsite (internal RH tasks):

• [x] Publish 10 on release day. ~Then immediately:~
• [x] Update the 2.9 <--> 10 redirects on the docsite repo by ~~renaming the ansible/9 directory to ansible/10~~ copying ansible/9 to ansible/10 and republish the docsite.

Post release:

• [x] Update the Build_Ansible_Package_Docs publication jenkins job - Configure and add an option for the next release number to the choices available for PACKAGE_VERSION. (aka add 11). See https://gitlab.cee.redhat.com/aap-ci/aap-jenkins-shared-library/-/merge_requests/1634
• [x] update intersphinx links. see https://github.com/ansible/ansible-documentation/pull/878
  • [ ] backport to stable-2.17 and republish
• [x] ~~In stable-2.16, EOL Ansible 9 docs - set is_eol to True in html_context to remove version switcher and add EOL banner after final Ansible 9.7.0 release. See https://github.com/ansible/ansible/pull/78127~~ Not until Ansible 11
• [x] Swiftype updates (internal to RH):
  • [x] update sitemaps for Ansible (not controller anymore) - see https://github.com/ansible/docsite/pull/175
  • [x] Update Swiftype Search engine for ansible to blacklist the EOL release (e.g. /ansible/9/)
  • [ ] Kick off a reindex on the swiftype engine

[samccann]

Note we verified the redirects 2.9 --> current are necesssary to avoid 404 for all old blogs etc. See https://github.com/ansible/ansible-documentation/issues/428#issuecomment-1813306406 for details