Refs #15599: Style corrections

Signed-off-by: Eduardo Ponz <eduardoponz@eprosima.com>
eProsima · Sep 29, 2022 · 3daa6d9 · 3daa6d9
1 parent 9082763
commit 3daa6d9
Show file tree

Hide file tree

Showing 3 changed files with 61 additions and 60 deletions.
diff --git a/docs/docker/fastdds/fast_dds.rst b/docs/docker/fastdds/fast_dds.rst
@@ -13,18 +13,17 @@ This includes:
 - :ref:`eProsima Fast DDS libraries and examples <fast_dds_suite_examples>`: Fast DDS libraries bundled with several
   examples that showcase a variety of capabilities of eProsima's Fast DDS implementation.
 
-To load this image into your Docker repository, from a terminal run
+To load this image into your Docker repository, from a terminal, run:
 
 .. code-block:: bash
 
- $ docker load -i "ubuntu-fastdds <FastDDS-Version>.tar"
+    docker load -i "ubuntu-fastdds <FastDDS-Version>.tar"
 
-You can run this Docker container as follows
+You can run this Docker container as follows:
 
 .. code-block:: bash
 
- $ xhost local:root
- $ docker run -it ubuntu-fastdds:<FastDDS-Version>
+    docker run -it ubuntu-fastdds:<FastDDS-Version>
 
 From the resulting Bash Shell you can run each feature.
 
@@ -34,14 +33,14 @@ Fast DDS Examples
 -----------------
 
 Included in this Docker container is a set of binary examples that showcase several functionalities of the
-Fast DDS libraries. These examples' path can be accessed from a terminal by typing
+Fast DDS libraries.
+These examples' path can be accessed from a terminal by typing:
 
 .. code-block:: bash
 
- $ goToExamples
+    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 layers.
 
 Hello World Example
 ^^^^^^^^^^^^^^^^^^^
@@ -50,47 +49,48 @@ This is a minimal example that will perform a Publisher/Subscriber match and sta
 
 .. code-block:: bash
 
- $ goToExamples
- $ cd dds/HelloWorldExample/bin
- $ tmux new-session "./DDSHelloWorldExample publisher 0 1000" \; \
- split-window "./DDSHelloWorldExample subscriber" \; \
- select-layout even-vertical
+   goToExamples
+   cd dds/HelloWorldExample/bin
+   tmux new-session "./DDSHelloWorldExample publisher 0 1000" \; \
+        split-window "./DDSHelloWorldExample subscriber" \; \
+        select-layout even-vertical
 
-This example is not constrained to the current instance. It's possible to run several instances of this
-container to check the communication between them by running the following from each container.
+This example is not constrained to the current instance.
+It's possible to run several instances of this container to check the communication between them by running the
+following from each container.
 
 .. code-block:: bash
 
- $ goToExamples
- $ cd dds/HelloWorldExample/bin
- $ ./DDSHelloWorldExample publisher
+    goToExamples
+    cd dds/HelloWorldExample/bin
+    ./DDSHelloWorldExample publisher
 
 or
 
 .. code-block:: bash
 
- $ goToExamples
- $ cd dds/HelloWorldExample/bin
- $ ./DDSHelloWorldExample subscriber
+    goToExamples
+    cd dds/HelloWorldExample/bin
+    ./DDSHelloWorldExample 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.
+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 dds/Benchmark/bin
- $ ./DDSBenchmark subscriber udp
+    goToExamples
+    cd dds/Benchmark/bin
+    ./DDSBenchmark subscriber udp
 
 On the publisher side, run:
 
 .. code-block:: bash
 
- $ goToExamples
- $ cd dds/Benchmark/bin
- $ ./DDSBenchmark publisher udp
+    goToExamples
+    cd dds/Benchmark/bin
+    ./DDSBenchmark publisher udp
diff --git a/docs/docker/fastdds_suite/fast_dds_suite.rst b/docs/docker/fastdds_suite/fast_dds_suite.rst
@@ -55,15 +55,15 @@ 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
 
 .. code-block:: bash
 
- $ xhost local:root
- $ docker run -it --privileged -e DISPLAY=$DISPLAY -v /tmp/.X11-unix:/tmp/.X11-unix \
- ubuntu-fastdds-suite:<FastDDS-Version>
+    xhost local:root
+    docker run -it --privileged -e DISPLAY=$DISPLAY -v /tmp/.X11-unix:/tmp/.X11-unix \
+    ubuntu-fastdds-suite:<FastDDS-Version>
 
 From the resulting Bash Shell you can run each feature.
 
@@ -77,7 +77,7 @@ Fast DDS libraries. These examples' path can be accessed from a terminal by typi
 
 .. code-block:: bash
 
- $ goToExamples
+    goToExamples
 
 From this folder you can access all examples, both for DDS and RTPS. We detail the steps to launch two such
 examples below.
@@ -89,28 +89,28 @@ This is a minimal example that will perform a Publisher/Subscriber match and sta
 
 .. code-block:: bash
 
- $ goToExamples
- $ cd dds/HelloWorldExample/bin
- $ tmux new-session "./DDSHelloWorldExample publisher 0 1000" \; \
- split-window "./DDSHelloWorldExample subscriber" \; \
- select-layout even-vertical
+    goToExamples
+    cd dds/HelloWorldExample/bin
+    tmux new-session "./DDSHelloWorldExample publisher 0 1000" \; \
+        split-window "./DDSHelloWorldExample subscriber" \; \
+        select-layout even-vertical
 
 This example is not constrained to the current instance. It's possible to run several instances of this
 container to check the communication between them by running the following from each container.
 
 .. code-block:: bash
 
- $ goToExamples
- $ cd dds/HelloWorldExample/bin
- $ ./DDSHelloWorldExample publisher
+    goToExamples
+    cd dds/HelloWorldExample/bin
+    ./DDSHelloWorldExample publisher
 
 or
 
 .. code-block:: bash
 
- $ goToExamples
- $ cd dds/HelloWorldExample/bin
- $ ./DDSHelloWorldExample subscriber
+    goToExamples
+    cd dds/HelloWorldExample/bin
+    ./DDSHelloWorldExample subscriber
 
 Benchmark Example
 ^^^^^^^^^^^^^^^^^
@@ -122,17 +122,17 @@ On the subscriber side, run:
 
 .. code-block:: bash
 
- $ goToExamples
- $ cd dds/Benchmark/bin
- $ ./DDSBenchmark subscriber udp
+    goToExamples
+    cd dds/Benchmark/bin
+    ./DDSBenchmark subscriber udp
 
 On the publisher side, run:
 
 .. code-block:: bash
 
- $ goToExamples
- $ cd dds/Benchmark/bin
- $ ./DDSBenchmark publisher udp
+    goToExamples
+    cd dds/Benchmark/bin
+    ./DDSBenchmark publisher udp
 
 .. _fast_dds_suite_shapes_demo:
 
@@ -143,7 +143,7 @@ To launch the Shapes Demo, from a terminal run
 
 .. code-block:: bash
 
- $ ShapesDemo
+    ShapesDemo
 
 eProsima Shapes Demo usage information can be found on the `Shapes Demo documentation
 <https://eprosima-shapes-demo.readthedocs.io/en/latest/first_steps/first_steps.html>`_.
@@ -157,7 +157,7 @@ To launch the Fast DDS Monitor, from a terminal run
 
 .. code-block:: bash
 
- $ fastdds_monitor
+    fastdds_monitor
 
 eProsima Fast DDS Monitor user manual can be found on the `Fast DDS Monitor documentation
 <https://fast-dds-monitor.readthedocs.io/en/latest/rst/user_manual/initialize_monitoring.html>`_.
@@ -205,7 +205,7 @@ To launch the PlotJuggler eProsima Edition, from a terminal run
 
 .. code-block:: bash
 
- $ plotjuggler
+     plotjuggler
 
 eProsima PlotJuggler eProsima Edition usage information can be located on the `PlotJuggler eProsima Edition User Manual
 <https://plotjuggler-fastdds-plugins.readthedocs.io/en/latest/>`_.
diff --git a/docs/docker/includes/intro.rst b/docs/docker/includes/intro.rst
@@ -1,10 +1,11 @@
-eProsima provides the eProsima Fast DDS and the eProsima Fast DDS Suite Docker images 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>`_.
+eProsima provides the Fast DDS and the Fast DDS Suite Docker images for those who want a quick demonstration of Fast DDS running on an Ubuntu
+platform.
+They can be downloaded from `eProsima's downloads page <https://eprosima.com/index.php/downloads-all>`_.
 
-This Docker images were built for Ubuntu 20.04 (Focal Fossa).
+This Docker images were built for Ubuntu 22.04 (Focal Fossa).
 
-To run a container you need Docker installed. From a terminal run
+To run a container you need Docker installed. From a terminal, run:
 
 .. code-block:: bash
 
-    $ sudo apt install docker.io
+    sudo apt install docker.io