ros2_documentation icon indicating copy to clipboard operation
ros2_documentation copied to clipboard

:books: Adding some documentation suggestions following issue #1487

Open carlowiesse opened this issue 3 years ago • 1 comments

Changes made based on the following comment in issue #1487.

Tutorials/Configuring-ROS2-Environment.html

Removed the lines calling the core ROS 2 workspace underlay and the other local workspaces overlays to avoid the possible confusion as explained in comment.

Guides/Installation-Troubleshooting.html

Added a note about the firewall configuration not being applicable to Windows.

Guides/Developing-a-ROS-2-Package.html

Added a note recommending to name workspaces based on project specifics instead of simply ros2_ws.

Concepts/About-Composition.html

Following this comment, I further divided the most common components based on when they are being used (during compile time, launch time or run time).

carlowiesse avatar Jul 06 '22 06:07 carlowiesse

I would probably suggest splitting this into multiple separate commits.

At least one per page you're editing.

Or perhaps even doing what @clalancette suggests in https://github.com/ros2/ros2_documentation/issues/1487#issuecomment-940950358:

This is still open, so feel free to contribute. I'll suggest doing a separate pull request for each of the items, so that it is easier to review.

gavanderhoorn avatar Jul 06 '22 09:07 gavanderhoorn

No response in a couple of months here, so I'm going to close this out. Feel free to reopen with the changes suggested in review.

clalancette avatar Sep 28 '22 19:09 clalancette