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.

Sign up for GitHub

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

Jump to bottom

Documentation Checklist - ansible-core 2.12 release #75883

Closed
1 task done
samccann opened this issue Oct 4, 2021 · 3 comments
Closed
1 task done

Documentation Checklist - ansible-core 2.12 release #75883

samccann opened this issue Oct 4, 2021 · 3 comments
Labels
affects_2.12 docs This issue/PR relates to or includes documentation. has_pr This issue has an associated PR. support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
OLD Ansible Documentation

Comments

@samccann
Copy link
Contributor

samccann commented Oct 4, 2021

Summary

Documentation checklist to prepare for and deliver the ansible-core 2.12 release. See followon comment for the full checklist.

Issue Type

Documentation Report

Component Name

docs/docsite/sphinx_conf/ansible_conf.py

Ansible Version

2.12

Configuration

$ ansible-config dump --only-changed
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 Oct 4, 2021

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.12 docs This issue/PR relates to or includes documentation. needs_triage Needs a first human triage before being processed. support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Oct 4, 2021
@samccann
Copy link
Contributor Author

samccann commented Oct 4, 2021 •
edited

Tasks include:

  • remove the release/maintenance page and porting guide pages from the new release when the branch is created and replace with stub page pointing up to the devel versions of these release-independent pages.

  • Review changelogs in stable-2.12 for ansible-core

  • Review ansible-core porting guide and ensure it links to core 2.12 changelogs

  • include ansible-core in Release Status Grid and ensure maintenance/eol releases listed accurately. Include links to changelogs.

  • Add skeleton roadmap for 2.13-core

  • Add skeleton porting guide for 2.13-core

  • Update core_conf.py:

    • Set 'latest_version': '2.12 ', under html_context
    • Update ‘available_versions’ to 2.12, 2.11, 2.10, devel, under ‘html_context’.
    • Merge to devel
    • Backport to stable-2.12, stable-2.11, and stable-2.10
    • Verify Ansible package porting guide and roadmaps are listed under ‘exclude_patterns’.
    • In stable-2.12 - change VERSION (capitalized) from devel to 2.12.

  • publish on release day.

  • Translation docs for core:

Post release:

  • Update the backport instructions to target the new “latest” branch, see Update backport guide to 2.8 #56578
  • Make sure all server-side redirects are updated as necessary - see Adds docs redirects for PR 54554 docsite#11
  • Swiftype updates
    • Update Swiftype Search engine for ansible-core to blacklist the EOL release (e.g. /ansible/2.9/ - but not going eol yet so ignore this step)
    • Kick off a reindex on the swiftype engine

Edited - the following doesn't happen until 2.13:

  • End-of-life the 2.10 docs

@samccann samccann added this to backlog in OLD Ansible Documentation via automation Oct 4, 2021
@samccann samccann moved this from backlog to core-2.12 deliverables in OLD Ansible Documentation Oct 4, 2021
@samccann samccann removed the needs_triage Needs a first human triage before being processed. label Oct 4, 2021
@samccann samccann mentioned this issue Oct 7, 2021
Closed
This was referenced Oct 19, 2021
Merged
Merged
@ansibot ansibot added the has_pr This issue has an associated PR. label Oct 19, 2021
This was referenced Oct 19, 2021
Merged
Merged
This was referenced Nov 1, 2021
Merged
Merged
Merged
Merged
Merged
Merged
Merged
@samccann samccann mentioned this issue Nov 8, 2021
Merged
@samccann
Copy link
Contributor Author

samccann commented Nov 9, 2021

Released and published.

@samccann samccann closed this as completed Nov 9, 2021
@samccann samccann moved this from core-2.12 deliverables to In progress in OLD Ansible Documentation Nov 9, 2021
@samccann samccann moved this from In progress to Done in OLD Ansible Documentation Nov 9, 2021
@ansible ansible locked and limited conversation to collaborators Nov 30, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
affects_2.12 docs This issue/PR relates to or includes documentation. has_pr This issue has an associated PR. support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
No open projects
OLD Ansible Documentation
  
Done
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ansibot @samccann