diff --git a/docs/rst/figures/screenshots/domain_graph.png b/docs/rst/figures/screenshots/domain_graph.png new file mode 100644 index 00000000..5eeff475 Binary files /dev/null and b/docs/rst/figures/screenshots/domain_graph.png differ diff --git a/docs/rst/figures/screenshots/init-monitor.png b/docs/rst/figures/screenshots/init-monitor.png index 6715fe8d..bbd67f48 100644 Binary files a/docs/rst/figures/screenshots/init-monitor.png and b/docs/rst/figures/screenshots/init-monitor.png differ diff --git a/docs/rst/figures/screenshots/main_panel.png b/docs/rst/figures/screenshots/main_panel.png index 7ec439cb..bef014fc 100644 Binary files a/docs/rst/figures/screenshots/main_panel.png and b/docs/rst/figures/screenshots/main_panel.png differ diff --git a/docs/rst/figures/screenshots/problem.png b/docs/rst/figures/screenshots/problem.png new file mode 100644 index 00000000..bf61a375 Binary files /dev/null and b/docs/rst/figures/screenshots/problem.png differ diff --git a/docs/rst/figures/screenshots/problem_detail.png b/docs/rst/figures/screenshots/problem_detail.png new file mode 100644 index 00000000..0a80eb25 Binary files /dev/null and b/docs/rst/figures/screenshots/problem_detail.png differ diff --git a/docs/rst/figures/screenshots/shapes_domain.png b/docs/rst/figures/screenshots/shapes_domain.png new file mode 100644 index 00000000..8271cd7c Binary files /dev/null and b/docs/rst/figures/screenshots/shapes_domain.png differ diff --git a/docs/rst/figures/screenshots/shapes_topic.png b/docs/rst/figures/screenshots/shapes_topic.png new file mode 100644 index 00000000..9a2b4e63 Binary files /dev/null and b/docs/rst/figures/screenshots/shapes_topic.png differ diff --git a/docs/rst/user_manual/chart_panel_index.rst b/docs/rst/user_manual/chart_panel_index.rst index 58facb35..360e4cbb 100644 --- a/docs/rst/user_manual/chart_panel_index.rst +++ b/docs/rst/user_manual/chart_panel_index.rst @@ -28,9 +28,21 @@ arrows. Those arrows would start from the DataWriter and point to the Topic, or start from the Topic and point to the DataReader (in publication and subscription cases, respectively). +.. figure:: /rst/figures/screenshots/shapes_domain.png + :align: center + If filtering that graph by Topic, only the entities whose endpoints are publishing in, or subscribed to the selected Topic would be represented in the view. +.. figure:: /rst/figures/screenshots/shapes_topic.png + :align: center + +If there are problems reported by a DDS entity, they are condensed by entity in the bottom layout problem section. +Among the problem counter, the problem is described and, in some cases, followed by a link to the documentation. + +.. figure:: /rst/figures/screenshots/problem_detail.png + :align: center + .. toctree:: :maxdepth: 2 diff --git a/docs/rst/user_manual/layout.rst b/docs/rst/user_manual/layout.rst index 39173598..7844f7f9 100644 --- a/docs/rst/user_manual/layout.rst +++ b/docs/rst/user_manual/layout.rst @@ -275,13 +275,13 @@ Domain View ----------- This view in the main panel shows the connections between DataWriters and DataReaders that belong to the same DDS Domain. -They are represented encapsulated inside their physical entities (see :ref:`_entities` relationship), and with a +They are represented encapsulated inside their physical entities (see :ref:`entities` relationship), and with a connection to the topic they are published and subscribed, respectively. -.. figure:: /rst/figures/screenshots/chartbox.png +.. figure:: /rst/figures/screenshots/domain_graph.png :align: center -Clicking on any entity displays its detailed information in the :ref:`_info_panel`. +Clicking on any entity displays its detailed information in the :ref:`info_panel`. Right click allows changing the alias of the entity, filter the problems to display only the selected entity's problems and, in the case of topics, filter the domain graph by topic, so they are displayed only the entities related to the selected topic. @@ -298,3 +298,6 @@ counter, for instance. The entities that has reported a problem would display a warning or error icon in close to the entity name, based on the severity of the problem. The entity representation in the domain graph may also display that icon. + +.. figure:: /rst/figures/screenshots/problem.png + :align: center