-
Notifications
You must be signed in to change notification settings - Fork 1.2k
docs: Enhance ROS 2 documentation clarity and consistency (Issue #1487) #5383
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
base: rolling
Are you sure you want to change the base?
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -32,7 +32,7 @@ All ROS 2 packages begin by running the command | |
|
||
$ ros2 pkg create --license Apache-2.0 <pkg-name> --dependencies [deps] | ||
|
||
in your workspace (usually ``~/ros2_ws/src``). | ||
in your workspace (e.g., ``~/your_project_ws/src``). | ||
|
||
To create a package for a specific client library: | ||
|
||
|
@@ -61,7 +61,7 @@ You will mostly use the ``add_executable()`` CMake macro along with | |
|
||
target_link_libraries(<executable-name> PUBLIC [targets from your dependencies]) | ||
|
||
to create executable nodes and link dependencies. | ||
to create executable nodes and link dependencies. CMake, when used with `ament_target_dependencies` or similar functions, also automatically manages the necessary include directories for your targets. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. we are actually moving away from |
||
|
||
To install your launch files and nodes, you can use the ``install()`` macro placed towards the end of the file but before the ``ament_package()`` macro. | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -43,20 +43,8 @@ If the first command did not return a response similar to: | |
|
||
Received from xx.xxx.xxx.xx:43751: 'Hello World!' | ||
|
||
then you will need to update your firewall configuration to allow multicast using `ufw <https://help.ubuntu.com/community/UFW>`__. | ||
|
||
.. code-block:: console | ||
|
||
$ sudo ufw allow in proto udp to 224.0.0.0/4 | ||
$ sudo ufw allow in proto udp from 224.0.0.0/4 | ||
|
||
|
||
You can check if the multicast flag is enabled for your network interface using the :code:`ifconfig` tool and looking for :code:`MULTICAST` in the flags section: | ||
|
||
.. code-block:: bash | ||
|
||
eno1: flags=4163<...,MULTICAST> | ||
... | ||
then multicast may not be enabled or properly configured on your system. | ||
If the check above fails, refer to the platform-specific sections below for guidance on enabling multicast and configuring your firewall. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. i do not like breaking the sections like this especially for trouble-shooting. i think it would be more useful to keep the trouble-shooting one by one to put all the information together. if that is recognized to Linux specific trouble-shooting maybe we can add the trouble-shooting for other platforms in here? |
||
|
||
Import failing without library present on the system | ||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
@@ -74,6 +62,24 @@ Then, rebuilding the workspace may fix the issue. | |
Linux | ||
----- | ||
|
||
Enable multicast | ||
^^^^^^^^^^^^^^^^ | ||
|
||
If the general multicast check fails, you may need to update your firewall configuration to allow multicast using `ufw <https://help.ubuntu.com/community/UFW>`__. | ||
|
||
.. code-block:: console | ||
|
||
$ sudo ufw allow in proto udp to 224.0.0.0/4 | ||
$ sudo ufw allow in proto udp from 224.0.0.0/4 | ||
|
||
|
||
You can check if the multicast flag is enabled for your network interface using the :code:`ifconfig` tool and looking for :code:`MULTICAST` in the flags section: | ||
|
||
.. code-block:: bash | ||
|
||
eno1: flags=4163<...,MULTICAST> | ||
... | ||
|
||
Internal compiler error | ||
^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
||
|
@@ -247,6 +253,7 @@ To resolve this error, you will need to: | |
|
||
rosdep install error ``homebrew: Failed to detect successful installation of [qt5]`` | ||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
||
While following the :doc:`Creating a workspace <../Tutorials/Beginner-Client-Libraries/Creating-A-Workspace/Creating-A-Workspace>` tutorial, you might encounter the following error stating that ``rosdep`` fails to install Qt5. | ||
|
||
.. code-block:: console | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -12,9 +12,9 @@ ROS 2 Documentation | |
|
||
Installation | ||
Releases | ||
Concepts | ||
Tutorials | ||
How-To-Guides | ||
Concepts | ||
Contact | ||
The-ROS2-Project | ||
Package-Docs | ||
|
@@ -27,7 +27,7 @@ ROS 2 Documentation | |
From drivers and state-of-the-art algorithms to powerful developer tools, ROS has the open source tools you need for your next robotics project. | ||
|
||
Since ROS was started in 2007, a lot has changed in the robotics and ROS community. | ||
The goal of the ROS 2 project is to adapt to these changes, leveraging what is great about ROS 1 and improving what isn't. | ||
The goal of the ROS 2 project is to adapt to these changes, leveraging what is great about ROS 1 and improving what isn\'t. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. why is this required? i see many other places like this... |
||
|
||
**Are you looking for documentation for a particular ROS package like MoveIt, image_proc, or octomap?** | ||
Please see `ROS Index <https://index.ros.org/?search_packages=true#{DISTRO}>`__ or check out `this index of per-package documentation <https://docs.ros.org/en/{DISTRO}/p/>`__. | ||
|
@@ -44,6 +44,10 @@ Getting started | |
|
||
- Instructions to set up ROS 2 for the first time | ||
|
||
* :doc:`Concepts <Concepts>` | ||
|
||
- High-level explanations of core ROS 2 concepts covered in the :doc:`Tutorials <Tutorials>` | ||
|
||
* :doc:`Tutorials <Tutorials>` | ||
|
||
- The best place to start for new users! | ||
|
@@ -54,10 +58,6 @@ Getting started | |
- Quick answers to your "How do I...?" | ||
questions without working through the :doc:`Tutorials <Tutorials>` | ||
|
||
* :doc:`Concepts <Concepts>` | ||
|
||
- High-level explanations of core ROS 2 concepts covered in the :doc:`Tutorials <Tutorials>` | ||
|
||
* :doc:`Contact <Contact>` | ||
|
||
- Answers to your questions or a forum to start a discussion | ||
|
@@ -66,11 +66,14 @@ Getting started | |
The ROS 2 project | ||
----------------- | ||
|
||
If you're interested in the advancement of the ROS 2 project: | ||
Information about the ROS 2 project: | ||
|
||
* :doc:`Contributing <The-ROS2-Project/Contributing>` | ||
|
||
- Best practices and methodology for contributing to ROS 2, as well as instructions for migrating existing ROS 1 content to ROS 2 | ||
- Best practices and methodology for contributing to ROS 2 (including code, documentation, and other content), as well as instructions for migrating existing ROS 1 content to ROS 2 | ||
|
||
Development and Status | ||
~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
* :doc:`Distributions <Releases>` | ||
|
||
|
@@ -92,6 +95,9 @@ If you're interested in the advancement of the ROS 2 project: | |
|
||
- Presentations by the community on ROS 2 | ||
|
||
Governance and Marketing | ||
~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
* :doc:`Project Governance <The-ROS2-Project/Governance>` | ||
|
||
- Information about the ROS Technical Steering Committee, Working Groups, and upcoming events | ||
|
@@ -121,8 +127,8 @@ If you need help, have an idea, or would like to contribute to the project, plea | |
|
||
- Indexed list of all packages (i.e. `Python Package Index (PyPI) <https://pypi.org/>`_ for ROS packages) | ||
- See which ROS distributions a package supports | ||
- Link to a package's repository, API documentation, or website | ||
- Inspect a package's license, build type, maintainers, status, and dependencies | ||
- Link to a package\'s repository, API documentation, or website | ||
- Inspect a package\'s license, build type, maintainers, status, and dependencies | ||
- Get more info for a package on `Robotics Stack Exchange <https://robotics.stackexchange.com/>`__ | ||
|
||
* `ROS resource status page <https://status.openrobotics.org/>`__ (ROS 1, ROS 2) | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this generates the error, https://github.com/ros2/ros2_documentation/actions/runs/14690428802/job/41233590169?pr=5383