Documentation Checklist: Ansible 11 release

[samccann]

Release checklist for Ansible 11 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:

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

In stable-2.18 branch:

• update conf.py VERSION to '11' if tags.has('ansible') or tags.has('all') else'

Update the build and docsite (internal RH tasks):

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

Post release:

• 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 12). See https://gitlab.cee.redhat.com/aap-ci/aap-jenkins-shared-library/-/merge_requests/1634
• update intersphinx links. see add support for Ansible 9 intersphinx links #878
  • backport to stable-2.18 and republish
• If we eol Ansible 9 - 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.13.0 release. See EOL Ansible 5 ansible#78127
• In stable 2.17 - EOL Ansible 10 docs - set is_eol to True in html_context to remove version switcher and add EOL banner after final Ansible 10.7.0 release.
• Swiftype updates (internal to RH):
  • update sitemaps for Ansible (not controller anymore) - see update Ansible sitemaps docsite#175
  • Update Swiftype Search engine for ansible to blacklist the EOL release (e.g. /ansible/9/ and /ansible/10 if both EOL)
  • Kick off a reindex on the swiftype engine