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.

Sign up for GitHub

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

Jump to bottom

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

Merged
merged 3 commits into from
Jul 15, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9319f4a
Use a single file for migration + release notes (#324)
christophfroehlich Jul 14, 2024
825ba1e
Fix merge conflict
christophfroehlich Jul 15, 2024
0764ebe
Update index.rst
christophfroehlich Jul 15, 2024
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
13 changes: 4 additions & 9 deletions doc/migration/migration.rst
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
Loading