Fix example links (#895)

* Refs #21482: Fix example links Signed-off-by: JesusPoderoso <[email protected]> * Refs #21482: Apply rev suggestion Signed-off-by: JesusPoderoso <[email protected]> --------- Signed-off-by: JesusPoderoso <[email protected]>
eProsima · Aug 20, 2024 · 871db4c · 871db4c
1 parent 4f623da
commit 871db4c
Show file tree

Hide file tree

Showing 8 changed files with 24 additions and 23 deletions.
diff --git a/docs/fastdds/discovery/discovery_server.rst b/docs/fastdds/discovery/discovery_server.rst
@@ -334,7 +334,7 @@ Full example
 ^^^^^^^^^^^^
 
 The following constitutes a full example on how to configure *server* and *client* both programmatically and using XML.
-You may also have a look at the *eProsima Fast DDS* Github repository, which contains `an example <https://github.com/eProsima/Fast-DDS/tree/master/examples/cpp/dds/DiscoveryServerExample>`_
+You may also have a look at the *eProsima Fast DDS* Github repository, which contains `an example <https://github.com/eProsima/Fast-DDS/tree/master/examples/cpp/discovery_server>`_
 similar to the one discussed in this section, as well as multiple other examples for different use cases.
 
 Server side setup

diff --git a/docs/fastdds/getting_started/simple_app/includes/sum_and_next_steps.rst b/docs/fastdds/getting_started/simple_app/includes/sum_and_next_steps.rst
@@ -10,4 +10,4 @@ Next steps
 
 In the *eProsima Fast DDS* Github repository you will find more complex examples that implement DDS communication for
 a multitude of use cases and scenarios. You can find them
-`here <https://github.com/eProsima/Fast-DDS/tree/master/examples/cpp/dds>`_.
+`here <https://github.com/eProsima/Fast-DDS/tree/master/examples/cpp>`_.
diff --git a/docs/fastdds/rtps_layer/rtps_layer.rst b/docs/fastdds/rtps_layer/rtps_layer.rst
@@ -38,11 +38,10 @@ How to use the RTPS Layer
 We will now go over the use of the RTPS Layer like we did with the :ref:`dds_layer` one,
 explaining the new features it presents.
 
-We recommend you to look at the two examples describing how to use the RTPS layer that come with the distribution
+We recommend you to look at the example describing how to use the RTPS layer that come with the distribution
 while reading this section.
-They are located in
-`examples/cpp/rtps/AsSocket <https://github.com/eProsima/Fast-DDS/tree/master/examples/cpp/rtps/AsSocket>`_ and
-`examples/cpp/rtps/Registered <https://github.com/eProsima/Fast-DDS/tree/master/examples/cpp/rtps/Registered>`_
+It is located in
+`examples/cpp/rtps <https://github.com/eProsima/Fast-DDS/tree/master/examples/cpp/rtps>`_.
 
 Managing the Participant
 ^^^^^^^^^^^^^^^^^^^^^^^^

diff --git a/docs/fastdds/transport/shared_memory/shared_memory.rst b/docs/fastdds/transport/shared_memory/shared_memory.rst
@@ -273,9 +273,10 @@ The examples below show this procedure in both C++ code and XML file.
 
 .. _transport_sharedMemory_example:
 
-HelloWorldExampleSharedMem
---------------------------
+Delivery Mechanisms example
+---------------------------
 
-A Shared Memory version of helloworld example can be found in the
-`HelloWorldExampleSharedMem folder <https://github.com/eProsima/Fast-DDS/tree/master/examples/cpp/dds/HelloWorldExampleSharedMem>`_.
-It shows a publisher and a subscriber that communicate through Shared Memory.
+A hello world example suitable for supported delivery mechanisms can be found in the
+`delivery_mechanisms folder <https://github.com/eProsima/Fast-DDS/tree/master/examples/cpp/delivery_mechanisms>`_.
+It shows a publisher and a subscriber that communicate through the desired delivery mechanism (which can be set to
+shared memory only).
diff --git a/docs/fastdds/transport/tcp/tcp.rst b/docs/fastdds/transport/tcp/tcp.rst
@@ -447,10 +447,10 @@ with the **public** IP address and |TCPTransportDescriptor::listening_ports-api|
 
 .. _transport_tcp_example:
 
-HelloWorldExampleTCP
---------------------
+Delivery Mechanisms example
+---------------------------
 
-A TCP version of helloworld example can be found in the
-`HelloWorldExampleTCP folder <https://github.com/eProsima/Fast-DDS/tree/master/examples/cpp/dds/HelloWorldExampleTCP>`_.
-It shows a publisher and a subscriber that communicate through TCP.
-The publisher is configured as *TCP server* while the Subscriber is acting as *TCP client*.
+A hello world example suitable for supported delivery mechanisms can be found in the
+`delivery_mechanisms folder <https://github.com/eProsima/Fast-DDS/tree/master/examples/cpp/delivery_mechanisms>`_.
+It shows a publisher and a subscriber that communicate through the desired delivery mechanism (which can be set to TCP
+only).
diff --git a/docs/fastdds/use_cases/request_reply/request_reply.rst b/docs/fastdds/use_cases/request_reply/request_reply.rst
@@ -152,4 +152,4 @@ For this the client application has to compare the stored |SampleIdentity-api| w
  :start-after: //REQUEST_REPLY_EXAMPLE_CLIENT_RECEIVE_REPLY
  :end-before: //!
 
-.. _Fast DDS repository: https://github.com/eProsima/Fast-DDS/tree/master/examples/cpp/dds/RequestReplyExample
+.. _Fast DDS repository: https://github.com/eProsima/Fast-DDS/tree/master/examples/cpp/request_reply
diff --git a/docs/fastdds/use_cases/well_known_deployments/well_known_deployments.rst b/docs/fastdds/use_cases/well_known_deployments/well_known_deployments.rst
@@ -47,8 +47,8 @@ Users can manually configure which :ref:`dds_layer_publisher` and :ref:`dds_laye
 each other, so they can start sharing user data right away, avoiding the EDP phase.
 
 A complete description of the feature can be found at :ref:`discovery_static`.
-There is also a fully functional helloworld example implementing STATIC EDP in the
-`examples/cpp/dds/StaticHelloWorldExample <https://github.com/eProsima/Fast-DDS/tree/master/examples/cpp/dds/StaticHelloWorldExample>`_
+There is also a fully functional hello world example implementing STATIC EDP in the
+`examples/cpp/static_edp_discovery <https://github.com/eProsima/Fast-DDS/tree/master/examples/cpp/static_edp_discovery>`_
 folder.
 
 The following subsections present an example configuration where a Publisher in

diff --git a/docs/fastdds/use_cases/zero_copy/zero_copy.rst b/docs/fastdds/use_cases/zero_copy/zero_copy.rst
@@ -167,6 +167,7 @@ it has some constraints:
 Next steps
 ----------
 
-The *eProsima Fast DDS* Github repository contains the complete example discussed in this section, as well as
-multiple other examples for different use cases. The example implementing Zero-Copy transfers can be found
-`here <https://github.com/eProsima/Fast-DDS/tree/master/examples/cpp/dds/ZeroCopyExample>`_.
+A hello world example suitable for supported delivery mechanisms can be found in the
+`delivery_mechanisms folder <https://github.com/eProsima/Fast-DDS/tree/master/examples/cpp/delivery_mechanisms>`_.
+It shows a publisher and a subscriber that communicate through the desired delivery mechanism.
+As long as it is zero-copy compatible, both intra-process and data-sharing delivery mechanisms are zero-copy if used.