Skip to content

Commit 4a99c28

Browse files
patiencedaurpatiencedaur
authored
Redefine structure for release notes section (#2743)
Resolves #2734 * Redefine structure for release notes section * Change headers to sentence case * Add missing release links
1 parent ef2776f commit 4a99c28

File tree

9 files changed

+181
-160
lines changed

9 files changed

+181
-160
lines changed

‎doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,4 +85,4 @@
8585
reference/index
8686
tutorials/index
8787
contributing/index
88-
release
88+
release/index

‎doc/release.rst

Lines changed: 0 additions & 155 deletions
This file was deleted.

‎doc/release/index.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
:noindex:
2+
:fullwidth:
3+
4+
.. _release:
5+
6+
Release notes
7+
*************
8+
9+
.. toctree::
10+
:maxdepth: 2
11+
12+
policy_index
13+
notes
14+
major-features
15+
release-calendar

‎doc/release/legacy-policy.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Tarantool Legacy Release Policy
1+
Tarantool legacy release policy
22
===============================
33

44

‎doc/release/notes.rst

Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
Release notes for Tarantool versions
2+
====================================
3+
4+
Below is the table listing all Tarantool versions starting from 1.10.0 up to
5+
the current latest versions.
6+
Each link leads to the release notes page of the corresponding version:
7+
8+
.. _release-list:
9+
10+
.. container:: table
11+
12+
.. rst-class:: left-align-column-1
13+
.. rst-class:: left-align-column-2
14+
.. rst-class:: left-align-column-3
15+
.. rst-class:: left-align-column-4
16+
17+
.. list-table::
18+
19+
* - Release Series
20+
- Alpha
21+
- Beta
22+
- Release
23+
24+
* - 2.10
25+
- n/a
26+
- :doc:`2.10.0-beta1 <2021-08-releases>`
27+
- not released yet
28+
29+
* - 2.8
30+
- 2.8.0
31+
- :doc:`2.8.1 <2.8.1>`
32+
- :doc:`2.8.2 <2021-08-releases>`,
33+
2.8.3 (`GitHub <https://github.com/tarantool/tarantool/releases/tag/2.8.3>`__)
34+
35+
* - 2.7
36+
- 2.7.0
37+
- :doc:`2.7.1 <2.7.1>`
38+
- :doc:`2.7.2 <2.7.2>`, :doc:`2.7.3 <2021-08-releases>`
39+
40+
* - 2.6
41+
- 2.6.0
42+
- :doc:`2.6.1 <2.6.1>`
43+
- :doc:`2.6.2 <2.6.2>`,
44+
:doc:`2.6.3 <2.6.3>`
45+
46+
* - 2.5
47+
- 2.5.0
48+
- :doc:`2.5.1 <2.5.1>`
49+
- :doc:`2.5.2 <2.5.2>`,
50+
:doc:`2.5.3 <2.5.3>`
51+
52+
* - 2.4
53+
- 2.4.0
54+
- :doc:`2.4.1 <2.4.1>`
55+
- :doc:`2.4.2 <2.4.2>`,
56+
:doc:`2.4.3 <2.4.3>`
57+
58+
* - 2.3
59+
- 2.3.0
60+
- :doc:`2.3.1 <2.3.1>`
61+
- :doc:`2.3.2 <2.3.2>`,
62+
:doc:`2.3.3 <2.3.3>`
63+
64+
* - 2.2
65+
- 2.2.0
66+
- :doc:`2.2.1 <2.2.1>`
67+
- :doc:`2.2.2 <2.2.2>`,
68+
:doc:`2.2.3 <2.2.3>`
69+
70+
71+
* - 1.10 (LTS series)
72+
- 1.10.0
73+
- 1.10.1
74+
- :ref:`1.10.2 <whats_new_1102>`,
75+
:ref:`1.10.3 <whats_new_1103>`,
76+
:ref:`1.10.4 <whats_new_1104>`,
77+
:doc:`1.10.5 <1.10.5>`,
78+
:doc:`1.10.6 <1.10.6>`,
79+
:doc:`1.10.7 <1.10.7>`,
80+
:doc:`1.10.8 <1.10.8>`,
81+
:doc:`1.10.9 <1.10.9>`,
82+
:doc:`1.10.10 <1.10.10>`,
83+
:doc:`1.10.11 <2021-08-releases>`,
84+
1.10.12 (`GitHub <https://github.com/tarantool/tarantool/releases/tag/1.10.12>`__)
85+
86+
87+
For smaller feature changes and bug fixes, see closed
88+
`milestones <https://github.com/tarantool/tarantool/milestones?state=closed>`_
89+
at GitHub.
90+
91+
Release notes for series before 1.10 are also available:
92+
93+
* :doc:`1.9`
94+
* :doc:`1.8`
95+
* :doc:`1.7`
96+
* :doc:`1.6`
97+
98+
99+
.. toctree::
100+
:hidden:
101+
102+
2021-08-releases
103+
2.8.1
104+
2.7.2
105+
2.7.1
106+
2.6.3
107+
2.6.2
108+
2.6.1
109+
2.5.3
110+
2.5.2
111+
2.5.1
112+
2.4.3
113+
2.4.2
114+
2.4.1
115+
2.3.3
116+
2.3.2
117+
2.3.1
118+
2.2.3
119+
2.2.2
120+
2.2.1
121+
2.1.2
122+
1.10.10
123+
1.10.9
124+
1.10.8
125+
1.10.7
126+
1.10.6
127+
1.10.5
128+
1.10
129+
1.9
130+
1.8
131+
1.7
132+
1.6
133+

‎doc/release/policy.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Tarantool Release Policy
1+
Tarantool release policy
22
========================
33

44
.. _release-policy:

‎doc/release/policy_index.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
Release policies
2+
================
3+
4+
Since version 2.10, there's a :doc:`new release policy for Tarantool <policy>`.
5+
In short, Tarantool version numbers consist of three parts:
6+
7+
.. code-block:: text
8+
9+
MAJOR.MINOR.PATCH
10+
11+
Any version without extra prefixes is a release version.
12+
If you need a version for production use, pick the latest release.
13+
For evaluation and development, you can use beta versions.
14+
They are marked with ``-betaN`` suffixes.
15+
16+
Before 2.10.0, version numbers were subject to the
17+
:doc:`legacy versioning policy <legacy-policy>`:
18+
19+
.. code-block:: text
20+
21+
MAJOR_VERSION.RELEASE_SERIES.RELEASE
22+
23+
.. toctree::
24+
:hidden:
25+
:maxdepth: 2
26+
27+
policy
28+
legacy-policy

‎doc/singlehtml.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,5 @@
1414
book/index
1515
reference/index
1616
tutorials/index
17-
release
17+
release/index
1818
dev_guide/index

‎doc/toctree.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@
2222
reference/index
2323
tutorials/index
2424
contributing/index
25-
release
25+
release/index

0 commit comments

Comments
 (0)