[22575] Refactor Fast DDS Monitor documentation

README.md

@@ -1,16 +1,36 @@
-# Fast DDS Monitor
-
-<a href="http://www.eprosima.com"><img src="https://encrypted-tbn3.gstatic.com/images?q=tbn:ANd9GcSd0PDlVz1U_7MgdTe0FRIWD0Jc9_YH-gGi0ZpLkr-qgCI6ZEoJZ5GBqQ" align="left" hspace="8" vspace="2" width="100" height="100" ></a>
-
-
-[![License](https://img.shields.io/github/license/eProsima/Fast-DDS-monitor.svg)](https://www.gnu.org/licenses/gpl-3.0.en.html)
-[![Releases](https://img.shields.io/github/v/release/eProsima/Fast-DDS-monitor?sort=semver)](https://github.com/eProsima/Fast-DDS-monitor/releases)
-[![Issues](https://img.shields.io/github/issues/eProsima/Fast-DDS-monitor.svg)](https://github.com/eProsima/Fast-DDS-monitor/issues)
-[![Forks](https://img.shields.io/github/forks/eProsima/Fast-DDS-monitor.svg)](https://github.com/eProsima/Fast-DDS-monitor/network/members)
-[![Stars](https://img.shields.io/github/stars/eProsima/Fast-DDS-monitor.svg)](https://github.com/eProsima/Fast-RTPS/stargazers)
-[![test](https://github.com/eProsima/Fast-DDS-monitor/actions/workflows/test.yml/badge.svg)](https://github.com/eProsima/Fast-DDS-monitor/actions/workflows/test.yml)
-[![codecov](https://codecov.io/gh/eProsima/Fast-DDS-monitor/branch/main/graph/badge.svg?token=6NA5PVA9QL)](https://codecov.io/gh/eProsima/Fast-DDS-monitor)
-[![Documentation Status](https://readthedocs.org/projects/fast-dds-monitor/badge/?version=latest)](https://fast-dds-monitor.readthedocs.io/en/latest/)
+[![Fast DDS](resources/images/monitor_repo_banner.png)](https://www.eprosima.com/middleware/tools/fast-dds-monitor)
+
+<br>
+
+<div class="menu" align="center">
+    <strong>
+        <a href="https://eprosima.com/index.php/downloads-all">Download</a>
+        <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+        <a href="https://fast-dds-monitor.readthedocs.io/en/latest/">Docs</a>
+        <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+        <a href="https://eprosima.com/index.php/company-all/news">News</a>
+        <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+        <a href="https://twitter.com/EProsima">Twitter</a>
+        <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
+        <a href="mailto:[email protected]">Contact Us</a>
+    </strong>
+</div>
+
+<br><br>
+
+<div class="badges" align="center">
+    <a href="https://www.gnu.org/licenses/gpl-3.0.en.html"><img alt="License" src="https://img.shields.io/github/license/eProsima/Fast-DDS-monitor.svg"/></a>
+    <a href="https://github.com/eProsima/Fast-DDS-monitor/releases"><img alt="Releases" src="https://img.shields.io/github/v/release/eProsima/Fast-DDS-monitor?sort=semver"/></a>
+    <a href="https://github.com/eProsima/Fast-DDS-monitor/issues"><img alt="Issues" src="https://img.shields.io/github/issues/eProsima/Fast-DDS-monitor.svg"/></a>
+    <a href="https://github.com/eProsima/Fast-DDS-monitor/network/members"><img alt="Forks" src="https://img.shields.io/github/forks/eProsima/Fast-DDS-monitor.svg"/></a>
+    <a href="https://github.com/eProsima/Fast-RTPS/stargazers"><img alt="Stars" src="https://img.shields.io/github/stars/eProsima/Fast-DDS-monitor.svg"/></a>
+    <br>
+    <a href="https://github.com/eProsima/Fast-DDS-monitor/actions/workflows/test.yml"><img alt="test" src="https://github.com/eProsima/Fast-DDS-monitor/actions/workflows/test.yml/badge.svg"/></a>
+    <a href="https://codecov.io/gh/eProsima/Fast-DDS-monitor"><img alt="codecov" src="https://codecov.io/gh/eProsima/Fast-DDS-monitor/branch/main/graph/badge.svg?token=6NA5PVA9QL"></a>
+    <a href="https://fast-dds-monitor.readthedocs.io/en/latest/"><img alt="Documentation Status" src="https://readthedocs.org/projects/fast-dds-monitor/badge/?version=latest"></a>
+</div>
+
+<br><br>
 
 *eProsima Fast DDS Monitor* is a graphical desktop application aimed at monitoring DDS environments deployed using the
 *eProsima Fast DDS* library.
@@ -21,8 +41,8 @@ etc.), as well as record and compute in real time statistical measurements on th
 
 Furthermore, the user can check the status of the deployed DDS network at any time, i.e. see for each DDS
 Domain which DomainParticipants are instantiated, as well as their publishers and subscribers and the topics
-under which they publish or to which they subscribe respectively.
-It is also possible to see the physical architecture of the network on which the DDS applications that use *Fast DDS*
+they publish under or they subscribe to, respectively.
+It is also possible to visualize the physical architecture of the network on which the DDS applications that use *Fast DDS*
 are running.
 
 *eProsima Fast DDS Monitor* is designed to meet the following criteria:
@@ -33,6 +53,10 @@ are running.
    configuration and physical deployment.
 * **Troubleshooting**: detect at a glance the possible issues or anomalous events that may occur in the communication.
 
+<div align="center">
+    <img src="docs/rst/figures/screenshots/working_example2.gif" alt="Example of use">
+</div>
+
 ## Commercial support
 
 Looking for commercial support? Write us to [email protected]
@@ -57,4 +81,6 @@ You can access the documentation online, which is hosted on [Read the Docs](http
 * [Getting Started](https://fast-dds-monitor.readthedocs.io/en/latest/rst/getting_started/entities.html)
 * [User Manual](https://fast-dds-monitor.readthedocs.io/en/latest/rst/user_manual/initialize_monitoring.html)
 * [Developer Manual](https://fast-dds-monitor.readthedocs.io/en/latest/rst/developer_manual/installation/sources/linux.html)
+* [ROS2](https://fast-dds-monitor.readthedocs.io/en/latest/rst/ros/ros.html)
+* [Docker Image](https://fast-dds-monitor.readthedocs.io/en/latest/rst/docker/docker.html)
 * [Release Notes](https://fast-dds-monitor.readthedocs.io/en/latest/rst/notes/notes.html)

docs/rst/developer_manual/installation/configuration/cmake_options.rst

@@ -33,6 +33,7 @@ These options allow the developer to enable/disable certain *Fast DDS Monitor* s
     *   - :class:`BUILD_TESTS`
         - Build the *Fast DDS Monitor* application and documentation |br|
           tests. Setting :class:`BUILD_TESTS` to ``ON`` sets |br|
+          :class:`BUILD_APP_TESTS` to ``ON`` and |br|
           :class:`BUILD_DOCUMENTATION_TESTS` to ``ON``.
         - ``OFF`` |br|
           ``ON``
@@ -51,7 +52,7 @@ These options allow the developer to enable/disable certain *Fast DDS Monitor* s
         - ``OFF``
     *   - :class:`BUILD_DOCUMENTATION`
         - Build the *Fast DDS Monitor* documentation. It is |br|
-          set to ``ON`` if :class:`BUILD_TESTS_DOCUMENTATION` is set |br|
+          set to ``ON`` if :class:`BUILD_DOCUMENTATION_TESTS` is set |br|
           to ``ON``.
         - ``OFF`` |br|
           ``ON``
@@ -60,8 +61,7 @@ These options allow the developer to enable/disable certain *Fast DDS Monitor* s
         - Build the *Fast DDS Statistics Backend* mocks, which is a |br|
           simulator of a *Fast DDS* application that generates random |br|
           statistics data for testing the *Fast DDS Monitor*. It is |br|
-          set to ``ON`` if :class:`BUILD_TESTS` is set |br|
-          to ``ON``, :class:`STATIC_MOCK` is set to ``ON``, or |br|
+          set to ``ON`` if :class:`STATIC_MOCK` is set to ``ON`` or |br|
           :class:`COMPLEX_MOCK` is set to ``ON``.
         - ``OFF`` |br|
           ``ON``
@@ -78,8 +78,8 @@ These options allow the developer to enable/disable certain *Fast DDS Monitor* s
     *   - :class:`COMPLEX_MOCK`
         - Build the *Fast DDS Statistics Backend* complex mock and link |br|
           the *Fast DDS Monitor* application against it. The complex |br|
-          mock is a simulator of a *Fast DDS* application that random |br|
-          statistics data for testing the *Fast DDS Monior* |br|
+          mock is a simulator of a *Fast DDS* application that generates |br|
+          random statistics data for testing the *Fast DDS Monitor* |br|
         - ``OFF`` |br|
           ``ON``
         - ``OFF``

docs/rst/developer_manual/installation/sources/linux.rst

@@ -138,15 +138,15 @@ For example, on Ubuntu use the command:
 eProsima dependencies
 ^^^^^^^^^^^^^^^^^^^^^
 
-If it already exists in the system an installation of *Fast DDS* library with version greater than `2.3.0` and
+If there is already in the system an installation of *Fast DDS* library with version greater than `2.3.0` and
 an installation of *Fast DDS Statistics Backend*, just source these
 libraries when building the *Fast DDS Monitor* by using the command:
 
 .. code-block:: bash
 
     source <fastdds-installation-path>/install/setup.bash
 
-In other case, just download *Fast DDS* project from sources and build it together with *Fast DDS Monitor* using colcon
+Otherwise, just download *Fast DDS* project from sources and build it together with *Fast DDS Monitor* using colcon
 as it is explained in section :ref:`colcon_installation`.
 
 
@@ -208,6 +208,10 @@ Colcon installation
 CMake installation
 ==================
 
+.. Warning::
+
+    Only use this installation method if the colcon_ installation method is not suitable for your needs.
+
 This section explains how to compile *eProsima Fast DDS Monitor* with CMake_, either
 :ref:`locally <local_installation_sl>` or :ref:`globally <global_installation_sl>`.
 
@@ -297,7 +301,7 @@ Global installation
 
 To install *eProsima Fast DDS* system-wide instead of locally, remove all the flags that
 appear in the configuration steps of :code:`Fast-CDR`, :code:`Fast-DDS`, :code:`Fast-DDS-Statistics-Backend`, and
-:code:`Fast-DDS-Monitor`, and change the first in the configuration step of :code:`foonathan_memory_vendor` to the
+:code:`Fast-DDS-Monitor`, and change the flags in the configuration step of :code:`foonathan_memory_vendor` to the
 following:
 
 .. code-block:: bash
@@ -316,7 +320,7 @@ and execute the executable file that has been installed in :code:`<install-path>
 
     # If built has been done using colcon, all projects could be sourced as follows
     source install/setup.bash
-    ./<install-path>/fastdds_monitor/bin/fastdds_monitor
+    ./<build-path>/fastdds_monitor/fastdds_monitor
 
 Be sure that this executable has execute permissions.
 

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:<FastDDS-Version>.tar
+ $ docker load -i ubuntu-fastdds-suite\ <FastDDS-Version>.tar
 
 You can run this Docker container as follows
 
@@ -59,8 +59,8 @@ Fast DDS libraries. These examples' path can be accessed from a terminal by typi
 
  $ goToExamples
 
-From this folder you can access all examples, both for DDS and RTPS. We detail the steps to launch two such
-examples below.
+From this folder you can access all examples, both for DDS and RTPS. We detail the steps to launch one such
+example below.
 
 Hello World Example
 ^^^^^^^^^^^^^^^^^^^
@@ -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:
 

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 <https://eprosima.com/index.php/downloads-all>`_.
+platform. It can be downloaded from `eProsima's downloads page <https://eprosima.com/index.php/downloads-all>`_,
+under eProsima Fast DDS. Choosing a suitable FastDDS version, the file is named
+``ubuntu-fastdds-suite <FastDDS-Version>.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
 

docs/rst/formalia/titlepage.rst

@@ -18,9 +18,9 @@ etc.), as well as record and compute in real time statistical measurements on th
 
 Furthermore, the user can check the status of the deployed DDS network at any time, i.e. see for each DDS
 Domain which DomainParticipants are instantiated, as well as their publishers and subscribers and the topics
-under which they publish or to which they subscribe respectively.
-It is also possible to see the physical architecture of the network on which the DDS applications that use *Fast DDS*
-are running.
+they publish under or they subscribe to, respectively.
+It is also possible to visualize the physical architecture of the network on which the DDS applications that use
+*Fast DDS* are running.
 
 ##################
 Commercial Support
@@ -42,6 +42,9 @@ Overview
    configuration and physical deployment.
 #. **Troubleshooting**: detect at a glance the possible issues or anomalous events that may occur in the communication.
 
+.. figure:: /rst/figures/screenshots/working_example2.gif
+    :align: center
+
 .. warning::
 
     In order to monitor a DDS network deployed using *Fast DDS* library, compiling the latter with statistics and
@@ -77,4 +80,6 @@ This documentation is organized into the sections below.
 * :ref:`Getting Started <entities>`
 * :ref:`User Manual <initialize_monitoring>`
 * :ref:`Developer Manual <developer_manual_installation_sources_linux>`
+* :ref:`ROS2 <ros_section>`
+* :ref:`Docker Image <docker>`
 * :ref:`Release Notes <release_notes>`