ros2_documentation icon indicating copy to clipboard operation
ros2_documentation copied to clipboard

Updates (may be) required

Open mjeronimo opened this issue 3 years ago • 0 comments

Reviewing the ROS 2 documentation, the following sections may need updates:

Concepts/About-Catment.html

  • This page has a few TODO items. Are they still current?

Concepts/About-Internal-Interfaces.html

  • "The ROSIDL repository" - has a warning box with a TODO item.

Concepts/About-ROS-Interfaces.html^

  • There is a Warning TODO box at the bottom of the page. Can the links be provided?

Concepts/About-Command-Line-Tools.html

  • "Usage" - the sub-command list is not current

Concepts/About-Logging.html

  • "Overview" - "File output and functionality akin to rosout for remote consumtion of messages is forthcoming" Is this out of date? Has it been implemented?
  • "Overview" - "config files and external configuration at rum-time is forthcoming" Is this current?

Guides/RQt-Source-Install.html

  • Instructions mention 'Crystal Clemmys" and should be updated for Galactic, Ubuntu version, correct repositories, etc.

Concepts/About-Domain-ID.html

  • "Participant constraints" - "For each ROS 2 process running on a computer, one DDS particpant is created." Is this now true for all DDS-based MW providers?

Guides/Ament-CMake-Documentation.html

  • "Compiler and linker options" - "ROS 2 targets compilers which comply with the C++14..." - We're targeting C++17 with Galactic, correct? Should also probably say that "ROS 2 Galactic targets..." since the targeted C++ version will be different for different releases.

Guides/Run-2-nodes-in-single-or-separate-docker-containers.html

  • "Running ROS 2 nodes in Docker [community-contributed]" - Why is it important to note that this is a community contribution? Is this to give the author some kudos? Or, is it to disclaim responsibility for the context? I recommend simply removing "[community contributed]".
  • The page references eloquent multiple times; needs to be updated

mjeronimo avatar May 10 '21 21:05 mjeronimo