Skip to content
Open
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 .sphinx_tamer.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ sentence_scan:
- (\s|^)(\.)(idl|msg|srv|action|NET|rviz)
- (\s|^)(\.)(tgz|exe|zip|so|repo)
ignorable_prefixes:
- Get-Started/Releases/
- Releases/
1 change: 0 additions & 1 deletion source/Get-Started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ Coming Soon

Get-Started/About-ROS/About-ROS
Get-Started/Installation
Get-Started/Releases
First-Steps
Get-Started/Configuring-ROS2-Environment
Get-Started/Introducing-Turtlesim/Introducing-Turtlesim
2 changes: 1 addition & 1 deletion source/Get-Started/About-ROS/About-ROS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -141,4 +141,4 @@ ROS on macOS is supported by the community, and we do not recommended it for new
Ubuntu support depends on the ROS distribution, with each distribution requiring a specific Ubuntu LTS (long-term support) release.
Other platforms may require building from source or using containers.

:doc:`See full details of currently supported platforms and support tiers <../Releases/Release-Rolling-Ridley>`
:doc:`See full details of currently supported platforms and support tiers <../../Releases/Release-Rolling-Ridley>`
2 changes: 1 addition & 1 deletion source/Get-Started/Installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Options for installing ROS 2 {DISTRO_TITLE_FULL}:
Binary packages
---------------

Binaries are only created for the Tier 1 operating systems listed in :doc:`Lyrical Luth release docs <Releases/Release-Lyrical-Luth>`.
Binaries are only created for the Tier 1 operating systems listed in :doc:`Lyrical Luth release docs <../../Releases/Release-Lyrical-Luth>`.
If you are not running any of the following operating systems you may need to build from source or use a :doc:`container solution <../Developer-Tools/Build/Run-2-nodes-in-single-or-separate-docker-containers>` to run ROS 2 on your platform.

We provide ROS 2 binary packages for the following platforms:
Expand Down
2 changes: 1 addition & 1 deletion source/Get-Started/Releases.rst → source/Releases.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Below is a list of current and historic ROS 2 distributions.
Rows in the table marked in blue are the currently supported distributions.

.. toctree::
:hidden:
:maxdepth: 3

Releases/Release-Process
Releases/Release-Lyrical-Luth
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Improvements since Alpha 8 release
Selected features from previous Alpha releases
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

For the complete list, see `earlier release notes </Get-Started/Releases>`.
For the complete list, see `earlier release notes </Releases>`.


* C++ and Python implementations of ROS 2 client libraries including APIs for:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Supported Platforms
-------------------

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

Features
--------
Expand Down Expand Up @@ -42,7 +42,7 @@ New demo application
Selected features from previous Alpha/Beta releases
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

For the complete list, see `earlier release notes </Get-Started/Releases>`.
For the complete list, see `earlier release notes <Releases>`.

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -359,7 +359,7 @@ It is much easier to update dependencies.
The dependencies are installed in individual workspaces, with no “global” installation.

See https://github.com/ros2/ci/pull/802 and https://github.com/ros2/ros2/pull/1642 for more details.
Visit :doc:`Windows source install instructions <../Installation/Alternatives/Windows-Development-Setup>` to install it on Windows.
Visit :doc:`Windows source install instructions <../Get-Started/Installation/Alternatives/Windows-Development-Setup>` to install it on Windows.

Support topic instances in DDS topics
"""""""""""""""""""""""""""""""""""""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Tier 3 platforms:
Installation
------------

`Install Rolling Ridley <../Installation>`
`Install Rolling Ridley <../Get-Started/Installation>`

New features and changes in this release
----------------------------------------
Expand Down
6 changes: 3 additions & 3 deletions source/The-ROS2-Project/Contributing/Developer-Guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ Guidelines for backporting PRs
When changing an older version of ROS:

* Make sure the features or fixes are accepted and merged in the rolling branch before opening a PR to backport the changes to older versions.
* When backporting to older versions, also consider backporting to any other :doc:`still supported versions <../../Get-Started/Releases>`, even non-LTS versions.
* When backporting to older versions, also consider backporting to any other :doc:`still supported versions <../../Releases>`, even non-LTS versions.
* If you are backporting a single PR in its entirety, title the backport PR "[Distro] <name of original PR>".
* Link to all PRs whose changes you're backporting from the description of your backport PR.
* Package maintainers typically use `Mergifyio <https://mergify.com/>`_ to automatically backport PRs to downstream distributions when needed, however developers can still perform manual backporting operations as described above when necessary.
Expand Down Expand Up @@ -297,7 +297,7 @@ For example: Development commits targeting ``foxy`` are made to the ``foxy`` bra

**What about** ``main`` **and** ``rolling`` **?**

``main`` typically targets :doc:`Rolling <../../Get-Started/Releases/Release-Rolling-Ridley>` (and so, the next unreleased ROS distribution), though the maintainers may decide to develop and release from a ``rolling`` branch instead.
``main`` typically targets :doc:`Rolling <../../Releases/Release-Rolling-Ridley>` (and so, the next unreleased ROS distribution), though the maintainers may decide to develop and release from a ``rolling`` branch instead.

.. _DeveloperGuidePullRequests:

Expand Down Expand Up @@ -472,7 +472,7 @@ The original ROS packages have been modified to follow Debian guidelines, which

In addition several of the bootstrap dependencies such as command line tools like ``vcstool`` and ``colcon`` as well as some libraries like ``osrf-pycommon`` and ``ament`` are also packaged upstream.

Unlike the OSRF-provided ROS packages from http://packages.ros.org, the packages in the upstream repositories are not attached to a specific :doc:`ROS distribution <../../Get-Started/Releases>`.
Unlike the OSRF-provided ROS packages from http://packages.ros.org, the packages in the upstream repositories are not attached to a specific :doc:`ROS distribution <../../Releases>`.
Rather, they represent a snapshot in time that will be updated periodically within Debian unstable and then latched at various points into downstream Debian and Ubuntu distributions.

Don't mix the streams
Expand Down
2 changes: 1 addition & 1 deletion source/The-ROS2-Project/Platform-EOL-Policy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Platform EOL policy
:depth: 1
:local:

:doc:`ROS distributions <../Get-Started/Releases>` do not support end-of-life (EOL) platforms, even if the ROS distribution is still active.
:doc:`ROS distributions <../Releases>` do not support end-of-life (EOL) platforms, even if the ROS distribution is still active.
This page explains:

* What users of EOL platforms should expect
Expand Down
4 changes: 2 additions & 2 deletions source/The-ROS2-Project/Roadmap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Lyrical Luth
------------

Lyrical Luth is the ROS 2 release expected in May 2026.
See the :doc:`release page <../Get-Started/Releases/Release-Lyrical-Luth>` for a detailed timeline.
See the :doc:`release page <../Releases/Release-Lyrical-Luth>` for a detailed timeline.

Lyrical Roadmap
---------------
Expand All @@ -34,7 +34,7 @@ If you'd like to take on one of these tasks, please :doc:`get in touch with us <
Planned releases
----------------

Please see the :doc:`Distributions page <../Get-Started/Releases>` for the timeline of and information about future distributions.
Please see the :doc:`Distributions page <../Releases>` for the timeline of and information about future distributions.

Contributing to ROS 2
---------------------
Expand Down
3 changes: 2 additions & 1 deletion source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ ROS 2 Documentation
:hidden:

Get-Started
Releases
ROS-Framework
Developer-Tools
Capabilities
Expand Down Expand Up @@ -73,7 +74,7 @@ If you're interested in the advancement of the ROS 2 project:

- Best practices and methodology for contributing code, documentation, and other improvements to ROS 2, as well as instructions for migrating existing ROS 1 documentation to ROS 2

* :doc:`Distributions <Get-Started/Releases>`
* :doc:`Distributions <Releases>`

- Past, present and future ROS 2 distributions

Expand Down
Loading