From f0826f6919097a3230297884054c1b5d9da7744f Mon Sep 17 00:00:00 2001 From: Caaren Amirian <153974602+camirian@users.noreply.github.com> Date: Thu, 30 Jul 2026 14:56:04 -0700 Subject: [PATCH] docs: fix broken external links in tutorial and developer guide pages Signed-off-by: Caaren Amirian <153974602+camirian@users.noreply.github.com> --- source/Developer-Tools/Testing/Testing/Integration.rst | 2 +- source/Get-Started/About-ROS/About-ROS.rst | 2 +- .../client-libraries/About-Middleware-Implementations.rst | 2 +- .../topics/Working-with-topics/Quality-of-Service.rst | 4 ++-- source/The-ROS2-Project/Contributing/Developer-Guide.rst | 4 ++-- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/source/Developer-Tools/Testing/Testing/Integration.rst b/source/Developer-Tools/Testing/Testing/Integration.rst index 637f7d902bc..30e5b21e0ee 100644 --- a/source/Developer-Tools/Testing/Testing/Integration.rst +++ b/source/Developer-Tools/Testing/Testing/Integration.rst @@ -27,7 +27,7 @@ Background ---------- Where unit tests focus on validating a very specific piece of functionality, integration tests focus on validating the interaction between pieces of code. -In ROS 2 this is often accomplished by launching a system of one or several nodes, for example the `Gazebo simulator `__ and the `Nav2 navigation `__ stack. +In ROS 2 this is often accomplished by launching a system of one or several nodes, for example the `Gazebo simulator `__ and the `Nav2 navigation `__ stack. As a result, these tests are more complex both to set up and to run. A key aspect of ROS 2 integration testing is that nodes that are part of different tests shouldn't communicate with each other, even when run in parallel. diff --git a/source/Get-Started/About-ROS/About-ROS.rst b/source/Get-Started/About-ROS/About-ROS.rst index 25ef3ddf47e..4ea71b22621 100644 --- a/source/Get-Started/About-ROS/About-ROS.rst +++ b/source/Get-Started/About-ROS/About-ROS.rst @@ -109,7 +109,7 @@ ROS works with other Open Robotics platforms to make development and deployment * `Open-RMF`_ (Robotics Middleware Framework): Helps different robots work together and interact with building systems like lifts and doors. * `ros-controls`_: Enables real-time control of robots using ROS. -.. _Gazebo: https://gazebosim.org/home +.. _Gazebo: https://gazebosim.org .. _Open-RMF: https://www.open-rmf.org/ .. _ros-controls: https://control.ros.org/rolling/index.html diff --git a/source/ROS-Framework/client-libraries/About-Middleware-Implementations.rst b/source/ROS-Framework/client-libraries/About-Middleware-Implementations.rst index 579d2fae7c1..2699b3a0a7d 100644 --- a/source/ROS-Framework/client-libraries/About-Middleware-Implementations.rst +++ b/source/ROS-Framework/client-libraries/About-Middleware-Implementations.rst @@ -57,7 +57,7 @@ It also generates code for converting ROS message structures to and from DDS mes This generator is also responsible for creating a shared library for the message package it is being used in, which is specific to the messages in the message package and to the DDS vendor being used. As mentioned above, the ``rosidl_typesupport_introspection_`` may be used instead of a vendor specific type support package if an RMW implementation supports runtime interpretation of messages. -This ability to programmatically send and receive types over topics without generating code beforehand is achieved by supporting the `DDS X-Types Dynamic Data standard `_. +This ability to programmatically send and receive types over topics without generating code beforehand is achieved by supporting the `DDS X-Types Dynamic Data standard `_. As such, RMW implementations may provide support for the X-Types standard, and/or provide a package for type support generated at compile time specific to their DDS implementation. For examples of example of DDS RMW implementation repositories, diff --git a/source/ROS-Framework/interfaces/topics/Working-with-topics/Quality-of-Service.rst b/source/ROS-Framework/interfaces/topics/Working-with-topics/Quality-of-Service.rst index 1c64ca8e934..48f058d0b08 100644 --- a/source/ROS-Framework/interfaces/topics/Working-with-topics/Quality-of-Service.rst +++ b/source/ROS-Framework/interfaces/topics/Working-with-topics/Quality-of-Service.rst @@ -23,7 +23,7 @@ We will then simulate a lossy network connection between them and show how diffe Prerequisites ------------- This tutorial assumes you have a :doc:`working ROS 2 installation <../../../../Get-Started/Installation>` and OpenCV. -See the `OpenCV documentation `__ for its installation instructions. +See the `OpenCV documentation `__ for its installation instructions. You will also need the ROS package ``image_tools``. .. tabs:: @@ -157,7 +157,7 @@ Add network traffic However, for macOS and Windows you can achieve a similar effect with the utilities "Network Link Conditioner" (part of the xcode tool suite) and `"Clumsy" `_, respectively, but they will not be covered in this tutorial. -We are going to use the Linux network traffic control utility, ``tc`` (`man page `_) . +We are going to use the Linux network traffic control utility, ``tc`` (`man page `_) . .. code-block:: console diff --git a/source/The-ROS2-Project/Contributing/Developer-Guide.rst b/source/The-ROS2-Project/Contributing/Developer-Guide.rst index 2f60abb9290..acad8aaa03a 100644 --- a/source/The-ROS2-Project/Contributing/Developer-Guide.rst +++ b/source/The-ROS2-Project/Contributing/Developer-Guide.rst @@ -153,7 +153,7 @@ Change control process * You can pass ``-s`` / ``--signoff`` to the ``git commit`` invocation or write the expected message manually (e.g. ``Signed-off-by: Your Name Developer ``). - * DCO is *not* required for pull requests that only address whitespace removal, typo correction, and other `trivial changes `_. + * DCO is *not* required for pull requests that only address whitespace removal, typo correction, and other `trivial changes `_. * Always run CI jobs for all `tier 1 platforms `_ for every pull request and include links to jobs in the pull request. (If you don't have access to the Jenkins jobs someone will trigger the jobs for you.) @@ -294,7 +294,7 @@ When filing an issue please make sure to: Reasoning: This helps us narrow down the layer in the stack at which the issue might be. - Include a list of steps to reproduce the issue. -- In case of a bug consider to provide a `short, self contained, correct (compilable), example `__. +- In case of a bug consider to provide a `short, self contained, correct (compilable), example `__. Issues are much more likely to be resolved if others can reproduce them easily. - Mention troubleshooting steps that have been tried already, including: