Skip to content

Redefine structure for release notes section #2743

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

Merged
merged 8 commits into from
Mar 16, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,4 +85,4 @@
reference/index
tutorials/index
contributing/index
release
release/index
155 changes: 0 additions & 155 deletions doc/release.rst

This file was deleted.

15 changes: 15 additions & 0 deletions doc/release/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
:noindex:
:fullwidth:

.. _release:

Release notes
*************

.. toctree::
:maxdepth: 2

policy_index
notes
major-features
release-calendar
2 changes: 1 addition & 1 deletion doc/release/legacy-policy.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Tarantool Legacy Release Policy
Tarantool legacy release policy
===============================


Expand Down
133 changes: 133 additions & 0 deletions doc/release/notes.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
Release notes for Tarantool versions
====================================

Below is the table listing all Tarantool versions starting from 1.10.0 up to
the current latest versions.
Each link leads to the release notes page of the corresponding version:

.. _release-list:

.. container:: table

.. rst-class:: left-align-column-1
.. rst-class:: left-align-column-2
.. rst-class:: left-align-column-3
.. rst-class:: left-align-column-4

.. list-table::

* - Release Series
- Alpha
- Beta
- Release

* - 2.10
- n/a
- :doc:`2.10.0-beta1 <2021-08-releases>`
- not released yet

* - 2.8
- 2.8.0
- :doc:`2.8.1 <2.8.1>`
- :doc:`2.8.2 <2021-08-releases>`,
2.8.3 (`GitHub <https://github.com/tarantool/tarantool/releases/tag/2.8.3>`__)

* - 2.7
- 2.7.0
- :doc:`2.7.1 <2.7.1>`
- :doc:`2.7.2 <2.7.2>`, :doc:`2.7.3 <2021-08-releases>`

* - 2.6
- 2.6.0
- :doc:`2.6.1 <2.6.1>`
- :doc:`2.6.2 <2.6.2>`,
:doc:`2.6.3 <2.6.3>`

* - 2.5
- 2.5.0
- :doc:`2.5.1 <2.5.1>`
- :doc:`2.5.2 <2.5.2>`,
:doc:`2.5.3 <2.5.3>`

* - 2.4
- 2.4.0
- :doc:`2.4.1 <2.4.1>`
- :doc:`2.4.2 <2.4.2>`,
:doc:`2.4.3 <2.4.3>`

* - 2.3
- 2.3.0
- :doc:`2.3.1 <2.3.1>`
- :doc:`2.3.2 <2.3.2>`,
:doc:`2.3.3 <2.3.3>`

* - 2.2
- 2.2.0
- :doc:`2.2.1 <2.2.1>`
- :doc:`2.2.2 <2.2.2>`,
:doc:`2.2.3 <2.2.3>`


* - 1.10 (LTS series)
- 1.10.0
- 1.10.1
- :ref:`1.10.2 <whats_new_1102>`,
:ref:`1.10.3 <whats_new_1103>`,
:ref:`1.10.4 <whats_new_1104>`,
:doc:`1.10.5 <1.10.5>`,
:doc:`1.10.6 <1.10.6>`,
:doc:`1.10.7 <1.10.7>`,
:doc:`1.10.8 <1.10.8>`,
:doc:`1.10.9 <1.10.9>`,
:doc:`1.10.10 <1.10.10>`,
:doc:`1.10.11 <2021-08-releases>`,
1.10.12 (`GitHub <https://github.com/tarantool/tarantool/releases/tag/1.10.12>`__)


For smaller feature changes and bug fixes, see closed
`milestones <https://github.com/tarantool/tarantool/milestones?state=closed>`_
at GitHub.

Release notes for series before 1.10 are also available:

* :doc:`1.9`
* :doc:`1.8`
* :doc:`1.7`
* :doc:`1.6`


.. toctree::
:hidden:

2021-08-releases
2.8.1
2.7.2
2.7.1
2.6.3
2.6.2
2.6.1
2.5.3
2.5.2
2.5.1
2.4.3
2.4.2
2.4.1
2.3.3
2.3.2
2.3.1
2.2.3
2.2.2
2.2.1
2.1.2
1.10.10
1.10.9
1.10.8
1.10.7
1.10.6
1.10.5
1.10
1.9
1.8
1.7
1.6

2 changes: 1 addition & 1 deletion doc/release/policy.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Tarantool Release Policy
Tarantool release policy
========================

.. _release-policy:
Expand Down
28 changes: 28 additions & 0 deletions doc/release/policy_index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
Release policies
================

Since version 2.10, there's a :doc:`new release policy for Tarantool <policy>`.
In short, Tarantool version numbers consist of three parts:

.. code-block:: text

MAJOR.MINOR.PATCH

Any version without extra prefixes is a release version.
If you need a version for production use, pick the latest release.
For evaluation and development, you can use beta versions.
They are marked with ``-betaN`` suffixes.

Before 2.10.0, version numbers were subject to the
:doc:`legacy versioning policy <legacy-policy>`:

.. code-block:: text

MAJOR_VERSION.RELEASE_SERIES.RELEASE

.. toctree::
:hidden:
:maxdepth: 2

policy
legacy-policy
2 changes: 1 addition & 1 deletion doc/singlehtml.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@
book/index
reference/index
tutorials/index
release
release/index
dev_guide/index
2 changes: 1 addition & 1 deletion doc/toctree.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@
reference/index
tutorials/index
contributing/index
release
release/index