Manual topics documentation

Signed-off-by: tempate <[email protected]>
eProsima · Oct 9, 2023 · 110d282 · 110d282
1 parent 280a99a
commit 110d282
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/docs/rst/notes/forthcoming_version.rst b/docs/rst/notes/forthcoming_version.rst
@@ -9,6 +9,7 @@ Forthcoming Version
 The next release will include the following **Features**:
 
 * :ref:`Forwarding Routes <user_manual_configuration_forwarding_routes>`.
+* :ref:`Manual Topics <user_manual_configuration_manual_topics>`.
 * :ref:`Max Transmission Rate <user_manual_configuration_max_tx_rate>`.
 * :ref:`Max Reception Rate <user_manual_configuration_max_rx_rate>`.
 * :ref:`Downsampling <user_manual_configuration_downsampling>`.

diff --git a/docs/rst/user_manual/configuration.rst b/docs/rst/user_manual/configuration.rst
@@ -300,6 +300,25 @@ See the :term:`Topic` section for further information about the topic.
           keyed: false       # Topic without keys
 
 
+.. _user_manual_configuration_manual_topics:
+
+Manual Topics
+=============
+
+At times it can be useful to manually predefine a subset of Topic QoS for a set of Participants.
+
+.. code-block:: yaml
+
+    topics:
+      - name: temperature/*
+        type: temp*
+        qos:
+            max-tx-rate: 15
+            downsampling: 2
+        participants:
+            - Participant0
+            - Participant1
+
 Topic Filtering
 ===============