3di | Input needed for 'About' tools articles - #6974
3di | Input needed for 'About' tools articles #6974sarahfarnborough-3di wants to merge 14 commits into
Conversation
| * `tracetools <https://docs.ros.org/en/kilted/p/tracetools/>`_: Trace points for creating and debugging execution traces. | ||
|
|
||
| * `rosbag2 <https://docs.ros.org/en/kilted/p/rosbag2/>`_: Record and play back data moving across topics, services and actions in a ROS application, for later visualization and debugging. | ||
| QUESTION FOR THE REVIEWER: ARE THERE ANY OTHER CORE ROS PACKAGES THAT WE CAN LIST HERE? |
There was a problem hiding this comment.
Introspection via ros2 cli commands such as topic node param action pkg service etc https://github.com/ros2/ros2cli
GUIs
rviz + default plugins: https://github.com/ros2/rviz/blob/rolling/rviz_default_plugins/plugins_description.xml
rqt_gui + plugins. See Dependent Packages: https://index.ros.org/p/rqt_gui/#rolling-deps some are built in some are not.
| Community-contributed packages: | ||
|
|
||
| * `PlotJuggler <https://docs.ros.org/en/kilted/p/plotjuggler/>`_: A tool for visualizing and analyzing data from ROS applications. | ||
| QUESTION FOR THE REVIEWER: ARE THERE ANY OTHER COMMUNITY-CONTRIBUTED PACKAGES THAT WE CAN LIST HERE? |
There was a problem hiding this comment.
Foxglove, rerun, some of the above rqt and community rviz provided plugins. We can start with a short list and expand over time.
| @@ -0,0 +1,42 @@ | |||
| Analysis | |||
There was a problem hiding this comment.
I'm not sure it makes sense to call out analysis tools separately from the debugging ones. It's going to be basically the same list.
| * `ament_cmake <https://docs.ros.org/en/lyrical/How-To-Guides/Ament-CMake-Documentation.html>`_: Build system for CMake-based packages in ROS. | ||
|
|
||
| * `rosdoc2 <https://docs.ros.org/en/rolling/How-To-Guides/Documenting-a-ROS-2-Package.html>`_: Tool for documenting a ROS package. | ||
| QUESTION FOR THE REVIEWER: IN THE SPREADSHEET THERE IS A QUESTION MARK NEXT TO THIS ENTRY. |
There was a problem hiding this comment.
No rosdoc2 is a documentation tool not a build tool.
|
|
||
| * `colcon <https://docs.ros.org/en/lyrical/Tutorials/Beginner-Client-Libraries/Colcon-Tutorial.html>`_: Tool for creating and building a ROS workspace. | ||
|
|
||
| * `ament_cmake <https://docs.ros.org/en/lyrical/How-To-Guides/Ament-CMake-Documentation.html>`_: Build system for CMake-based packages in ROS. |
There was a problem hiding this comment.
| * `ament_cmake <https://docs.ros.org/en/lyrical/How-To-Guides/Ament-CMake-Documentation.html>`_: Build system for CMake-based packages in ROS. | |
| * `ament_cmake <https://docs.ros.org/en/lyrical/How-To-Guides/Ament-CMake-Documentation.html>`_: A CMake library to facilitate inter package dependencies in ROS. |
|
|
||
| Community-contributed packages: | ||
|
|
||
| QUESTION FOR THE REVIEWER: ARE THERE ANY COMMUNITY-CONTRIBUTED PACKAGES THAT WE CAN LIST HERE? |
There was a problem hiding this comment.
I would flag the extra one above as potentially community contribued inline versus a whole separate section.
| Core ROS packages: | ||
|
|
||
| * `ros2launch <https://github.com/ros2/launch>`_: Command line tool for launching multiple processes and for writing tests involving multiple processes. | ||
| QUESTION FOR THE REVIEWER: ARE THERE ANY OTHER CORE ROS PACKAGES THAT WE CAN LIST HERE? |
| QUESTION FOR THE REVIEWER: ARE THERE ANY OTHER CORE ROS PACKAGES THAT WE CAN LIST HERE? | ||
|
|
||
| Community-contributed packages: | ||
| QUESTION FOR THE REVIEWER: ARE THERE ANY COMMUNITY-CONTRIBUTED PACKAGES THAT WE CAN LIST HERE? |
There was a problem hiding this comment.
there aren't heavily used ones at the moment.
| Core ROS packages: | ||
|
|
||
| * `rosdoc2 <https://docs.ros.org/en/rolling/How-To-Guides/Documenting-a-ROS-2-Package.html>`_: Tool for documenting a ROS package. | ||
| QUESTION FOR THE REVIEWER: IN THE SPREADSHEET THERE IS A QUESTION MARK NEXT TO THIS ENTRY. |
There was a problem hiding this comment.
I'd like to focus people on rosdoc2
|
|
||
| * `RViz <https://docs.ros.org/en/kilted/Tutorials/Intermediate/RViz/RViz-User-Guide/RViz-User-Guide.html>`_: Provides a 3D visualization of the robot's perspective, including sensor data and intentions. | ||
|
|
||
| QUESTION FOR THE REVIEWER: ARE THERE ANY OTHER CORE ROS PACKAGES THAT WE CAN LIST HERE? |
There was a problem hiding this comment.
see the links above for debugging with rviz and rqt and foxglove and rerun they can be added here too Or maybe add them here and link to here from the debugging.
2 participants
3di | About articles for tools
Hello @tully @mjcarroll
This pull request is a draft because it is a request for input rather than a review. We are not requesting a review of the articles at this point.
We have drafted the following tools articles and identified the areas where we need your input using 'QUESTION FOR THE REVIEWER' tags.
Related to: #6826
Did you use Generative AI?
No
Additional Information
Documentation updates from 3di Information Solutions, agreed with Geoff and Tully.