Include migration notes from ros2_controllers (#265) (#304)

* Include migration notes from ros2_controllers * Add release_notes page * Cross-link them * Rename file * Rename file (cherry picked from commit f1c4307) Co-authored-by: Christoph Fröhlich <[email protected]>
ros-controls · Apr 29, 2024 · 9a2d42b · 9a2d42b
1 parent 63545b5
commit 9a2d42b
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 1 deletion.
diff --git a/doc/migration/migration.rst b/doc/migration/migration.rst
@@ -14,6 +14,7 @@ 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`.
 
 ros2_control
 -------------
@@ -28,4 +29,7 @@ ros2_control
 ros2_controllers
 ----------------
 
-There are no migration notes yet.
+.. toctree::
+   :titlesonly:
+
+   Iron to Jazzy <../ros2_controllers/doc/migration/Jazzy.rst>
diff --git a/doc/release_notes/release_notes.rst b/doc/release_notes/release_notes.rst
@@ -0,0 +1,27 @@
+.. _release_notes:
+
+Release Notes
+=================================
+
+This page should highlight the most important changes of the ros2_control framework.
+
+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>
diff --git a/index.rst b/index.rst
@@ -12,6 +12,7 @@ Welcome to the ros2_control documentation - Jazzy!
    doc/ros2_control_demos/doc/index.rst
    doc/ros2_control/ros2controlcli/doc/userdoc.rst
    doc/simulators/simulators.rst
+   doc/release_notes/release_notes.rst
    doc/migration/migration.rst
    doc/api_list/api_list.rst
    doc/supported_robots/supported_robots.rst