Skip to content
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

Use a single file for migration + release notes (backport #324) #325

Merged
merged 1 commit into from
Jul 14, 2024
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
17 changes: 4 additions & 13 deletions doc/migration/migration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,13 @@ Coming from ros_control (ROS 1)
Between different ROS 2 distributions
**************************************

These lists summarizes necessary changes to your code for a version update. For non-breaking updates, see the :ref:`release_notes`.
This list summarizes necessary changes to your code for a version update to {DISTRO}. If you are skipping a distribution update, make sure to read the migration guides of all intermediate distributions.

ros2_control
-------------
For non-breaking updates, see the :ref:`release_notes`.

.. toctree::
:titlesonly:

Foxy to Galactic <../ros2_control/doc/migration/Galactic.rst>
Iron to Jazzy <../ros2_control/doc/migration/Jazzy.rst>


ros2_controllers
----------------

.. toctree::
:titlesonly:

Iron to Jazzy <../ros2_controllers/doc/migration/Jazzy.rst>
ros2_control <../ros2_control/doc/migration.rst>
ros2_controllers <../ros2_controllers/doc/migration.rst>
16 changes: 3 additions & 13 deletions doc/release_notes/release_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,15 @@
Release Notes
=================================

This page should highlight the most important changes of the ros2_control framework.
This page should highlight the most important changes of the ros2_control framework in the {DISTRO} release. If you are skipping a distribution update, make sure to read the release notes of all intermediate distributions.

These lists might not be complete, see the ``CHANGELOG.rst`` files in the respective repositories for a full list of changes.

For necessary changes to your code for a version update, see the :ref:`migration`.

ros2_control
-------------

.. toctree::
:titlesonly:

Iron to Jazzy <../ros2_control/doc/release_notes/Jazzy.rst>


ros2_controllers
----------------

.. toctree::
:titlesonly:

Iron to Jazzy <../ros2_controllers/doc/release_notes/Jazzy.rst>
ros2_control <../ros2_control/doc/release_notes.rst>
ros2_controllers <../ros2_controllers/doc/release_notes.rst>
Loading