Skip to content

Commit b1b9af3

Browse files
authored
Group ROS 2 Project pages under subfolder (ros2#2465)
1 parent e5bb88f commit b1b9af3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+234
-173
lines changed

source/Contact.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Pull requests
5555

5656
When you feel comfortable enough to suggest a specific change directly to the code, you can submit a pull request.
5757
Pull requests are welcome for any of `the ros2 repositories <https://github.com/ros2>`__.
58-
See the :doc:`Contributing <Contributing>` page for more details and etiquette on how to contribute.
58+
See the :doc:`Contributing <The-ROS2-Project/Contributing>` page for more details and etiquette on how to contribute.
5959

6060
.. _Using ROS Discourse:
6161

source/How-To-Guides/Package-maintainer-guide.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ The review is looking for:
2121
* Correct code
2222
* Conforms to developer guidelines:
2323

24-
* :doc:`Developer Guide <../Contributing/Developer-Guide>`
25-
* :doc:`Code Style Guide <../Contributing/Code-Style-Language-Versions>`
24+
* :doc:`Developer Guide <../The-ROS2-Project/Contributing/Developer-Guide>`
25+
* :doc:`Code Style Guide <../The-ROS2-Project/Contributing/Code-Style-Language-Versions>`
2626

2727
* Adds tests for the bug/feature
2828
* Adds documentation for new features
@@ -178,6 +178,6 @@ Getting help
178178

179179
While doing maintenance on a package, questions about general procedures or individual issues may come up.
180180

181-
For general questions, please follow the :doc:`contributing guidelines <../Contributing>`.
181+
For general questions, please follow the :doc:`contributing guidelines <../The-ROS2-Project/Contributing>`.
182182

183183
For questions on individual issues, please tag the ROS 2 GitHub team (@ros/team), and someone on the team will take a look.

source/Related-Projects.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Ignition Gazebo
1010
Large Community Projects
1111
------------------------
1212

13-
Large community projects involve multiple developers from all over the globe and are typically backed by a dedicated working group (cf. :doc:`Governance`).
13+
Large community projects involve multiple developers from all over the globe and are typically backed by a dedicated working group (cf. :doc:`The-ROS2-Project/Governance`).
1414

1515
* **Navigation2** `(navigation.ros.org) <https://navigation.ros.org/>`_: Comprehensive and flexible navigation stack for mobile robots using ROS 2.
1616
* **MoveIt** `(moveit.ros.org) <https://moveit.ros.org/>`_: A rich platform for building manipulation applications featuring advanced kinematics, motion planning, control, collision checking, and much more.

source/Releases.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ Rows in the table marked in green are the currently supported distributions.
143143
Future Distributions
144144
--------------------
145145

146-
For details on upcoming features see the :doc:`roadmap <Roadmap>`.
146+
For details on upcoming features see the :doc:`roadmap <The-ROS2-Project/Roadmap>`.
147147

148148
There is a new ROS 2 distribution released yearly on May 23rd (`World Turtle Day <https://www.worldturtleday.org/>`_).
149149

@@ -171,7 +171,7 @@ The Rolling distribution of ROS 2 serves as a staging area for future stable dis
171171
Unlike most stable ROS 2 distributions which have an initial release, a support window during which they are updated, and a definite end of support (see :ref:`list_of_distributions` above) the Rolling distribution is continuously updated and is subject to in-place updates which will at times include breaking changes.
172172

173173
Packages released into the Rolling distribution will be automatically released into future stable distributions of ROS 2.
174-
:doc:`Releasing a ROS 2 package <How-To-Guides/Releasing-a-ROS-2-package-with-bloom>` into the Rolling distribution follows the same procedures as all other ROS 2 distributions.
174+
:doc:`Releasing a ROS 2 package <../How-To-Guides/Releasing-a-ROS-2-package-with-bloom>` into the Rolling distribution follows the same procedures as all other ROS 2 distributions.
175175

176176
:doc:`ROS 2 Rolling Ridley <Releases/Release-Rolling-Ridley>` is the rolling development distribution of ROS 2 as proposed in `REP 2002 <https://www.ros.org/reps/rep-2002.html>`_.
177177
It was first introduced in June 2020.

source/Releases/Alpha-Overview.rst

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
.. redirect-from::
22

3-
Alpha-Overview
3+
Alpha-Overview
44

5-
ROS 2 alpha releases (Aug 2015 - Oct 2016)
6-
==========================================
5+
Alphas
6+
======
77

88
.. contents:: Table of Contents
99
:depth: 2
1010
:local:
1111

1212
This is a merged version of the previously separated pages for the 8 alpha releases of ROS 2.
1313

14-
We hope that you try them out and `provide feedback <../Contact>`.
14+
We hope that you try them out and `provide feedback <../../Contact>`.
1515

1616
ROS 2 alpha8 release (code name *Hook-and-Loop*; October 2016)
1717
----------------------------------------------------------------
1818

1919
Changes to supported DDS vendors
2020
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2121

22-
ROS 2 supports multiple middleware implementations (see `this page <../Concepts/About-Different-Middleware-Vendors>` for more details).
22+
ROS 2 supports multiple middleware implementations (see `this page <../../Concepts/About-Different-Middleware-Vendors>` for more details).
2323
Until Alpha 8, ROS 2 was supporting ROS middleware implementations for eProsima's Fast RTPS, RTI's Connext and PrismTech's OpenSplice.
2424
To streamline our efforts, as of Alpha 8, Fast RTPS and Connext (static) will be supported, with Fast RTPS (`now Apache 2.0-licensed <http://www.eprosima.com/index.php/company-all/news/61-eprosima-goes-apache>`__) shipped as the default.
2525

@@ -43,7 +43,7 @@ The improvements included in this release are:
4343
* Fixed various bugs with the previous alpha release
4444

4545
Pretty much anything not listed above is not included in this release.
46-
The next steps are described in the `Roadmap <../Roadmap>`.
46+
The next steps are described in the `Roadmap <../../The-ROS2-Project/Roadmap>`.
4747

4848
ROS 2 alpha7 release (code name *Glue Gun*\ ; July 2016)
4949
--------------------------------------------------------
@@ -76,7 +76,7 @@ The major features included in this release are:
7676
* See: https://github.com/ros2/turtlebot2_demo
7777

7878
Pretty much anything not listed above is not included in this release.
79-
The next steps are described in the `Roadmap <../Roadmap>`.
79+
The next steps are described in the `Roadmap <../../The-ROS2-Project/Roadmap>`.
8080

8181
ROS 2 alpha6 release (code name *Fastener*; June 2016)
8282
------------------------------------------------------
@@ -111,7 +111,7 @@ The major features included in this release are:
111111
* Strings
112112

113113
Pretty much anything not listed above is not included in this release.
114-
The next steps are described in the `Roadmap <../Roadmap>`.
114+
The next steps are described in the `Roadmap <../../The-ROS2-Project/Roadmap>`.
115115

116116
ROS 2 alpha5 release (code name *Epoxy*; April 2016)
117117
------------------------------------------------------
@@ -139,7 +139,7 @@ The major features included in this release are:
139139
* Added 32-bit and 64-bit ARM as experimentally supported platforms.
140140

141141
Pretty much anything not listed above is not included in this release.
142-
The next steps are described in the `Roadmap <../Roadmap>`.
142+
The next steps are described in the `Roadmap <../../The-ROS2-Project/Roadmap>`.
143143

144144
ROS 2 alpha4 release (code name *Duct tape*; February 2016)
145145
-----------------------------------------------------------
@@ -165,11 +165,11 @@ Status
165165
On February 17, 2016, we are releasing ROS 2 alpha4,
166166
code-named **Duct tape**.
167167
Our primary goal with this release is to add more features, while also addressing the feedback we received for the previous releases.
168-
To that end, we built a set of `demos <../Tutorials>` that
168+
To that end, we built a set of `demos <../../Tutorials>` that
169169
show some of the key features of ROS 2.
170170
We encourage you to try out those
171171
demos, look at the code that implements them, and `provide
172-
feedback <../Contact>`.
172+
feedback <../../Contact>`.
173173
We're especially interested to know how well (or
174174
poorly) we're addressing use cases that are important to you.
175175

@@ -200,7 +200,7 @@ The major features included in this release are:
200200
* New concept of extensible "time sources" for ROS Time, the default time source will be like ROS 1 (implementation pending)
201201

202202
Pretty much anything not listed above is not included in this release.
203-
The next steps are described in the `Roadmap <../Roadmap>`.
203+
The next steps are described in the `Roadmap <../../The-ROS2-Project/Roadmap>`.
204204

205205
ROS 2 alpha3 release (code name *Cement*; December 2015)
206206
----------------------------------------------------------
@@ -227,11 +227,11 @@ Status
227227
On December 18, 2015, we are releasing ROS 2 alpha3,
228228
code-named **Cement**.
229229
Our primary goal with this release is to add more features, while also addressing the feedback we received for the previous releases.
230-
To that end, we built a set of `demos <../Tutorials>` that
230+
To that end, we built a set of `demos <../../Tutorials>` that
231231
show some of the key features of ROS 2.
232232
We encourage you to try out those
233233
demos, look at the code that implements them, and `provide
234-
feedback <../Contact>`.
234+
feedback <../../Contact>`.
235235
We're especially interested to know how well (or
236236
poorly) we're addressing use cases that are important to you.
237237

@@ -271,7 +271,7 @@ The major features included in this release are:
271271
* A partial port of tf2 including the core libraries and core command line tools.
272272

273273
Pretty much anything not listed above is not included in this release.
274-
The next steps are described in the `Roadmap <../Roadmap>`.
274+
The next steps are described in the `Roadmap <../../The-ROS2-Project/Roadmap>`.
275275

276276
ROS 2 alpha2 release (code name *Baling wire*; October 2015)
277277
--------------------------------------------------------------
@@ -300,11 +300,11 @@ Status
300300
On November 3, 2015, we are releasing ROS 2 alpha2,
301301
code-named **Baling wire**.
302302
Our primary goal with this release is to add more features, while also addressing the feedback we received for the previous alpha 1 release.
303-
To that end, we built a set of `demos <../Tutorials>` that
303+
To that end, we built a set of `demos <../../Tutorials>` that
304304
show some of the key features of ROS 2.
305305
We encourage you to try out those
306306
demos, look at the code that implements them, and `provide
307-
feedback <../Contact>`.
307+
feedback <../../Contact>`.
308308
We're especially interested to know how well (or
309309
poorly) we're addressing use cases that are important to you.
310310

@@ -336,7 +336,7 @@ The major features included in this release are:
336336
* FreeRTPS improvements
337337

338338
Pretty much anything not listed above is not included in this release.
339-
The next steps are described in the `Roadmap <../Roadmap>`.
339+
The next steps are described in the `Roadmap <../../The-ROS2-Project/Roadmap>`.
340340

341341
ROS 2 alpha1 release (code name *Anchor*; August 2015)
342342
--------------------------------------------------------
@@ -367,11 +367,11 @@ code-named **Anchor**.
367367
Our primary goal with this release is to give
368368
you the opportunity to understand how ROS 2 works, in particular how it
369369
differs from ROS 1.
370-
To that end, we built a set of `demos <../Tutorials>` that
370+
To that end, we built a set of `demos <../../Tutorials>` that
371371
show some of the key features of ROS 2.
372372
We encourage you to try out those
373373
demos, look at the code that implements them, and `provide
374-
feedback <../Contact>`.
374+
feedback <../../Contact>`.
375375
We're especially interested to know how well (or
376376
poorly) we're addressing use cases that are important to you.
377377

@@ -408,4 +408,4 @@ The major features included in this release are:
408408
* `Bridge communication between ROS 1 and ROS 2 <https://github.com/ros2/ros1_bridge/blob/master/README>`__
409409

410410
Pretty much anything not listed above is not included in this release.
411-
The next steps are described in the `Roadmap <../Roadmap>`.
411+
The next steps are described in the `Roadmap <../../The-ROS2-Project/Roadmap>`.

source/Releases/Beta1-Overview.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
.. redirect-from::
22

3-
Beta1-Overview
3+
Beta1-Overview
44

5-
Beta 1 (codename 'Asphalt'; December 2016)
6-
==========================================
5+
Beta 1 (``Asphalt``)
6+
====================
77

88
.. contents:: Table of Contents
99
:depth: 2
@@ -24,13 +24,13 @@ Improvements since Alpha 8 release
2424
* A standard lifecycle for managed nodes.
2525
* Improved support for Quality of Service tuning and tests.
2626
* `New and updated design documents <https://design.ros2.org/>`__
27-
* More `tutorials <../Tutorials>` and `examples <https://github.com/ros2/examples>`__
27+
* More `tutorials <../../Tutorials>` and `examples <https://github.com/ros2/examples>`__
2828
* Bridging services to / from ROS 1 (in addition to topics)
2929

3030
Selected features from previous Alpha releases
3131
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3232

33-
For the complete list, see `earlier release notes <../Releases>`.
33+
For the complete list, see `earlier release notes <../index>`.
3434

3535

3636
* C++ and Python implementations of ROS 2 client libraries including APIs for:

source/Releases/Beta2-Overview.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
.. redirect-from::
22

3-
Beta2-Overview
3+
Beta2-Overview
44

5-
Beta 2 (codename 'r2b2'; July 2017)
6-
===================================
5+
Beta 2 (``r2b2``)
6+
=================
77

88
.. contents:: Table of Contents
99
:depth: 2
@@ -13,7 +13,7 @@ Supported Platforms
1313
-------------------
1414

1515
We support ROS 2 Beta 2 on three platforms: Ubuntu 16.04 (Xenial), macOS 10.12 (Sierra), and Windows 10.
16-
We provide both binary packages and instructions for how to compile from source for all 3 platforms (see `install instructions <../Installation>` as well as `documentation <https://docs.ros2.org/beta2/>`__).
16+
We provide both binary packages and instructions for how to compile from source for all 3 platforms (see `install instructions <../../Installation>` as well as `documentation <https://docs.ros2.org/beta2/>`__).
1717

1818
Features
1919
--------
@@ -23,9 +23,9 @@ Improvements since Beta 1 release
2323

2424
* DDS_Security support (aka SROS2, see `sros2 <https://github.com/ros2/sros2>`__)
2525
* Debian packages for Ubuntu Xenial
26-
* Typesupport has been redesigned so that you only build a single executable and can choose one of the available RMW implementations by setting an environment variable (see `documentation <../How-To-Guides/Working-with-multiple-RMW-implementations>`).
26+
* Typesupport has been redesigned so that you only build a single executable and can choose one of the available RMW implementations by setting an environment variable (see `documentation <../../How-To-Guides/Working-with-multiple-RMW-implementations>`).
2727
* Namespace support for nodes and topics (see `design article <https://design.ros2.org/articles/topic_and_service_names.html>`__, see known issues below).
28-
* A set of command-line tools using the extensible ``ros2`` command (see `conceptual article <../Concepts/About-Command-Line-Tools>`).
28+
* A set of command-line tools using the extensible ``ros2`` command (see `conceptual article <../../Concepts/About-Command-Line-Tools>`).
2929
* A set of macros for logging messages in C / C++ (see API docs of `rcutils <https://docs.ros2.org/beta2/api/rcutils/index.html>`__).
3030

3131
New demo application
@@ -52,7 +52,7 @@ New demo application
5252
Selected features from previous Alpha/Beta releases
5353
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5454

55-
For the complete list, see `earlier release notes <../Releases>`.
55+
For the complete list, see `earlier release notes <../index>`.
5656

5757

5858
* C++ and Python implementations of ROS 2 client libraries including APIs for:

source/Releases/Beta3-Overview.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
.. redirect-from::
22

3-
Beta3-Overview
3+
Beta3-Overview
44

5-
Beta 3 (codename 'r2b3'; September 2017)
6-
========================================
5+
Beta 3 (``r2b3``)
6+
=================
77

88
.. contents:: Table of Contents
99
:depth: 2
@@ -13,7 +13,7 @@ Supported Platforms
1313
-------------------
1414

1515
We support ROS 2 Beta 3 on three platforms: Ubuntu 16.04 (Xenial), macOS 10.12 (Sierra), and Windows 10.
16-
We provide both binary packages and instructions for how to compile from source for all 3 platforms (see `install instructions <../Installation>` as well as `documentation <https://docs.ros2.org/beta3/>`__).
16+
We provide both binary packages and instructions for how to compile from source for all 3 platforms (see `install instructions <../../Installation>` as well as `documentation <https://docs.ros2.org/beta3/>`__).
1717

1818
Features
1919
--------
@@ -41,7 +41,7 @@ New demo application
4141
Selected features from previous Alpha/Beta releases
4242
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4343

44-
For the complete list, see `earlier release notes <../Releases>`.
44+
For the complete list, see `earlier release notes <../index>`.
4545

4646
* C++ and Python implementations of ROS 2 client libraries including APIs for:
4747

source/Releases/Galactic-Geochelone-Complete-Changelog.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
ROS 2 Galactic Geochelone Complete Changelog
2-
============================================
1+
Galactic Geochelone changelog
2+
=============================
33

44
This page is a list of the complete changes in all ROS 2 core packages since the previous release.
55

source/Releases/Humble-Hawksbill-Complete-Changelog.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
ROS 2 Humble Hawksbill Complete Changelog
2-
=========================================
1+
Humble Hawksbill changelog
2+
==========================
33

44
This page is a list of the complete changes in all ROS 2 core packages since the previous release.
55

0 commit comments

Comments
 (0)