From 06a44f5728c2dd78262ed670c3a067435314bfba Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Harri=20M=C3=A4kelin?= Date: Fri, 2 Feb 2024 19:24:42 +0000 Subject: [PATCH] Documentation updates [skip ci] --- .../development/test_gisnav.rst | 2 +- .../offboard/docker_compose.rst | 91 ++++++------------- 2 files changed, 28 insertions(+), 65 deletions(-) diff --git a/docs/pages/developer_guide/development/test_gisnav.rst b/docs/pages/developer_guide/development/test_gisnav.rst index cd9846ee..a7ee0541 100644 --- a/docs/pages/developer_guide/development/test_gisnav.rst +++ b/docs/pages/developer_guide/development/test_gisnav.rst @@ -111,7 +111,7 @@ SITL tests require a number of supporting services to successfully complete: cd ~/colcon_ws/src/gisnav/docker make build-offboard-sitl-dev-px4 - make create-offboard-silt-dev-px4 + make create-offboard-sitl-dev-px4 make expose-xhost .. seealso:: diff --git a/docs/pages/developer_guide/offboard/docker_compose.rst b/docs/pages/developer_guide/offboard/docker_compose.rst index 7f6ff7b8..0344a658 100644 --- a/docs/pages/developer_guide/offboard/docker_compose.rst +++ b/docs/pages/developer_guide/offboard/docker_compose.rst @@ -126,8 +126,8 @@ Mock GPS demo To deploy the mock :term:`GPS` demonstration introduced on the :ref:`Get Started` page locally, ensure your development system satisfies all the :ref:`prerequisites -` and then follow the below steps to create, deploy, and shutdown -the required services. +` and then follow the below steps to create, start, and shutdown +the required containers. .. code-block:: bash @@ -145,36 +145,18 @@ the required services. .. include:: ../_shared/expose_xhost.rst -.. tab-set:: - - .. tab-item:: Foreground - :selected: - - .. code-block:: bash - :caption: Deploy services - - cd ~/colcon_ws/src/gisnav/docker - docker compose -p gisnav up \ - mapserver \ - micro-ros-agent \ - mavros \ - qgc \ - px4 \ - gisnav - - .. tab-item:: Detached +.. code-block:: bash + :caption: Start containers - .. code-block:: bash - :caption: Deploy services + cd ~/colcon_ws/src/gisnav/docker + docker compose -p gisnav start \ + mapserver \ + micro-ros-agent \ + mavros \ + qgc \ + px4 \ + gisnav - cd ~/colcon_ws/src/gisnav/docker - docker compose -p gisnav up -d \ - mapserver \ - micro-ros-agent \ - mavros \ - qgc \ - px4 \ - gisnav .. include:: ../_shared/docker_compose_shutdown.rst @@ -192,48 +174,29 @@ we do not include the ``gisnav`` service which is assumed to be cd ~/colcon_ws/src/gisnav/docker docker compose create --build \ mapserver \ - torch-serve \ micro-ros-agent \ mavros \ qgc \ rviz \ - px4 + px4 \ + qgis \ + postgres .. include:: ../_shared/expose_xhost.rst -.. tab-set:: - - .. tab-item:: Foreground - :selected: - - .. code-block:: bash - :caption: Deploy containers - - cd ~/colcon_ws/src/gisnav/docker - docker compose up \ - mapserver \ - torch-serve \ - micro-ros-agent \ - mavros \ - qgc \ - rviz \ - px4 - - .. tab-item:: Detached - - .. code-block:: bash - :caption: Run demo services - - cd ~/colcon_ws/src/gisnav/docker - docker compose up -d \ - mapserver \ - torch-serve \ - micro-ros-agent \ - mavros \ - qgc \ - rviz \ - px4 +.. code-block:: bash + :caption: Start containers + cd ~/colcon_ws/src/gisnav/docker + docker compose start \ + mapserver \ + micro-ros-agent \ + mavros \ + qgc \ + rviz \ + px4 \ + qgis \ + postgres After you have your supporting services deployed you would typically :ref:`use the ROS 2 launch system ` to launch your