Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation Release checklist for Ansible 7 #79378

Closed
1 task done
samccann opened this issue Nov 14, 2022 · 2 comments · Fixed by #79555
Closed
1 task done

Documentation Release checklist for Ansible 7 #79378

samccann opened this issue Nov 14, 2022 · 2 comments · Fixed by #79555
Labels
affects_2.14 docs This issue/PR relates to or includes documentation. has_pr This issue has an associated PR.

Comments

@samccann
Copy link
Contributor

Summary

Release checklist for Ansible 7 documentation. See followon comment for full list.

Issue Type

Documentation Report

Component Name

docs/docsite/rst/index.rst

Ansible Version

$ ansible --version
2.14

Configuration

# if using a version older than ansible-core 2.12 you should omit the '-t all'
$ ansible-config dump --only-changed -t all
none

OS / Environment

none

Additional Information

none

Code of Conduct

  • I agree to follow the Ansible Code of Conduct
@ansibot
Copy link
Contributor

ansibot commented Nov 14, 2022

Files identified in the description:

If these files are incorrect, please update the component name section of the description or use the !component bot command.

click here for bot help

@ansibot ansibot added affects_2.14 docs This issue/PR relates to or includes documentation. needs_triage Needs a first human triage before being processed. labels Nov 14, 2022
@samccann
Copy link
Contributor Author

samccann commented Nov 14, 2022

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

Pre-release tasks:

  • Stage the release docs on test when RC is available.
  • Update the Release Status grid on the Release and Maintenance page in devel to link in changelogs and mark Ansible 6 as EO after 6.7, and add Ansible 8 as in development.
  • backport to stable-2.14
  • Verify that the Ansible 7 porting guide has a link to the Ansible 7 changelog file in gitub.
  • 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 - see [Merge after Ansible 7 GA] User Guide Redirects docsite#110
  • update ansible_conf.py:
    • Set 'latest_version': '7 ', under html_context
    • Verify core porting guide and roadmaps are listed under ‘exclude_patterns’.
    • Merge to devel on release day only
    • Backport to stable-2.14
    • In stable-2.14 - change VERSION (capitalized) from devel to 7.
  • Update the build and docsite (internal RH tasks):
    • Publish 7 on release day. Then immediately:
    • Update the 2.9 <--> 7 redirects on the docsite repo by copying an existing .htaccess file in a release subdirectory to a new subdirectory (for example, mkdir ansible/7/ && cp ansible/6/.htaccess ansible/7/.htaccess) and republish the docsite. - do we need to keep doing this now since 2.9 is EOL thus not on version switcher?

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 8).
  • update intersphinx links. see update intersphinx links for Ansible 3 #74246 - do we need any changes to this given we have two docsites now???
    • backport to stable-2.14 and republish
  • EOL Ansible 6 docs - set is_eol to True in html_context to remove version switcher and add EOL banner after final Ansible 6.7.0 release. See EOL Ansible 5 #78127
  • Swiftype updates:

@bcoca bcoca removed the needs_triage Needs a first human triage before being processed. label Nov 15, 2022
oraNod added a commit to oraNod/ansible that referenced this issue Nov 17, 2022
oraNod added a commit to oraNod/ansible that referenced this issue Nov 17, 2022
@ansibot ansibot added the has_pr This issue has an associated PR. label Nov 17, 2022
oraNod added a commit to oraNod/ansible that referenced this issue Nov 17, 2022
oraNod added a commit to oraNod/ansible that referenced this issue Nov 18, 2022
samccann pushed a commit to samccann/ansible that referenced this issue Nov 22, 2022
nitzmahone pushed a commit that referenced this issue Nov 22, 2022
(cherry picked from commit e5399c9)

Co-authored-by: Don Naro <dnaro@redhat.com>
@oraNod oraNod mentioned this issue Dec 7, 2022
@ansible ansible locked and limited conversation to collaborators Feb 2, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
affects_2.14 docs This issue/PR relates to or includes documentation. has_pr This issue has an associated PR.
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants