Skip to content

docs: fix broken external links in tutorial and developer guide pages - #7032

Open
camirian wants to merge 1 commit into
ros2:rollingfrom
camirian:docs/fix-current-tutorial-links
Open

docs: fix broken external links in tutorial and developer guide pages#7032
camirian wants to merge 1 commit into
ros2:rollingfrom
camirian:docs/fix-current-tutorial-links

Conversation

@camirian

Copy link
Copy Markdown

Summary

Fixes a bounded subset of broken external links in active tutorial and developer guide pages.

Ref: #4209

Scope of Changes

  • source/Developer-Tools/Testing/Testing/Integration.rst: Update broken Gazebo website link (https://gazebosim.org/home -> https://gazebosim.org)
  • source/Get-Started/About-ROS/About-ROS.rst: Update broken Gazebo website link (https://gazebosim.org/home -> https://gazebosim.org)
  • source/ROS-Framework/client-libraries/About-Middleware-Implementations.rst: Update broken OMG spec URL (https://www.omg.org/spec/DDS-XTypes/ -> https://www.omg.org/spec/DDS-XTypes/About-DDS-XTypes/)
  • source/The-ROS2-Project/Contributing/Developer-Guide.rst: Update dead trivial-fixes link (http://cr.openjdk.java.net/~jrose/draft/trivial-fixes.html -> https://openjdk.org/bylaws#trivial-change)
  • source/The-ROS2-Project/Contributing/Developer-Guide.rst: Update dead sscce link (http://sscce.org/ -> https://stackoverflow.com/help/minimal-reproducible-example)
  • source/ROS-Framework/interfaces/topics/Working-with-topics/Quality-of-Service.rst: Update broken OpenCV tutorial link (http://docs.opencv.org/... -> https://docs.opencv.org/4.x/) and die.net tc man page link (http://linux.die.net/man/8/tc -> https://man7.org/linux/man-pages/man8/tc.8.html)

Exclusions

Local Validation Results

  • ros2doc/bin/python3 -m sphinx -b html -c . source build/html: PASSED (0 build errors)
  • PATH=ros2doc/bin:$PATH PYTHONPATH=. ros2doc/bin/python ./sphinx-lint-with-ros source: PASSED (0 problems found)
  • git ls-files '*.md' '*.rst' \| xargs ros2doc/bin/codespell --config codespell.cfg: PASSED (0 spelling errors)

Signed-off-by: Caaren Amirian <153974602+camirian@users.noreply.github.com>
@camirian
camirian marked this pull request as ready for review July 30, 2026 22:13

@kscottz kscottz left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am ok with most of these except the last one. Can you provide more context here?


- Include a list of steps to reproduce the issue.
- In case of a bug consider to provide a `short, self contained, correct (compilable), example <http://sscce.org/>`__.
- In case of a bug consider to provide a `short, self contained, correct (compilable), example <https://stackoverflow.com/help/minimal-reproducible-example>`__.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm a little unclear why we would change this link. It is not broken.

@fujitatomoya fujitatomoya left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@camirian i need to ask you how you confirmed that those are actual broken links?

----------

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 <https://gazebosim.org/home>`__ and the `Nav2 navigation <https://github.com/ros-planning/navigation2.git>`__ stack.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://gazebosim.org/home is not broken link?

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_<language>`` 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 <https://www.omg.org/spec/DDS-XTypes/>`_.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here, https://www.omg.org/spec/DDS-XTypes/ is not a broken link?

-------------
This tutorial assumes you have a :doc:`working ROS 2 installation <../../../../Get-Started/Installation>` and OpenCV.
See the `OpenCV documentation <http://docs.opencv.org/doc/tutorials/introduction/table_of_content_introduction/table_of_content_introduction.html#table-of-content-introduction>`__ for its installation instructions.
See the `OpenCV documentation <https://docs.opencv.org/4.x/>`__ for its installation instructions.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


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" <http://jagt.github.io/clumsy/index.html>`_, respectively, but they will not be covered in this tutorial.

We are going to use the Linux network traffic control utility, ``tc`` (`man page <http://linux.die.net/man/8/tc>`_) .

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is not broke link.


* You can pass ``-s`` / ``--signoff`` to the ``git commit`` invocation or write the expected message manually (e.g. ``Signed-off-by: Your Name Developer <your.name@example.com>``).

* DCO is *not* required for pull requests that only address whitespace removal, typo correction, and other `trivial changes <http://cr.openjdk.java.net/~jrose/draft/trivial-fixes.html>`_.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same here , this is not broken link.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants