From 20a9568bc0f4cd29aa84507cef32b6fc55d01d16 Mon Sep 17 00:00:00 2001 From: SzymonParapura <162123449+SzymonParapura@users.noreply.github.com> Date: Thu, 26 Sep 2024 10:01:32 +0200 Subject: [PATCH 1/6] docs: Fix an issue with QuickStart.md - Fixed an issue with "!!! Note" --- docs/user_guide/QuickStart.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/user_guide/QuickStart.md b/docs/user_guide/QuickStart.md index dbd7da67cee..e90ff28d9ae 100644 --- a/docs/user_guide/QuickStart.md +++ b/docs/user_guide/QuickStart.md @@ -32,8 +32,8 @@ This guide provides step-by-step instructions for building and running **Scenari ```bash ./setup-dev-env.sh ``` - !!! Note - This step will install necessary dependencies, including ROS 2, if not already installed.
Make sure to confirm and agree with the licenses for NVIDIA libraries like [CUDA](https://docs.nvidia.com/cuda/eula/index.html), [cuDNN](https://docs.nvidia.com/deeplearning/cudnn/latest/reference/eula.html), and [TensorRT](https://docs.nvidia.com/deeplearning/tensorrt/sla/index.html). +!!! Note + This step will install necessary dependencies, including ROS 2, if not already installed.
Make sure to confirm and agree with the licenses for NVIDIA libraries like [CUDA](https://docs.nvidia.com/cuda/eula/index.html), [cuDNN](https://docs.nvidia.com/deeplearning/cudnn/latest/reference/eula.html), and [TensorRT](https://docs.nvidia.com/deeplearning/tensorrt/sla/index.html). 5. Install dependent ROS packages. ```bash @@ -45,8 +45,8 @@ This guide provides step-by-step instructions for building and running **Scenari ```bash colcon build --symlink-install --cmake-args -DCMAKE_BUILD_TYPE=Release ``` - !!! Note - For detailed guidance on build issues and troubleshooting, please refer to the [Autoware Troubleshooting Guide](https://autowarefoundation.github.io/autoware-documentation/main/support/troubleshooting/#build-issues). +!!! Note + For detailed guidance on build issues and troubleshooting, please refer to the [Autoware Troubleshooting Guide](https://autowarefoundation.github.io/autoware-documentation/main/support/troubleshooting/#build-issues). ![Build success](../image/ss2_autoware_build_result.png) *As a result of running the `colcon build` command, all packages should be built successfully.* From 21da18d87600a5078b9a1aab14e75751aabb95ec Mon Sep 17 00:00:00 2001 From: SzymonParapura <162123449+SzymonParapura@users.noreply.github.com> Date: Thu, 26 Sep 2024 10:03:00 +0200 Subject: [PATCH 2/6] docs: Fix an issue with QuickStart.md - Fixed an issue with "!!! Note" --- docs/user_guide/QuickStart.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/user_guide/QuickStart.md b/docs/user_guide/QuickStart.md index e90ff28d9ae..19fc4d4938e 100644 --- a/docs/user_guide/QuickStart.md +++ b/docs/user_guide/QuickStart.md @@ -88,8 +88,8 @@ This guide provides step-by-step instructions for building and running **Scenari sensor_model:=sample_sensor_kit \ vehicle_model:=sample_vehicle timeout:=120.0 ``` - !!! Note - To modify parameters of random testing and to obtain more details about the test results and the **result.junit.xml** file (which is saved by default in the **/tmp** directory), please refer to the **random_test_runner** [documentation](random_test_runner/Usage.md). +!!! Note + To modify parameters of random testing and to obtain more details about the test results and the **result.junit.xml** file (which is saved by default in the **/tmp** directory), please refer to the **random_test_runner** [documentation](random_test_runner/Usage.md). ![Launching random_test_runner](../image/random_test_runner_launch.gif) *The process of launching the `random_test_runner` node.* From 4b113a756caadcc8b976a3484791eeee049981e4 Mon Sep 17 00:00:00 2001 From: SzymonParapura <162123449+SzymonParapura@users.noreply.github.com> Date: Thu, 26 Sep 2024 10:06:55 +0200 Subject: [PATCH 3/6] docs: Fixed an issue with QuickStart.md - Fixed an issue with "!!! note" --- docs/user_guide/QuickStart.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/user_guide/QuickStart.md b/docs/user_guide/QuickStart.md index 19fc4d4938e..175e1037fe3 100644 --- a/docs/user_guide/QuickStart.md +++ b/docs/user_guide/QuickStart.md @@ -32,8 +32,8 @@ This guide provides step-by-step instructions for building and running **Scenari ```bash ./setup-dev-env.sh ``` -!!! Note - This step will install necessary dependencies, including ROS 2, if not already installed.
Make sure to confirm and agree with the licenses for NVIDIA libraries like [CUDA](https://docs.nvidia.com/cuda/eula/index.html), [cuDNN](https://docs.nvidia.com/deeplearning/cudnn/latest/reference/eula.html), and [TensorRT](https://docs.nvidia.com/deeplearning/tensorrt/sla/index.html). +!!! note + This step will install necessary dependencies, including ROS 2, if not already installed.
Make sure to confirm and agree with the licenses for NVIDIA libraries like [CUDA](https://docs.nvidia.com/cuda/eula/index.html), [cuDNN](https://docs.nvidia.com/ deeplearning/cudnn/latest/reference/eula.html), and [TensorRT](https://docs.nvidia.com/deeplearning/tensorrt/sla/index.html). 5. Install dependent ROS packages. ```bash @@ -46,7 +46,7 @@ This guide provides step-by-step instructions for building and running **Scenari colcon build --symlink-install --cmake-args -DCMAKE_BUILD_TYPE=Release ``` !!! Note - For detailed guidance on build issues and troubleshooting, please refer to the [Autoware Troubleshooting Guide](https://autowarefoundation.github.io/autoware-documentation/main/support/troubleshooting/#build-issues). + For detailed guidance on build issues and troubleshooting, please refer to the [Autoware Troubleshooting Guide](https:// autowarefoundation.github.io/autoware-documentation/main/support/troubleshooting/#build-issues). ![Build success](../image/ss2_autoware_build_result.png) *As a result of running the `colcon build` command, all packages should be built successfully.* @@ -89,7 +89,7 @@ This guide provides step-by-step instructions for building and running **Scenari vehicle_model:=sample_vehicle timeout:=120.0 ``` !!! Note - To modify parameters of random testing and to obtain more details about the test results and the **result.junit.xml** file (which is saved by default in the **/tmp** directory), please refer to the **random_test_runner** [documentation](random_test_runner/Usage.md). + To modify parameters of random testing and to obtain more details about the test results and the **result.junit.xml** file (which is saved by default in the **/tmp** directory), please refer to the **random_test_runner** [documentation](random_test_runner/Usage.md). ![Launching random_test_runner](../image/random_test_runner_launch.gif) *The process of launching the `random_test_runner` node.* From c06eb715be28201a6703d8f2271adf71fa64bf20 Mon Sep 17 00:00:00 2001 From: SzymonParapura <162123449+SzymonParapura@users.noreply.github.com> Date: Thu, 26 Sep 2024 10:08:29 +0200 Subject: [PATCH 4/6] docs: Update QuickStart.md - Fixed an issue with "!!! note" --- docs/user_guide/QuickStart.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/user_guide/QuickStart.md b/docs/user_guide/QuickStart.md index 175e1037fe3..00ef3feaff9 100644 --- a/docs/user_guide/QuickStart.md +++ b/docs/user_guide/QuickStart.md @@ -32,7 +32,7 @@ This guide provides step-by-step instructions for building and running **Scenari ```bash ./setup-dev-env.sh ``` -!!! note +!!! note This step will install necessary dependencies, including ROS 2, if not already installed.
Make sure to confirm and agree with the licenses for NVIDIA libraries like [CUDA](https://docs.nvidia.com/cuda/eula/index.html), [cuDNN](https://docs.nvidia.com/ deeplearning/cudnn/latest/reference/eula.html), and [TensorRT](https://docs.nvidia.com/deeplearning/tensorrt/sla/index.html). 5. Install dependent ROS packages. @@ -45,7 +45,7 @@ This guide provides step-by-step instructions for building and running **Scenari ```bash colcon build --symlink-install --cmake-args -DCMAKE_BUILD_TYPE=Release ``` -!!! Note +!!! note For detailed guidance on build issues and troubleshooting, please refer to the [Autoware Troubleshooting Guide](https:// autowarefoundation.github.io/autoware-documentation/main/support/troubleshooting/#build-issues). ![Build success](../image/ss2_autoware_build_result.png) @@ -88,7 +88,7 @@ This guide provides step-by-step instructions for building and running **Scenari sensor_model:=sample_sensor_kit \ vehicle_model:=sample_vehicle timeout:=120.0 ``` -!!! Note +!!! note To modify parameters of random testing and to obtain more details about the test results and the **result.junit.xml** file (which is saved by default in the **/tmp** directory), please refer to the **random_test_runner** [documentation](random_test_runner/Usage.md). ![Launching random_test_runner](../image/random_test_runner_launch.gif) From 8c9e76ecab840ef1e0c481813b8230daa401aafa Mon Sep 17 00:00:00 2001 From: SzymonParapura <162123449+SzymonParapura@users.noreply.github.com> Date: Thu, 26 Sep 2024 10:26:14 +0200 Subject: [PATCH 5/6] docs: Update QuickStart.md - Fixed an issue with "
" --- docs/user_guide/QuickStart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user_guide/QuickStart.md b/docs/user_guide/QuickStart.md index 00ef3feaff9..d5cfd792859 100644 --- a/docs/user_guide/QuickStart.md +++ b/docs/user_guide/QuickStart.md @@ -2,7 +2,7 @@ ### Scenario Simulator v2 with Autoware Universe -This guide provides step-by-step instructions for building and running **Scenario Simulator v2** alongside [**Autoware Universe**](https://github.com/autowarefoundation/autoware).
It covers the required setup and prerequisites. +This guide provides step-by-step instructions for building and running **Scenario Simulator v2** alongside [**Autoware Universe**](https://github.com/autowarefoundation/autoware). It covers the required setup and prerequisites. ## Prerequisites From 9dc4fe35e5202c61dc59def9a5ed6cafbf29b92c Mon Sep 17 00:00:00 2001 From: SzymonParapura Date: Thu, 26 Sep 2024 10:35:22 +0200 Subject: [PATCH 6/6] docs: Update QuickStar.md - Fixed an issue with "!!! note" --- docs/user_guide/QuickStart.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/user_guide/QuickStart.md b/docs/user_guide/QuickStart.md index d5cfd792859..f42ad70ad20 100644 --- a/docs/user_guide/QuickStart.md +++ b/docs/user_guide/QuickStart.md @@ -33,7 +33,7 @@ This guide provides step-by-step instructions for building and running **Scenari ./setup-dev-env.sh ``` !!! note - This step will install necessary dependencies, including ROS 2, if not already installed.
Make sure to confirm and agree with the licenses for NVIDIA libraries like [CUDA](https://docs.nvidia.com/cuda/eula/index.html), [cuDNN](https://docs.nvidia.com/ deeplearning/cudnn/latest/reference/eula.html), and [TensorRT](https://docs.nvidia.com/deeplearning/tensorrt/sla/index.html). + This step will install necessary dependencies, including ROS 2, if not already installed.
Make sure to confirm and agree with the licenses for NVIDIA libraries like [CUDA](https://docs.nvidia.com/cuda/eula/index.html), [cuDNN](https://docs.nvidia.com/deeplearning/cudnn/latest/reference/eula.html), and [TensorRT](https://docs.nvidia.com/deeplearning/tensorrt/sla/index.html). 5. Install dependent ROS packages. ```bash @@ -46,7 +46,7 @@ This guide provides step-by-step instructions for building and running **Scenari colcon build --symlink-install --cmake-args -DCMAKE_BUILD_TYPE=Release ``` !!! note - For detailed guidance on build issues and troubleshooting, please refer to the [Autoware Troubleshooting Guide](https:// autowarefoundation.github.io/autoware-documentation/main/support/troubleshooting/#build-issues). + For detailed guidance on build issues and troubleshooting, please refer to the [Autoware Troubleshooting Guide](https://autowarefoundation.github.io/autoware-documentation/main/support/troubleshooting/#build-issues). ![Build success](../image/ss2_autoware_build_result.png) *As a result of running the `colcon build` command, all packages should be built successfully.* @@ -89,7 +89,7 @@ This guide provides step-by-step instructions for building and running **Scenari vehicle_model:=sample_vehicle timeout:=120.0 ``` !!! note - To modify parameters of random testing and to obtain more details about the test results and the **result.junit.xml** file (which is saved by default in the **/tmp** directory), please refer to the **random_test_runner** [documentation](random_test_runner/Usage.md). + To modify parameters of random testing and to obtain more details about the test results and the **result.junit.xml** file (which is saved by default in the **/tmp** directory), please refer to the **random_test_runner** [documentation](random_test_runner/Usage.md). ![Launching random_test_runner](../image/random_test_runner_launch.gif) *The process of launching the `random_test_runner` node.*