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.

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

Split ROS 1 -> 2 C++ page into a reference page and a tutorial page (backport #4779) #4794

Merged
merged 1 commit into from
Oct 1, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Oct 1, 2024

This splits the C++ ROS 1 to 2 migration page into two pages:

  • A tutorial page, which is good for beginners to migrating from ROS 1 to ROS 2
  • A reference page, which is good for someone actively migrating their package and wanting to CTRL+F how to do something

The tutorial content is unchanged except for:

  • Added an intro, prerequisites, and conclusion sections
  • Removed the sections about how to build and run the ROS 1 code because it's not easy to require both a working ROS 1 and a working ROS 2 installation on the same machine
  • Changed ^^^^ to ---- in a couple headings to put them on the same level as Prerequisites.
    This is an automatic backport of pull request Split ROS 1 -> 2 C++ page into a reference page and a tutorial page #4779 done by Mergify.

Copy link
Contributor Author

mergify bot commented Oct 1, 2024

Cherry-pick of 4e7e865 has failed:

On branch mergify/bp/humble/pr-4779
Your branch is up to date with 'origin/humble'.

You are currently cherry-picking commit 4e7e8658.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   source/How-To-Guides/Migrating-from-ROS1.rst
	new file:   source/How-To-Guides/Migrating-from-ROS1/Migrating-CPP-Package-Example.rst

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both modified:   source/How-To-Guides/Migrating-from-ROS1/Migrating-CPP-Packages.rst

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

@mergify mergify bot added the conflicts label Oct 1, 2024
…4779)

* Split ROS 1 -> 2 C++ page into a reference and a tutorial

* Call page an example and link it from reference

Signed-off-by: Shane Loretz <shane.loretz@gmail.com>
(cherry picked from commit 4e7e865)

# Conflicts:
#	source/How-To-Guides/Migrating-from-ROS1/Migrating-CPP-Packages.rst
Copy link

github-actions bot commented Oct 1, 2024

HTML artifacts: https://github.com/ros2/ros2_documentation/actions/runs/11133997089/artifacts/2003232600.

To view the resulting site:

  1. Click on the above link to download the artifacts archive
  2. Extract it
  3. Open html-artifacts-4794/index.html in your favorite browser

@clalancette clalancette merged commit 22f24ff into humble Oct 1, 2024
4 checks passed
@clalancette clalancette deleted the mergify/bp/humble/pr-4779 branch October 1, 2024 21:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants