Skip to content

Commit

Permalink
Use a single file for migration + release notes (backport #324) (#326)
Browse files Browse the repository at this point in the history
* Use a single file for migration + release notes (#324)

* Use a single file for migration + release notes

* Remove hardcoded distro

* Add another note

(cherry picked from commit 698e41f)

# Conflicts:
#	doc/migration/migration.rst
#	doc/release_notes/release_notes.rst

* Fix merge conflict

* Update index.rst

---------

Co-authored-by: Christoph Fröhlich <[email protected]>
  • Loading branch information
mergify[bot] and christophfroehlich authored Jul 15, 2024
1 parent 96b4f28 commit 4fcc305
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 9 deletions.
13 changes: 4 additions & 9 deletions doc/migration/migration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,12 @@ Coming from ros_control (ROS 1)
Between different ROS 2 distributions
**************************************

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>


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

There are no migration notes yet.
ros2_control <../ros2_control/doc/migration.rst>
ros2_controllers <../ros2_controllers/doc/migration.rst>
17 changes: 17 additions & 0 deletions doc/release_notes/release_notes.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
.. _release_notes:

Release Notes
=================================

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`.


.. toctree::
:titlesonly:

ros2_control <../ros2_control/doc/release_notes.rst>
ros2_controllers <../ros2_controllers/doc/release_notes.rst>
1 change: 1 addition & 0 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Welcome to the ros2_control documentation - Iron!
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
Expand Down

0 comments on commit 4fcc305

Please sign in to comment.