diff --git a/doc/how_to_guides/how_to_setup_docker_containers_in_ubuntu.rst b/doc/how_to_guides/how_to_setup_docker_containers_in_ubuntu.rst index 47faaa5b1b..8731df943e 100644 --- a/doc/how_to_guides/how_to_setup_docker_containers_in_ubuntu.rst +++ b/doc/how_to_guides/how_to_setup_docker_containers_in_ubuntu.rst @@ -31,9 +31,9 @@ Steps .. code-block:: bash - DOCKER_IMAGE=humble-tutorial docker compose run --rm --name moveit2_container gpu + DOCKER_IMAGE={DISTRO}-tutorial docker compose run --rm --name moveit2_container gpu - You can replace ``humble-tutorial`` with other tagged images, e.g. ``rolling-tutorial``. Similarly, you can replace ``gpu`` with ``cpu`` if you do not wish to run using Nvidia GPU drivers and you can change the name of the container by replacing ``moveit2_container``. The ``--rm`` argument will remove the container when you stop (or exit) it, otherwise you can keep your modified container on disk and start it using ``docker start moveit2_container`` + You can replace ``{DISTRO}-tutorial`` with other tagged images, e.g. ``rolling-tutorial``. Similarly, you can replace ``gpu`` with ``cpu`` if you do not wish to run using Nvidia GPU drivers and you can change the name of the container by replacing ``moveit2_container``. The ``--rm`` argument will remove the container when you stop (or exit) it, otherwise you can keep your modified container on disk and start it using ``docker start moveit2_container`` 4. You should now be inside of your Docker container, in the workspace directory, with the completed :doc:`Planning Around Objects ` and :doc:`Pick and Place with MoveIt Task Constructor ` tutorials. Go ahead and try one of the launch commands like ``ros2 launch moveit2_tutorials demo.launch.py`` @@ -49,7 +49,7 @@ Further Reading refer to `this blog post `_ from PickNik's Vatan Aksoy Tezer and Brennard Pierce. -- You can find a list of tagged tutorial images `here `__. There are tagged images for both ``rolling`` and ``humble`` which are built on top of the ``rolling-source`` and ``humble-source`` MoveIt 2 Docker images `here `__. +- You can find a list of tagged tutorial images `here `__. There are tagged images for both ``rolling`` and ``{DISTRO}`` which are built on top of the ``rolling-source`` and ``{DISTRO}-source`` MoveIt 2 Docker images `here `__. - You can find more tagged images for MoveIt 2 Docker containers `here `__. The tagged images coincide with ROS2 version releases. The ``release`` version of the container provides an environment in which MoveIt 2 is installed via the binaries. diff --git a/doc/tutorials/getting_started/getting_started.rst b/doc/tutorials/getting_started/getting_started.rst index 2b42edcd40..d3db026ae7 100644 --- a/doc/tutorials/getting_started/getting_started.rst +++ b/doc/tutorials/getting_started/getting_started.rst @@ -10,7 +10,7 @@ Install ROS 2 and Colcon :ros_documentation:`Install ROS 2 {DISTRO_TITLE}`. It is easy to miss steps when going through the ROS 2 installation tutorial. If you run into errors in the next few steps, a good place to start is to go back and make sure you have installed ROS 2 correctly. One that users commonly forget is to source the ROS 2 install itself. :: - source /opt/ros/humble/setup.bash + source /opt/ros/{DISTRO}/setup.bash .. note:: Unlike ROS 1 setup scripts, in ROS 2 the setup scripts do not attempt to switch what version of ROS you are using. This means that if you have previously sourced a different version of ROS, including from within your ``.bashrc`` file, you will run into errors during the building step. To fix this change what is sourced in your ``.bashrc`` and start a new terminal. @@ -47,7 +47,7 @@ Download Source Code of MoveIt and the Tutorials Move into your Colcon workspace and pull the MoveIt tutorials source: :: cd ~/ws_moveit2/src - git clone -b humble https://github.com/ros-planning/moveit2_tutorials + git clone --branch {DISTRO} https://github.com/ros-planning/moveit2_tutorials Next we will download the source code for the rest of MoveIt: :: @@ -68,7 +68,7 @@ The next command will configure your Colcon workspace: :: This build command will likely take a long time (20+ minutes) depending on your computer speed and amount of RAM available (we recommend 32 GB). If you are short on computer memory or generally your build is struggling to complete on your computer, you can append the argument ``--parallel-workers 1`` to the colcon command above. -If everything goes well, you should see the message "finished". If you have problems, try re-checking your `ROS Installation `_. +If everything goes well, you should see the message "finished". If you have problems, try re-checking your `ROS Installation `_. Setup Your Colcon Workspace ^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -90,7 +90,7 @@ Switch to Cyclone DDS As of Sep 26, 2022, the default ROS 2 middleware (RMW) implementation has an issue. As a workaround, switch to Cyclone DDS. (Note: this makes all nodes started using this RMW incompatible with any other nodes not using Cyclone DDS.) :: - sudo apt install ros-humble-rmw-cyclonedds-cpp + sudo apt install ros-{DISTRO}-rmw-cyclonedds-cpp # You may want to add this to ~/.bashrc to source it automatically export RMW_IMPLEMENTATION=rmw_cyclonedds_cpp diff --git a/doc/tutorials/visualizing_in_rviz/visualizing_in_rviz.rst b/doc/tutorials/visualizing_in_rviz/visualizing_in_rviz.rst index cfe7821b71..e5fe4c6f5c 100644 --- a/doc/tutorials/visualizing_in_rviz/visualizing_in_rviz.rst +++ b/doc/tutorials/visualizing_in_rviz/visualizing_in_rviz.rst @@ -197,7 +197,7 @@ Lastly, build your project again to make sure all the code additions are correct .. code-block:: bash cd ~/ws_moveit2 - source /opt/ros/humble/setup.bash + source /opt/ros/{DISTRO}/setup.bash colcon build --mixin debug 6 Enable visualizations in RViz