From 1834b79c14f2a068f7fbee6e3cbfb06e30a27f5c Mon Sep 17 00:00:00 2001 From: Sebastian Castro <4603398+sea-bass@users.noreply.github.com> Date: Wed, 25 Oct 2023 09:29:05 -0400 Subject: [PATCH] Fix broken URLs in tutorials docs (#798) --- ...ning_with_approximated_constraint_manifolds_tutorial.rst | 2 +- doc/how_to_guides/isaac_panda/isaac_panda_tutorial.rst | 6 +++--- doc/tutorials/getting_started/getting_started.rst | 4 ++++ .../quickstart_in_rviz/quickstart_in_rviz_tutorial.rst | 4 +++- 4 files changed, 11 insertions(+), 5 deletions(-) diff --git a/doc/examples/planning_with_approximated_constraint_manifolds/planning_with_approximated_constraint_manifolds_tutorial.rst b/doc/examples/planning_with_approximated_constraint_manifolds/planning_with_approximated_constraint_manifolds_tutorial.rst index 2d1fe8b570..8f99a571ed 100644 --- a/doc/examples/planning_with_approximated_constraint_manifolds/planning_with_approximated_constraint_manifolds_tutorial.rst +++ b/doc/examples/planning_with_approximated_constraint_manifolds/planning_with_approximated_constraint_manifolds_tutorial.rst @@ -124,7 +124,7 @@ Such a constraint is compactly defined like this:: Running the database generator ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Assuming MoveIt itself is already launched (via eg. ``roslaunch X_moveit_config demo.launch``), you can use a launch file similar to `generate_state_database.launch `_ +Assuming MoveIt itself is already launched (via eg. ``roslaunch X_moveit_config demo.launch``), you can use a launch file similar to :moveit_codedir:`generate_state_database.launch `. The file with the constraint definitions can be passed to the launch file:: diff --git a/doc/how_to_guides/isaac_panda/isaac_panda_tutorial.rst b/doc/how_to_guides/isaac_panda/isaac_panda_tutorial.rst index dc5b7bef66..0fcba7f815 100644 --- a/doc/how_to_guides/isaac_panda/isaac_panda_tutorial.rst +++ b/doc/how_to_guides/isaac_panda/isaac_panda_tutorial.rst @@ -56,19 +56,19 @@ updated to load the ``TopicBasedSystem`` plugin when the flag ``ros2_control_har In this tutorial we have included a Python script that loads a Panda robot -and builds an `OmniGraph `_ +and builds an `OmniGraph `_ to publish and subscribe to the ROS topics used to control the robot. The OmniGraph also contains nodes to publish RGB and Depth images from the camera mounted on the hand of the Panda. The RGB image is published to the topic ``/rgb``, the camera info to ``/camera_info``, and the depth image to ``/depth``. The frame ID of the camera frame is ``/sim_camera``. To learn about configuring your Isaac Sim robot to communicate with ROS 2 please see the -`Joint Control tutorial `_ +`Joint Control tutorial `_ on Omniverse. Computer Setup -------------- -1. Install `Isaac Sim `_. +1. Install `Isaac Sim `_. 2. Perform a shallow clone of the MoveIt2 Tutorials repo. diff --git a/doc/tutorials/getting_started/getting_started.rst b/doc/tutorials/getting_started/getting_started.rst index 4f90b24b7c..8492b0af6c 100644 --- a/doc/tutorials/getting_started/getting_started.rst +++ b/doc/tutorials/getting_started/getting_started.rst @@ -49,6 +49,8 @@ Install `vcstool `_ : :: sudo apt install python3-vcstool +.. _create_colcon_workspace: + Create A Colcon Workspace and Download Tutorials ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ For tutorials you will need to have a :ros_documentation:`colcon ` workspace setup. :: @@ -106,6 +108,8 @@ Optional: add the previous command to your ``.bashrc``: :: not required and often skipped by advanced users who use more than one Colcon workspace at a time, but we recommend it for simplicity. +.. _cyclone_dds: + Switch to Cyclone DDS ^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/tutorials/quickstart_in_rviz/quickstart_in_rviz_tutorial.rst b/doc/tutorials/quickstart_in_rviz/quickstart_in_rviz_tutorial.rst index e5af9d01c1..e9e8c82f5b 100644 --- a/doc/tutorials/quickstart_in_rviz/quickstart_in_rviz_tutorial.rst +++ b/doc/tutorials/quickstart_in_rviz/quickstart_in_rviz_tutorial.rst @@ -7,7 +7,9 @@ This tutorial will teach you how to create motion plans in MoveIt using RViz and Getting Started --------------- -If you haven't already done so, make sure you've completed the steps in :doc:`Getting Started ` or our :doc:`Docker Guide `. If you followed the Docker Guide, also follow the second part of the Getting Started tutorial (from :ref:`Create a Colcon Workspace and Download Tutorials ` onwards) to set up the tutorials. As of Sep 26, 2022, ensure you have enabled Cyclone DDS as described there. +If you haven't already done so, make sure you've completed the steps in :doc:`Getting Started ` or our :doc:`Docker Guide `. +If you followed the Docker Guide, also follow the :ref:`create_colcon_workspace` guide onwards to set up the tutorials. +As of Sep 26, 2022, ensure you have :ref:`enabled Cyclone DDS `. Step 1: Launch the Demo and Configure the Plugin ------------------------------------------------