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

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

Merged
merged 5 commits into from
Oct 1, 2024
Merged

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

merged 5 commits into from
Oct 1, 2024

Conversation

sloretz
Copy link
Contributor

@sloretz sloretz commented Oct 1, 2024 •
edited
Loading

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.

@sloretz sloretz self-assigned this Oct 1, 2024
@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 1, 2024 •
edited
Loading

HTML artifacts: https://github.com/ros2/ros2_documentation/actions/runs/11133153117/artifacts/2002969491.

To view the resulting site:

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

@sloretz
Fix link
09430a3 
Signed-off-by: Shane Loretz <[email protected]>
fujitatomoya
fujitatomoya approved these changes Oct 1, 2024
View reviewed changes
Copy link
Collaborator

@fujitatomoya fujitatomoya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think having dedicated tutorial page is better doc structure, lgtm.

clalancette
clalancette requested changes Oct 1, 2024
View reviewed changes
Copy link
Contributor

@clalancette clalancette left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have one suggestion for improvement, but otherwise this looks good to me.

source/How-To-Guides/Migrating-from-ROS1/Migrating-CPP-Packages.rst Show resolved Hide resolved
@clalancette clalancette added the backport-all backport at reviewers discretion; from rolling to all versions label Oct 1, 2024
clalancette
clalancette approved these changes Oct 1, 2024
View reviewed changes
Copy link
Contributor

@clalancette clalancette left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great to me, thanks.

@clalancette clalancette merged commit 4e7e865 into rolling Oct 1, 2024
4 checks passed
@clalancette clalancette deleted the sloretz__split_ros1-to-2_cpp_page branch October 1, 2024 21:06
mergify bot pushed a commit that referenced this pull request Oct 1, 2024
@sloretz @mergify
Split ROS 1 -> 2 C++ page into a reference page and a tutorial page (#…
b66aa11 
…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 <[email protected]>
(cherry picked from commit 4e7e865)
mergify bot pushed a commit that referenced this pull request Oct 1, 2024
@sloretz @mergify
Split ROS 1 -> 2 C++ page into a reference page and a tutorial page (#…
8a4689e 
…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 <[email protected]>
(cherry picked from commit 4e7e865)

# Conflicts:
#	source/How-To-Guides/Migrating-from-ROS1/Migrating-CPP-Packages.rst
This was referenced Oct 1, 2024
Merged
Merged
mergify bot pushed a commit that referenced this pull request Oct 1, 2024
@sloretz @mergify
Split ROS 1 -> 2 C++ page into a reference page and a tutorial page (#…
de232e5 
…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 <[email protected]>
(cherry picked from commit 4e7e865)

# Conflicts:
#	source/How-To-Guides/Migrating-from-ROS1/Migrating-CPP-Packages.rst
@mergify mergify bot mentioned this pull request Oct 1, 2024
Merged
clalancette pushed a commit that referenced this pull request Oct 1, 2024
@mergify @sloretz
Split ROS 1 -> 2 C++ page into a reference page and a tutorial page (#…
023a3e4 
…4779) (#4792)

* 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 <[email protected]>
(cherry picked from commit 4e7e865)

Co-authored-by: Shane Loretz <[email protected]>
clalancette pushed a commit that referenced this pull request Oct 1, 2024
@sloretz @clalancette
Split ROS 1 -> 2 C++ page into a reference page and a tutorial page (#…
c28c9e0 
…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 <[email protected]>
(cherry picked from commit 4e7e865)
clalancette pushed a commit that referenced this pull request Oct 1, 2024
@sloretz @clalancette
Split ROS 1 -> 2 C++ page into a reference page and a tutorial page (#…
bdff315 
…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 <[email protected]>
(cherry picked from commit 4e7e865)

# Conflicts:
#	source/How-To-Guides/Migrating-from-ROS1/Migrating-CPP-Packages.rst
clalancette pushed a commit that referenced this pull request Oct 1, 2024
@mergify @sloretz
Split ROS 1 -> 2 C++ page into a reference page and a tutorial page (#…
3b6b64c 
…4779) (#4793)

* 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 <[email protected]>
(cherry picked from commit 4e7e865)

Co-authored-by: Shane Loretz <[email protected]>
clalancette pushed a commit that referenced this pull request Oct 1, 2024
@mergify @sloretz
Split ROS 1 -> 2 C++ page into a reference page and a tutorial page (#…
22f24ff 
…4779) (#4794)

* 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 <[email protected]>
(cherry picked from commit 4e7e865)

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

Co-authored-by: Shane Loretz <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@christophebedard christophebedard christophebedard left review comments

@fujitatomoya fujitatomoya fujitatomoya approved these changes

@clalancette clalancette clalancette approved these changes

@audrow audrow Awaiting requested review from audrow audrow is a code owner

Assignees

@sloretz sloretz

Labels
backport-all backport at reviewers discretion; from rolling to all versions
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@sloretz @clalancette @christophebedard @fujitatomoya