From 1279e6b206c6497c05bdd2de475ea4675d5861c1 Mon Sep 17 00:00:00 2001 From: Juanjo Garcia Date: Tue, 14 Jan 2025 12:33:37 +0100 Subject: [PATCH] Refs #22575: Updated and corrected the Docker section Signed-off-by: Juanjo Garcia --- .../rst/docker/docker_demo/fast_dds_suite.rst | 38 ++++--------------- docs/rst/docker/includes/intro.rst | 6 ++- docs/rst/installation/linux.rst | 9 ++--- 3 files changed, 16 insertions(+), 37 deletions(-) diff --git a/docs/rst/docker/docker_demo/fast_dds_suite.rst b/docs/rst/docker/docker_demo/fast_dds_suite.rst index 681b196a..1ec7964f 100644 --- a/docs/rst/docker/docker_demo/fast_dds_suite.rst +++ b/docs/rst/docker/docker_demo/fast_dds_suite.rst @@ -35,7 +35,7 @@ To load this image into your Docker repository, from a terminal run .. code-block:: bash - $ docker load -i ubuntu-fastdds-suite:.tar + $ docker load -i ubuntu-fastdds-suite\ .tar You can run this Docker container as follows @@ -70,9 +70,9 @@ This is a minimal example that will perform a Publisher/Subscriber match and sta .. code-block:: bash $ goToExamples - $ cd HelloWorldExample/bin - $ tmux new-session "./HelloWorldExample publisher 0 1000" \; \ - split-window "./HelloWorldExample subscriber" \; \ + $ cd hello_world/bin + $ tmux new-session "./hello_world publisher 0 1000" \; \ + split-window "./hello_world subscriber" \; \ select-layout even-vertical This example is not constrained to the current instance. It is possible to run several instances of this @@ -81,38 +81,16 @@ container to check the communication between them by running the following from .. code-block:: bash $ goToExamples - $ cd HelloWorldExample/bin - $ ./HelloWorldExample publisher + $ cd hello_world/bin + $ ./hello_world publisher or .. code-block:: bash $ goToExamples - $ cd HelloWorldExample/bin - $ ./HelloWorldExample subscriber - -Benchmark Example -^^^^^^^^^^^^^^^^^ - -This example creates either a Publisher or a Subscriber and on a successful match starts sending samples. After a -few seconds the process that launched the Publisher will show a report with the number of samples transmitted. - -On the subscriber side, run: - -.. code-block:: bash - - $ goToExamples - $ cd Benchmark/bin - $ ./Benchmark subscriber udp - -On the publisher side, run: - -.. code-block:: bash - - $ goToExamples - $ cd Benchmark/bin - $ ./Benchmark publisher udp + $ cd hello_world/bin + $ ./hello_world subscriber .. _fast_dds_suite_shapes_demo: diff --git a/docs/rst/docker/includes/intro.rst b/docs/rst/docker/includes/intro.rst index 1175f808..487c8f2d 100644 --- a/docs/rst/docker/includes/intro.rst +++ b/docs/rst/docker/includes/intro.rst @@ -1,7 +1,9 @@ eProsima provides the eProsima Fast DDS Suite Docker image for those who want a quick demonstration of Fast DDS running on an Ubuntu -platform. It can be downloaded from `eProsima's downloads page `_. +platform. It can be downloaded from `eProsima's downloads page `_, +under eProsima Fast DDS. Choosing a suitable FastDDS version, the file is named +``ubuntu-fastdds-suite .tar``. -This Docker image was built for Ubuntu 20.04 (Focal Fossa). +This Docker image was built for Ubuntu 22.04 (Jammy Jellyfish). To run this container you need Docker installed. From a terminal run diff --git a/docs/rst/installation/linux.rst b/docs/rst/installation/linux.rst index 3b877475..7c26925a 100644 --- a/docs/rst/installation/linux.rst +++ b/docs/rst/installation/linux.rst @@ -19,9 +19,9 @@ There are two mechanisms for running the monitor application. ============================ The first option is to install the *Fast DDS monitor* application together with all its dependencies. -To do so, first run the ``eProsima_Fast-DDS-Monitor-vX.X.X-Linux.run`` executable, , where ``vX.X.X`` is the version -of the application, -(you might need to make the file executable by running ``chmod +x eProsima_Fast-DDS-Monitor-vX.X.X-Linux.run`` first) +To do so, first run the ``eProsima_Fast-DDS-Monitor--Linux.run`` executable, +(you might need to make the file executable by running +``chmod +x eProsima_Fast-DDS-Monitor--Linux.run`` first) and follow the instructions it provides to install the program in a directory on the system. .. figure:: /rst/figures/installer_linux.png @@ -34,8 +34,7 @@ and follow the instructions it provides to install the program in a directory on In this case, download this version from the `eProsima Downloads website `_ and run the downloaded file to launch the monitor. -The name of this file is ``eProsima_Fast-DDS-Monitor-vX.X.X-Linux.AppImage``, where ``VX.X.X`` is the version of the -application. +The name of this file is ``eProsima_Fast-DDS-Monitor--Linux.AppImage``. .. warning::