From 946c33f3acd9bfb8083ed45fd47ad8900ccb46b1 Mon Sep 17 00:00:00 2001 From: Kenji Miyake <31987104+kenji-miyake@users.noreply.github.com> Date: Sat, 28 May 2022 00:51:04 +0900 Subject: [PATCH] docs: replace "ROS2" with "ROS 2" (#133) * docs: replace "ROS2" with "ROS 2" Signed-off-by: Kenji Miyake * fix invalid links Signed-off-by: Kenji Miyake Signed-off-by: Shark Liu --- .../coding-guidelines/ros-nodes/message-guidelines.md | 2 +- docs/how-to-guides/advanced-usage-of-colcon.md | 2 +- .../how-to-integrate-autoware-with-your-vehicle.md | 4 ++-- docs/installation/autoware/docker-installation.md | 1 - docs/installation/autoware/source-installation.md | 4 ++-- 5 files changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/contributing/coding-guidelines/ros-nodes/message-guidelines.md b/docs/contributing/coding-guidelines/ros-nodes/message-guidelines.md index 9b1516ebb1a..fb3e223acff 100644 --- a/docs/contributing/coding-guidelines/ros-nodes/message-guidelines.md +++ b/docs/contributing/coding-guidelines/ros-nodes/message-guidelines.md @@ -87,7 +87,7 @@ int32[] unbounded_integer_array ## Enumerations -ROS2 interfaces don't support enumerations directly. +ROS 2 interfaces don't support enumerations directly. It is possible to define integers constants and assign them to a non-constant integer parameter. diff --git a/docs/how-to-guides/advanced-usage-of-colcon.md b/docs/how-to-guides/advanced-usage-of-colcon.md index 36eb58db696..ff1c240971b 100644 --- a/docs/how-to-guides/advanced-usage-of-colcon.md +++ b/docs/how-to-guides/advanced-usage-of-colcon.md @@ -18,7 +18,7 @@ You should take care of this especially when you have multiple workspaces. Run `echo $COLCON_PREFIX_PATH` to check whether workspaces are overlaid. If you find some workspaces are unnecessarily overlaid, remove all built files, restart the terminal to clean environment variables, and re-build the workspace. -For more details about `workspace overlaying`, refer to the [ROS2 documentation](https://docs.ros.org/en/rolling/Tutorials/Workspace/Creating-A-Workspace.html#source-the-overlay). +For more details about `workspace overlaying`, refer to the [ROS 2 documentation](https://docs.ros.org/en/rolling/Tutorials/Workspace/Creating-A-Workspace.html#source-the-overlay). ## Cleaning up the build artifacts diff --git a/docs/how-to-guides/how-to-integrate-autoware-with-your-vehicle.md b/docs/how-to-guides/how-to-integrate-autoware-with-your-vehicle.md index 9048239f46a..d94aee50c5a 100644 --- a/docs/how-to-guides/how-to-integrate-autoware-with-your-vehicle.md +++ b/docs/how-to-guides/how-to-integrate-autoware-with-your-vehicle.md @@ -23,7 +23,7 @@ Some examples are: - [HDL](https://github.com/koide3/hdl_graph_slam) - [LIO-SAM](https://github.com/TixiaoShan/LIO-SAM) -- [LiDAR-SLAM (ROS2)](https://github.com/rsasaki0109/lidarslam_ros2) +- [LiDAR-SLAM (ROS 2)](https://github.com/rsasaki0109/lidarslam_ros2) ### Create vector map @@ -123,7 +123,7 @@ This section briefly explains how to run your vehicle with Autoware. ### Install Autoware -Follow the [installation steps of Autoware](https://autowarefoundation.github.io/autoware-documentation/main/installation/autoware/). +Follow the [installation steps of Autoware](https://autowarefoundation.github.io/autoware-documentation/main/installation/). ### Launch Autoware diff --git a/docs/installation/autoware/docker-installation.md b/docs/installation/autoware/docker-installation.md index 3066dae5e03..1aee9c1746e 100644 --- a/docs/installation/autoware/docker-installation.md +++ b/docs/installation/autoware/docker-installation.md @@ -24,7 +24,6 @@ ### Installing dependencies manually - [Install Docker Engine](https://github.com/autowarefoundation/autoware/tree/main/ansible/roles/docker_engine#manual-installation) -- [Install Docker Compose](https://github.com/autowarefoundation/autoware/tree/main/ansible/roles/docker_compose#manual-installation) - [Install NVIDIA Container Toolkit](https://github.com/autowarefoundation/autoware/tree/main/ansible/roles/nvidia_docker#manual-installation) - [Install rocker](https://github.com/autowarefoundation/autoware/tree/main/ansible/roles/rocker#manual-installation) diff --git a/docs/installation/autoware/source-installation.md b/docs/installation/autoware/source-installation.md index 0a64475582c..8c693874ba6 100644 --- a/docs/installation/autoware/source-installation.md +++ b/docs/installation/autoware/source-installation.md @@ -30,8 +30,8 @@ sudo apt-get -y install git ### Installing dependencies manually -- [Install ROS2](https://github.com/autowarefoundation/autoware/tree/main/ansible/roles/ros2#manual-installation) -- [Install ROS2 Dev Tools](https://github.com/autowarefoundation/autoware/tree/main/ansible/roles/ros2_dev_tools#manual-installation) +- [Install ROS 2](https://github.com/autowarefoundation/autoware/tree/main/ansible/roles/ros2#manual-installation) +- [Install ROS 2 Dev Tools](https://github.com/autowarefoundation/autoware/tree/main/ansible/roles/ros2_dev_tools#manual-installation) - [Install the RMW Implementation](https://github.com/autowarefoundation/autoware/tree/main/ansible/roles/rmw_implementation#manual-installation) - [Install pacmod](https://github.com/autowarefoundation/autoware/tree/main/ansible/roles/pacmod#manual-installation) - [Install Autoware Core dependencies](https://github.com/autowarefoundation/autoware/tree/main/ansible/roles/autoware_core#manual-installation)