Browse code

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

* docs: update to latest 3 versions (#64109)

(cherry picked from commit 409545825f33406d2475864dc23d719b095da683)

* [Doc-Release-2.9] update release and maintenance page for 2.9 (#64166)
* update release and maintenance page for 2.9
* only 2.4 and earlier used the old changelog system

(cherry picked from commit 3f808d9ed621d226289dcd4ce858b0de6d04f1dd)

Sandra McCann authored on 2019/11/02 00:06:23
Showing 2 changed files
... ...
@@ -140,9 +140,11 @@ html_context = {
140 140
     'github_version': 'devel/docs/docsite/rst/',
141 141
     'github_module_version': 'devel/lib/ansible/modules/',
142 142
     'current_version': version,
143
-    'latest_version': '2.8',
143
+    'latest_version': '2.9',
144 144
     # list specifically out of order to make latest work
145
-    'available_versions': ('latest', '2.7', '2.6', 'devel')
145
+    'available_versions': ('latest', '2.8', '2.7', 'devel'),
146
+    'css_files': ('_static/ansible.css',  # overrides to the standard theme
147
+                  ),
146 148
 }
147 149
 
148 150
 # The style sheet to use for HTML and HTML Help pages. A file of that name
... ...
@@ -11,7 +11,7 @@ Release and maintenance
11 11
 Release cycle
12 12
 `````````````
13 13
 
14
-Ansible is developed and released on a flexible 4 months release cycle.
14
+Ansible is developed and released on a flexible six month release cycle.
15 15
 This cycle can be extended in order to allow for larger changes to be properly
16 16
 implemented and tested before a new release is made available.
17 17
 
... ...
@@ -39,18 +39,13 @@ This table links to the release notes for each major release. These release note
39 39
 ==============================      =================================================
40 40
 Ansible Release                     Status
41 41
 ==============================      =================================================
42
-devel                               In development (2.9 unreleased, trunk)
43
-`2.8 Release Notes`_                Supported (security **and** general bug fixes)
44
-`2.7 Release Notes`_                Supported (security **and** critical bug fixes)
45
-`2.6 Release Notes`_                Supported (security fixes)
46
-`2.5 Release Notes`_                Unsupported (end of life)
47
-`2.4 Release Notes`_                Unsupported (end of life)
48
-`2.3 Release Notes`_                Unsupported (end of life)
49
-`2.2 Release Notes`_                Unsupported (end of life)
50
-`2.1 Release Notes`_                Unsupported (end of life)
51
-`2.0 Release Notes`_                Unsupported (end of life)
52
-`1.9 Release Notes`_                Unsupported (end of life)
53
-<1.9                                Unsupported (end of life)
42
+devel                               In development (2.10 unreleased, trunk)
43
+`2.9 Release Notes`_                Maintained (security **and** general bug fixes)
44
+`2.8 Release Notes`_                Maintained (security **and** critical bug fixes)
45
+`2.7 Release Notes`_                Maintained (security fixes)
46
+`2.6 Release Notes`_                Unmaintained (end of life)
47
+`2.5 Release Notes`_                Unmaintained (end of life)
48
+<2.5                                Unmaintained (end of life)
54 49
 ==============================      =================================================
55 50
 
56 51
 You can download the releases from `<https://releases.ansible.com/ansible/>`_.
... ...
@@ -61,19 +56,14 @@ You can download the releases from `<https://releases.ansible.com/ansible/>`_.
61 61
 
62 62
 .. Comment: devel used to point here but we're currently revamping our changelog process and have no
63 63
    link to a static changelog for devel _2.6: https://github.com/ansible/ansible/blob/devel/CHANGELOG.md
64
+.. _2.9 Release Notes:
65
+.. _2.9: https://github.com/ansible/ansible/blob/stable-2.9/changelogs/CHANGELOG-v2.9.rst
64 66
 .. _2.8 Release Notes:
65 67
 .. _2.8: https://github.com/ansible/ansible/blob/stable-2.8/changelogs/CHANGELOG-v2.8.rst
66 68
 .. _2.7 Release Notes: https://github.com/ansible/ansible/blob/stable-2.7/changelogs/CHANGELOG-v2.7.rst
67 69
 .. _2.6 Release Notes:
68 70
 .. _2.6: https://github.com/ansible/ansible/blob/stable-2.6/changelogs/CHANGELOG-v2.6.rst
69 71
 .. _2.5 Release Notes: https://github.com/ansible/ansible/blob/stable-2.5/changelogs/CHANGELOG-v2.5.rst
70
-.. _2.4 Release Notes:
71
-.. _2.4: https://github.com/ansible/ansible/blob/stable-2.4/CHANGELOG.md
72
-.. _2.3 Release Notes: https://github.com/ansible/ansible/blob/stable-2.3/CHANGELOG.md
73
-.. _2.2 Release Notes: https://github.com/ansible/ansible/blob/stable-2.2/CHANGELOG.md
74
-.. _2.1 Release Notes: https://github.com/ansible/ansible/blob/stable-2.1/CHANGELOG.md
75
-.. _2.0 Release Notes: https://github.com/ansible/ansible/blob/stable-2.0/CHANGELOG.md
76
-.. _1.9 Release Notes: https://github.com/ansible/ansible/blob/stable-1.9/CHANGELOG.md
77 72
 
78 73
 .. _support_life:
79 74
 .. _methods:
... ...
@@ -106,9 +96,7 @@ releases of Ansible, there can sometimes be exceptions for critical issues.
106 106
 Changelogs
107 107
 ~~~~~~~~~~~~~~~~~~
108 108
 
109
-Older versions logged changes in ``stable-<version>`` branches at ``stable-<version>/CHANGELOG.md``. For example, here is the changelog for 2.4_ on GitHub.
110
-
111
-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.
109
+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.
112 110
 
113 111
 Creating New Fragments
114 112
 ----------------------
... ...
@@ -150,6 +138,8 @@ Most changelog entries will be ``bugfixes`` or ``minor_changes``. When writing a
150 150
 Commit the changelog fragment and include it with the pull request.
151 151
 
152 152
 
153
+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.
154
+
153 155
 
154 156
 Release candidates
155 157
 ~~~~~~~~~~~~~~~~~~
... ...
@@ -196,7 +186,7 @@ to remove the feature permanently.
196 196
 
197 197
 The cycle is normally across 4 feature releases (2.x.y, where the x marks a feature release and the y a bugfix release),
198 198
 so the feature is normally removed in the 4th release after we announce the deprecation.
199
-For example, something deprecated in 2.5 will be removed in 2.9, assuming we don't jump to 3.x before that point.
199
+For example, something deprecated in 2.7 will be removed in 2.11, assuming we don't jump to 3.x before that point.
200 200
 The tracking is tied to the number of releases, not the release numbering.
201 201
 
202 202
 For modules/plugins, we keep the documentation after the removal for users of older versions.