From cdff66f5d49004f20537407c3ac28c9044be15e8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christoph=20Fr=C3=B6hlich?= Date: Mon, 29 Apr 2024 18:02:35 +0200 Subject: [PATCH] Include migration notes from ros2_controllers (#265) * Include migration notes from ros2_controllers * Add release_notes page * Cross-link them * Rename file * Rename file (cherry picked from commit f1c43071b4637d41442511f601de98c94483a0c9) --- doc/migration/migration.rst | 6 +++++- doc/release_notes/release_notes.rst | 27 +++++++++++++++++++++++++++ index.rst | 1 + 3 files changed, 33 insertions(+), 1 deletion(-) create mode 100644 doc/release_notes/release_notes.rst diff --git a/doc/migration/migration.rst b/doc/migration/migration.rst index 798a072bce..3816016868 100644 --- 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 new file mode 100644 index 0000000000..49d490ce85 --- /dev/null +++ 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 index 6d38fc86ea..921be23f32 100644 --- 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