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

[Doc-Release-2.9] Backport/2.7/docs release #64272

Merged
merged 2 commits into from
Nov 1, 2019
Merged

[Doc-Release-2.9] Backport/2.7/docs release #64272

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
909c7d7
docs: update to latest 3 versions (#64109)
samccann Nov 1, 2019
6a8e7a1
[Doc-Release-2.9] update release and maintenance page for 2.9 (#64166)
samccann Nov 1, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/docsite/rst/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,9 +140,11 @@
'github_version': 'devel/docs/docsite/rst/',
'github_module_version': 'devel/lib/ansible/modules/',
'current_version': version,
'latest_version': '2.8',
'latest_version': '2.9',
# list specifically out of order to make latest work
'available_versions': ('latest', '2.7', '2.6', 'devel')
'available_versions': ('latest', '2.8', '2.7', 'devel'),
'css_files': ('_static/ansible.css', # overrides to the standard theme
),
}

# The style sheet to use for HTML and HTML Help pages. A file of that name
Expand Down
38 changes: 14 additions & 24 deletions docs/docsite/rst/reference_appendices/release_and_maintenance.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Release and maintenance
Release cycle
`````````````

Ansible is developed and released on a flexible 4 months release cycle.
Ansible is developed and released on a flexible six month release cycle.
This cycle can be extended in order to allow for larger changes to be properly
implemented and tested before a new release is made available.

Expand Down Expand Up @@ -39,18 +39,13 @@ This table links to the release notes for each major release. These release note
============================== =================================================
Ansible Release Status
============================== =================================================
devel In development (2.9 unreleased, trunk)
`2.8 Release Notes`_ Supported (security **and** general bug fixes)
`2.7 Release Notes`_ Supported (security **and** critical bug fixes)
`2.6 Release Notes`_ Supported (security fixes)
`2.5 Release Notes`_ Unsupported (end of life)
`2.4 Release Notes`_ Unsupported (end of life)
`2.3 Release Notes`_ Unsupported (end of life)
`2.2 Release Notes`_ Unsupported (end of life)
`2.1 Release Notes`_ Unsupported (end of life)
`2.0 Release Notes`_ Unsupported (end of life)
`1.9 Release Notes`_ Unsupported (end of life)
<1.9 Unsupported (end of life)
devel In development (2.10 unreleased, trunk)
`2.9 Release Notes`_ Maintained (security **and** general bug fixes)
`2.8 Release Notes`_ Maintained (security **and** critical bug fixes)
`2.7 Release Notes`_ Maintained (security fixes)
`2.6 Release Notes`_ Unmaintained (end of life)
`2.5 Release Notes`_ Unmaintained (end of life)
<2.5 Unmaintained (end of life)
============================== =================================================

You can download the releases from `<https://releases.ansible.com/ansible/>`_.
Expand All @@ -61,19 +56,14 @@ You can download the releases from `<https://releases.ansible.com/ansible/>`_.

.. Comment: devel used to point here but we're currently revamping our changelog process and have no
link to a static changelog for devel _2.6: https://github.com/ansible/ansible/blob/devel/CHANGELOG.md
.. _2.9 Release Notes:
.. _2.9: https://github.com/ansible/ansible/blob/stable-2.9/changelogs/CHANGELOG-v2.9.rst
.. _2.8 Release Notes:
.. _2.8: https://github.com/ansible/ansible/blob/stable-2.8/changelogs/CHANGELOG-v2.8.rst
.. _2.7 Release Notes: https://github.com/ansible/ansible/blob/stable-2.7/changelogs/CHANGELOG-v2.7.rst
.. _2.6 Release Notes:
.. _2.6: https://github.com/ansible/ansible/blob/stable-2.6/changelogs/CHANGELOG-v2.6.rst
.. _2.5 Release Notes: https://github.com/ansible/ansible/blob/stable-2.5/changelogs/CHANGELOG-v2.5.rst
.. _2.4 Release Notes:
.. _2.4: https://github.com/ansible/ansible/blob/stable-2.4/CHANGELOG.md
.. _2.3 Release Notes: https://github.com/ansible/ansible/blob/stable-2.3/CHANGELOG.md
.. _2.2 Release Notes: https://github.com/ansible/ansible/blob/stable-2.2/CHANGELOG.md
.. _2.1 Release Notes: https://github.com/ansible/ansible/blob/stable-2.1/CHANGELOG.md
.. _2.0 Release Notes: https://github.com/ansible/ansible/blob/stable-2.0/CHANGELOG.md
.. _1.9 Release Notes: https://github.com/ansible/ansible/blob/stable-1.9/CHANGELOG.md

.. _support_life:
.. _methods:
Expand Down Expand Up @@ -106,9 +96,7 @@ releases of Ansible, there can sometimes be exceptions for critical issues.
Changelogs
~~~~~~~~~~~~~~~~~~

Older versions logged changes in ``stable-<version>`` branches at ``stable-<version>/CHANGELOG.md``. For example, here is the changelog for 2.4_ on GitHub.

We now generate changelogs based on fragments. Here is the generated changelog for 2.8_ as an example. When creating new features or fixing bugs, create a changelog fragment describing the change. A changelog entry is not needed for new modules or plugins. Details for those items will be generated from the module documentation.
Since Ansible 2.5, we have generated changelogs based on fragments. Here is the generated changelog for 2.9_ as an example. When creating new features or fixing bugs, create a changelog fragment describing the change. A changelog entry is not needed for new modules or plugins. Details for those items will be generated from the module documentation.

Creating New Fragments
----------------------
Expand Down Expand Up @@ -150,6 +138,8 @@ Most changelog entries will be ``bugfixes`` or ``minor_changes``. When writing a
Commit the changelog fragment and include it with the pull request.


Older versions logged changes in ``stable-<version>`` branches at ``stable-<version>/CHANGELOG.md``. For example, here is the changelog for `2.4 <https://github.com/ansible/ansible/blob/stable-2.4/CHANGELOG.md>`_ on GitHub.


Release candidates
~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -196,7 +186,7 @@ to remove the feature permanently.

The cycle is normally across 4 feature releases (2.x.y, where the x marks a feature release and the y a bugfix release),
so the feature is normally removed in the 4th release after we announce the deprecation.
For example, something deprecated in 2.5 will be removed in 2.9, assuming we don't jump to 3.x before that point.
For example, something deprecated in 2.7 will be removed in 2.11, assuming we don't jump to 3.x before that point.
The tracking is tied to the number of releases, not the release numbering.

For modules/plugins, we keep the documentation after the removal for users of older versions.
Expand Down