Skip to content

Commit afcdbd5

Browse files
authored
revamp Releases page (ros2#106)
1 parent ed23587 commit afcdbd5

File tree

4 files changed

+89
-47
lines changed

4 files changed

+89
-47
lines changed

source/Releases.rst

Lines changed: 89 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,117 @@
11

2-
ROS 2 Releases
3-
==============
2+
ROS 2 Distributions
3+
===================
44

5-
Summary
6-
-------
5+
What is a Distribution?
6+
-----------------------
77

8-
A summary of releases of ROS 2 software is listed below.
8+
See `wiki.ros.org/Distributions <http://wiki.ros.org/Distributions>`_.
9+
10+
List of Distributions
11+
---------------------
912

1013
.. toctree::
1114
:hidden:
1215
:glob:
1316

1417
Releases/*
1518

19+
.. raw:: html
20+
21+
<style>
22+
.distros td {border: 0px;}
23+
.distros tbody tr {background-color: #c0c0c0;}
24+
.distros tbody tr:nth-child(1), .distros tbody tr:nth-child(2) {background-color: #33cc66;}
25+
.distros td {vertical-align: middle;}
26+
</style>
27+
28+
.. |crystal| image:: Releases/crystal-small.png
29+
:alt: Crystal logo
30+
31+
.. |bouncy| image:: Releases/bouncy-small.png
32+
:alt: Bouncy logo
33+
34+
.. |ardent| image:: Releases/ardent-small.png
35+
:alt: Ardent logo
36+
1637
.. list-table::
38+
:class: distros
1739
:header-rows: 1
40+
:widths: 35 30 20 15
1841

19-
* - Release Overview
20-
- Date
42+
* - Distro
43+
- Release date
44+
- Logo
45+
- EOL date
2146
* - `Crystal Clemmys <Releases/Release-Crystal-Clemmys>`
22-
- 14 December 2018
47+
- December 14th, 2018
48+
- |crystal|
49+
- Dec 2019
2350
* - `Bouncy Bolson <Releases/Release-Bouncy-Bolson>`
24-
- 2 July 2018
51+
- July 2nd, 2018
52+
- |bouncy|
53+
- Jul 2019
2554
* - `Ardent Apalone <Releases/Release-Ardent-Apalone>`
26-
- 8 December 2017
55+
- December 8th, 2017
56+
- |ardent|
57+
- Dec 2018
2758
* - `beta3 <Releases/Beta3-Overview>`
28-
- 13 September 2017
59+
- September 13th, 2017
60+
-
61+
- Dec 2017
2962
* - `beta2 <Releases/Beta2-Overview>`
30-
- 5 July 2017
63+
- July 5th, 2017
64+
-
65+
- Sep 2017
3166
* - `beta1 <Releases/Beta1-Overview>`
32-
- 19 December 2016
33-
* - `alpha1-8 <Releases/Alpha-Overview>`
34-
- 31 August 2015 - 4 October 2016
35-
36-
Upcoming releases:
37-
38-
.. list-table::
39-
:header-rows: 1
40-
41-
* - Future Release Overview
42-
- Date
43-
* - `Dashing Diademata <Releases/Release-Dashing-Diademata>`
44-
- Summer 2019
67+
- December 19th, 2016
68+
-
69+
- Jul 2017
70+
* - `alpha1 - alpha8 <Releases/Alpha-Overview>`
71+
- August 31th, 2015
72+
-
73+
- Dec 2016
4574

46-
For more details about each release, see the corresponding release overview.
75+
Distribution Details
76+
~~~~~~~~~~~~~~~~~~~~
4777

48-
Release practices
49-
-----------------
78+
For details on the distributions see each releases page.
79+
For the supported platforms and versions of common dependencies and other considerations, see the official ROS 2 Target Platforms `REP 2000 <http://www.ros.org/reps/rep-2000.html>`_.
5080

51-
Core packages
52-
^^^^^^^^^^^^^
81+
Future Distributions
82+
--------------------
5383

54-
New ROS 2 distributions are currently released every 6 months.
55-
During the release process, Open Robotics packages what is in the `ros2.repos
56-
file <https://github.com/ros2/ros2/blob/master/ros2.repos>`__ into installables for the supported platforms.
57-
These installables take the form of "fat archives" on MacOS, Windows and Linux, and additionally Debian packages are created for Linux.
58-
Check the release page for a distribution for details of the supported platform versions.
84+
For details on upcoming features see the `roadmap <Roadmap>`.
5985

60-
After the first release of a distribution, patch releases may be made that include bug fixes and platform updates (particularly on platforms with rolling dependencies like Windows and MacOS) for the distribution.
61-
New features are not typically released into an existing distribution, but are saved for the next distribution.
86+
Currently there is a new ROS 2 distribution roughly every 6 months.
87+
The following information are best estimates and are subject to change.
6288

63-
The `roadmap <Roadmap>` details the upcoming features that are targeted for the next distribution.
89+
.. raw:: html
6490

65-
While we do aim to keep the API as stable as possible, 100% API compatibility is not guaranteed between distributions.
91+
<style>
92+
.future-distros td {vertical-align: middle;}
93+
</style>
6694

67-
Internal notes on how a release is made: `Release-Howto <Releases/Release-Howto>`
68-
69-
External packages
70-
^^^^^^^^^^^^^^^^^
95+
.. list-table::
96+
:class: future-distros
97+
:header-rows: 1
98+
:widths: 25 30 20 25
7199

72-
Packages outside of the `ros2.repos file <https://github.com/ros2/ros2/blob/master/ros2.repos>`__ may be released by community members
73-
into a ROS 2 distribution.
74-
This is currently supported for Linux Debian packages, following `these instructions <Tutorials/Releasing-a-ROS-2-package-with-bloom>`.
75-
These packages can be released at any time during the lifecycle of a ROS 2 distribution.
100+
* - Distro
101+
- Release date
102+
- Supported for
103+
- Planned changes
104+
* - `Dashing Diademata <Releases/Release-Dashing-Diademata>`
105+
- May 31st, 2019
106+
- 2 years
107+
-
108+
* - <E-turtle>
109+
- November 22nd, 2019
110+
- 1 year
111+
-
112+
* - <F-turtle>
113+
- May 2020
114+
- 3+ years
115+
- Target Ubuntu 20.04
116+
117+
After F-turtle the expectations is to release new ROS 2 distributions once per year.

source/Releases/ardent-small.png

31.8 KB
Loading

source/Releases/bouncy-small.png

20.4 KB
Loading

source/Releases/crystal-small.png

4.98 KB
Loading

0 commit comments

Comments
 (0)