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

* Use a single file for migration + release notes * Remove hardcoded distro * Add another note (cherry picked from commit 698e41f) Co-authored-by: Christoph Fröhlich <[email protected]>
ros-controls · Jul 14, 2024 · b5369e8 · b5369e8
1 parent be2baf1
commit b5369e8
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 26 deletions.
diff --git a/doc/migration/migration.rst b/doc/migration/migration.rst
@@ -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>
diff --git a/doc/release_notes/release_notes.rst b/doc/release_notes/release_notes.rst
@@ -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>