Add related versions table (#652)

* Refs #20497: Add related versions table Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Move table to more visible path Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Add link Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Apply internal revision suggestions Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Update latest version in ShapesDemo Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Add link in installation dependencies sections Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: display Related versions as first 'Versions' page Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Add missing header links/references Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Apply rev suggestions Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Include supported versions in tabs Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Include build time dependencies Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Apply internal review suggestions Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Add missing links (gen-related) and fix identation Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Refactor build system dependencies table Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Add words to spelling whitelist Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Apply suggestions Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Apply second round of suggestions Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Apply third round of suggestions Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Please linters Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Apply fourth round of suggestions Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Apply fifth round of suggestions Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20497: Apply sixth round of suggestions Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> --------- Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com>
eProsima · Mar 6, 2024 · dcb0272 · dcb0272
1 parent 05ebded
commit dcb0272
Show file tree

Hide file tree

Showing 12 changed files with 478 additions and 3 deletions.
diff --git a/docs/02-formalia/titlepage.rst b/docs/02-formalia/titlepage.rst
@@ -168,6 +168,23 @@ Main Features
   dependencies (such as *eProsima Fast CDR*) and the external ones (such as the *foonathan* library) are free and
   open source.
 
+Dependencies and compatibilities
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+*eProsima Fast DDS* is continuously evolving and improving.
+This means that the different software products that are part of the Fast DDS ecosystem are evolving and improving
+together with Fast DDS.
+
+Fast DDS has some :ref:`library dependencies <dependencies_compatibilities_library_dependencies>`, e.g. the previously
+mentioned Fast CDR for data serialization, or OpenSSL for secure communications.
+Depending on different :ref:`platform support levels <dependencies_compatibilities_platform_support>`, it has also
+different :ref:`build dependencies <dependencies_compatibilities_build_system_dependencies>`.
+
+Finally, there are some other *eProsima* products that use Fast DDS as a middleware, such as *Micro XRCE-DDS*,
+*DDS Router* and *Fast DDS python* wrapper.
+Those that are strongly attached to each Fast DDS supported version are described in :ref:`this product compatibility
+table<dependencies_compatibilities_product_compatibility>`.
+
 Contacts and Commercial support
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 

diff --git a/docs/fastdds/getting_started/getting_started.rst b/docs/fastdds/getting_started/getting_started.rst
@@ -13,3 +13,8 @@ application.
     definitions
     simple_app/simple_app
     simple_python_app/simple_python_app
+
+.. seealso::
+
+    Check Fast DDS dependencies, libraries, and related packages in the :ref:`dependencies_compatibilities` section.
+
diff --git a/docs/index.rst b/docs/index.rst
@@ -93,8 +93,9 @@
 .. _index_notes:
 
 .. toctree::
-   :caption: Release Notes
+   :caption: Versions
    :maxdepth: 2
    :hidden:
 
+   /notes/versions
    /notes/notes
diff --git a/docs/installation/binaries/binaries_linux.rst b/docs/installation/binaries/binaries_linux.rst
@@ -48,6 +48,11 @@ The :code:`src` folder contains the following packages:
 * :code:`fastrtps`, the core library of *eProsima Fast DDS* library.
 * :code:`fastddsgen`, a Java application that generates source code using the data types defined in an IDL file.
 
+.. seealso::
+
+    For further information about Fast DDS dependencies, as well as for the corresponding versions of other related
+    products, please refer to the Fast DDS :ref:`dependencies_compatibilities` section.
+
 In case any of these components is unwanted, it can be simply renamed or removed from the :code:`src`
 directory.
 

diff --git a/docs/installation/binaries/binaries_windows.rst b/docs/installation/binaries/binaries_windows.rst
@@ -70,6 +70,11 @@ By default, the installation will download all the available packages, namely:
 * :code:`fastrtps`, the core library of *eProsima Fast DDS* library.
 * :code:`fastddsgen`, a Java application that generates source code using the data types defined in an IDL file.
 
+.. seealso::
+
+    For further information about Fast DDS dependencies, as well as for the corresponding versions of other related
+    products, please refer to the Fast DDS :ref:`dependencies_compatibilities` section.
+
 .. _env_vars_bw:
 
 Environment variables

diff --git a/docs/installation/sources/sources_linux.rst b/docs/installation/sources/sources_linux.rst
@@ -69,6 +69,12 @@ Dependencies
 * :ref:`gtest_sl` [optional]
 * :ref:`pythonreq_sl` [optional]
 
+.. seealso::
+
+    For further information about this Fast DDS version dependencies, as well as for the corresponding versions of
+    other related products, please refer to the Fast DDS :ref:`dependencies_compatibilities_library_dependencies`
+    section.
+
 .. _asiotinyxml2_sl:
 
 Asio and TinyXML2 libraries
@@ -603,6 +609,11 @@ Gradle is an open-source build automation tool which requires a Java version to
     *Fast DDS-Gen* introduced support for Gradle 7 in release v2.2.0.
     Gradle 8 is not yet supported.
 
+.. seealso::
+
+    For further information about Fast DDS-Gen product related versions, please refer to the
+    :ref:`dependencies_compatibilities_library_dependencies` section.
+
 .. _java_sl:
 
 Java JDK

diff --git a/docs/installation/sources/sources_mac.rst b/docs/installation/sources/sources_mac.rst
@@ -118,6 +118,12 @@ Dependencies
 * :ref:`asiotinyxml2_sm`
 * :ref:`openssl_sm`
 
+.. seealso::
+
+    For further information about this Fast DDS version dependencies, as well as for the corresponding versions of
+    other related products, please refer to the Fast DDS :ref:`dependencies_compatibilities_library_dependencies`
+    section.
+
 .. _asiotinyxml2_sm:
 
 Asio and TinyXML2 libraries
@@ -336,6 +342,11 @@ Gradle is an open-source build automation tool which requires a Java version to
     *Fast DDS-Gen* introduced support for Gradle 7 in release v2.2.0.
     Gradle 8 is not yet supported.
 
+.. seealso::
+
+    For further information about Fast DDS-Gen product related versions, please refer to the
+    :ref:`dependencies_compatibilities_library_dependencies` section.
+
 .. _java_sm:
 
 Java JDK

diff --git a/docs/installation/sources/sources_qnx.rst b/docs/installation/sources/sources_qnx.rst
@@ -26,6 +26,11 @@ sources. The following packages will be installed:
   `standard CDR <https://www.omg.org/cgi-bin/doc?formal/02-06-51>`_ serialization mechanism.
 * :code:`fastrtps`, the core library of *eProsima Fast DDS* library.
 
+.. seealso::
+
+    For further information about Fast DDS library dependencies, as well as for the corresponding versions of other
+    related products, please refer to the Fast DDS :ref:`dependencies_compatibilities_library_dependencies` section.
+
 The :ref:`requirements_sw_qnx` detailed below needs to be met first.
 
 .. _requirements_sw_qnx:
@@ -53,6 +58,11 @@ QNX SDP is QNX's Software Development Platform which contains tools and files wh
 For the purpose of these instructions, QNX SDP 7.1 is assumed to be installed at ~/qnx710.
 If this is not the case, please adjust the paths accordingly.
 
+.. seealso::
+
+    For further information about Fast DDS build system dependencies regarding QNX 7.1, please refer to the Fast DDS
+    :ref:`dependencies_compatibilities_build_system_dependencies` section.
+
 .. _cmake_pip3_git_sw:
 
 CMake, pip3, git, dos2unix, and automake

diff --git a/docs/installation/sources/sources_windows.rst b/docs/installation/sources/sources_windows.rst
@@ -124,6 +124,12 @@ Dependencies
 * :ref:`asiotinyxml2_sw`
 * :ref:`openssl_sw`
 
+.. seealso::
+
+    For further information about this Fast DDS version dependencies, as well as for the corresponding versions of
+    other related products, please refer to the Fast DDS :ref:`dependencies_compatibilities_library_dependencies`
+    section.
+
 .. _asiotinyxml2_sw:
 
 Asio and TinyXML2 libraries
@@ -625,6 +631,11 @@ Gradle is an open-source build automation tool which requires a Java version to
     *Fast DDS-Gen* introduced support for Gradle 7 in release v2.2.0.
     Gradle 8 is not yet supported.
 
+.. seealso::
+
+    For further information about Fast DDS-Gen product related versions, please refer to the
+    :ref:`dependencies_compatibilities_library_dependencies` section.
+
 .. _java_sb:
 
 Java JDK

diff --git a/docs/notes/notes.rst b/docs/notes/notes.rst
@@ -27,8 +27,14 @@ This patch release includes the following **fixes**:
 9. Set 2.11.x as EOL
 
 .. note::
-  When upgrading to version 2.13.3 it is **advisable** to regenerate generated source from IDL files
-  using `Fast DDS-Gen v3.2.1 <https://github.com/eProsima/Fast-DDS-Gen/releases/tag/v3.2.1>`_.
+
+    When upgrading to version 2.13.3 it is **advisable** to regenerate generated source from IDL files
+    using `Fast DDS-Gen v3.2.1 <https://github.com/eProsima/Fast-DDS-Gen/releases/tag/v3.2.1>`_.
+
+.. seealso::
+
+    For further information about the corresponding versions of other products related to this Fast DDS version, please
+    refer to the :ref:`dependencies_compatibilities_product_compatibility` section.
 
 Previous versions
 =================