Skip to content

Commit

Permalink
Merge pull request #101 from hmakelin/fix-docs
Browse files Browse the repository at this point in the history
Update documentation
  • Loading branch information
hmakelin authored Feb 2, 2024
2 parents a40bd86 + 06a44f5 commit 1e3a4b2
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 65 deletions.
2 changes: 1 addition & 1 deletion docs/pages/developer_guide/development/test_gisnav.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down
91 changes: 27 additions & 64 deletions docs/pages/developer_guide/offboard/docker_compose.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
<Prerequisites>` and then follow the below steps to create, deploy, and shutdown
the required services.
<Prerequisites>` and then follow the below steps to create, start, and shutdown
the required containers.


.. code-block:: bash
Expand All @@ -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

Expand All @@ -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 <Use ROS 2 launch system>` to launch your
Expand Down

0 comments on commit 1e3a4b2

Please sign in to comment.