Skip to content

[22792] Refactor DDS Router Documentation #496

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rsanchez15 merged 4 commits into from
Apr 8, 2025
Merged

[22792] Refactor DDS Router Documentation #496

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cc0bada
Refactor DDS Router Documentation
depink5 Mar 24, 2025
22d0a30
Fix documentation tests
depink5 Mar 24, 2025
29a6c05
Fix windows installation
depink5 Apr 2, 2025
066f426
Modify the Discovery Server Participant and Installation
depink5 Apr 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,7 @@ def select_css(html_css_dir):
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set 'language' from the command line for these cases.
# Usually you set "language" from the command line for these cases.
language = 'en'

# There are two options for replacing |today|: either, you set today to some
Expand Down
1 change: 1 addition & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
Windows </rst/installation/windows.rst>
Linux </rst/installation/linux.rst>
Docker Image </rst/installation/docker.rst>
Vulcanexus Cloud </rst/installation/vulcanexus.rst>


.. _index_getting_started:
Expand Down
3 changes: 0 additions & 3 deletions docs/resources/examples/change_domain.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
# CHANGE DDS DOMAIN EXAMPLE #
#############################

# Yaml configuration file version
version: v5.0

# DDS Router participants
participants:

Expand Down
8 changes: 1 addition & 7 deletions docs/resources/examples/change_domain_allowlist.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,14 @@
########################################
# CHANGE DOMAIN WITH ALLOWLIST EXAMPLE #
########################################

##################################
# CONFIGURATION VERSION
version: v5.0 # 0
######################################## # 0

##################################
# ALLOWED TOPICS
# Allowing FastDDS and ROS2 HelloWorld demo examples topics

allowlist:
- name: HelloWorldTopic # 1
type: HelloWorld # 1
- name: rt/chatter # 2
type: std_msgs::msg::dds_::String_

##################################
# PARTICIPANTS
Expand Down
6 changes: 0 additions & 6 deletions docs/resources/examples/echo.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,13 @@
# ECHO EXAMPLE #
################

##################################
# CONFIGURATION VERSION
version: v5.0 # 0

##################################
# ALLOWED TOPICS
# Allowing FastDDS and ROS2 HelloWorld demo examples topics

allowlist:
- name: HelloWorldTopic # 1
type: HelloWorld # 1
- name: rt/chatter # 2
type: std_msgs::msg::dds_::String_

##################################
# PARTICIPANTS
Expand Down
8 changes: 2 additions & 6 deletions docs/resources/examples/forwarding_routes.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
######################
# FORWARDING ROUTES #
######################

#######################
# CONFIGURATION VERSION
version: v5.0 # 0
###################### # 0

##############
# PARTICIPANTS
Expand Down Expand Up @@ -50,7 +46,7 @@ routes: # 5
topic-routes: # 11

- name: Circle # 12
type: HelloWorld # 13
type: Configuration # 13

routes: # 14

Expand Down
4 changes: 2 additions & 2 deletions docs/resources/examples/repeater_client.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ version: v5.0 # 0
# Allowing ROS2 HelloWorld demo_nodes

allowlist:
- name: rt/chatter # 1
type: std_msgs::msg::dds_::String_ # 1
- name: HelloWorldTopic # 1
- name: rt/chatter # 2

##################################
# PARTICIPANTS
Expand Down
5 changes: 1 addition & 4 deletions docs/resources/examples/repeater_server.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,8 @@ version: v5.0 # 0
# Allowing FastDDS and ROS2 HelloWorld demo examples topics

allowlist:
- name: HelloWorldTopic # 1
type: HelloWorld # 1
- name: HelloWorldTopic # 1
- name: rt/chatter # 2
type: std_msgs::msg::dds_::String_

##################################
# PARTICIPANTS
participants:
Expand Down
17 changes: 5 additions & 12 deletions docs/resources/examples/ros_discovery_client.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
#######################################
# ROS DISCOVERY SERVER CLIENT EXAMPLE #
#######################################

##################################
# CONFIGURATION VERSION
version: v5.0 # 0
####################################### # 0

##################################
# ALLOWED TOPICS
Expand Down Expand Up @@ -32,13 +28,10 @@ participants:

- name: ClientROS2 # 5
kind: local-discovery-server # 6
discovery-server-guid:
ros-discovery-server: true # 7
id: 2 # 8
connection-addresses: # 9
- domain: localhost # 10
port: 11888 # 11
# 12
connection-addresses: # 7
- domain: localhost # 8
port: 11888 # 9
# 10

##################################
# CONFIGURATION DESCRIPTION
Expand Down
15 changes: 4 additions & 11 deletions docs/resources/examples/ros_discovery_server.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@
# ROS DISCOVERY SERVER EXAMPLE #
################################

##################################
# CONFIGURATION VERSION
version: v5.0 # 0

##################################
# ALLOWED TOPICS
# Allowing ROS2 HelloWorld demo_nodes topic
Expand All @@ -32,13 +28,10 @@ participants:

- name: ServerROS2 # 5
kind: local-discovery-server # 6
discovery-server-guid:
ros-discovery-server: true # 7
id: 1 # 8
listening-addresses: # 9
- domain: localhost # 10
port: 11888 # 11
# 12
listening-addresses: # 7
- domain: localhost # 8
port: 11888 # 9
# 10

##################################
# CONFIGURATION DESCRIPTION
Expand Down
8 changes: 1 addition & 7 deletions docs/resources/examples/wan_client.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,14 @@
######################
# WAN CLIENT EXAMPLE #
######################

##################################
# CONFIGURATION VERSION
version: v5.0 # 0
###################### # 0

##################################
# ALLOWED TOPICS
# Allowing FastDDS and ROS2 HelloWorld demo examples topics

allowlist:
- name: HelloWorldTopic # 1
type: HelloWorld # 1
- name: rt/chatter # 2
type: std_msgs::msg::dds_::String_

##################################
# PARTICIPANTS
Expand Down
8 changes: 1 addition & 7 deletions docs/resources/examples/wan_ds_client.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,14 @@
#######################################
# WAN DISCOVERY SERVER CLIENT EXAMPLE #
#######################################

##################################
# CONFIGURATION VERSION
version: v5.0 # 0
####################################### # 0

##################################
# ALLOWED TOPICS
# Allowing FastDDS and ROS2 HelloWorld demo examples topics

allowlist:
- name: HelloWorldTopic # 1
type: HelloWorld # 1
- name: rt/chatter # 2
type: std_msgs::msg::dds_::String_

##################################
# PARTICIPANTS
Expand Down
8 changes: 1 addition & 7 deletions docs/resources/examples/wan_ds_server.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,14 @@
#######################################
# WAN DISCOVERY SERVER SERVER EXAMPLE #
#######################################

##################################
# CONFIGURATION VERSION
version: v5.0 # 0
####################################### # 0

##################################
# ALLOWED TOPICS
# Allowing FastDDS and ROS2 HelloWorld demo examples topics

allowlist:
- name: HelloWorldTopic # 1
type: HelloWorld # 1
- name: rt/chatter # 2
type: std_msgs::msg::dds_::String_

##################################
# PARTICIPANTS
Expand Down
8 changes: 1 addition & 7 deletions docs/resources/examples/wan_server.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,14 @@
######################
# WAN SERVER EXAMPLE #
######################

##################################
# CONFIGURATION VERSION
version: v5.0 # 0
###################### # 0

##################################
# ALLOWED TOPICS
# Allowing FastDDS and ROS2 HelloWorld demo examples topics

allowlist:
- name: HelloWorldTopic # 1
type: HelloWorld # 1
- name: rt/chatter # 2
type: std_msgs::msg::dds_::String_

##################################
# PARTICIPANTS
Expand Down
6 changes: 1 addition & 5 deletions docs/resources/examples/xml.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
######################
# XML EXAMPLE #
######################

##################################
# CONFIGURATION VERSION
version: v5.0 # 0
###################### # 0

##################################
# CONFIGURATION VERSION
Expand Down
2 changes: 0 additions & 2 deletions docs/resources/getting_started/client-ddsrouter.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# client-ddsrouter.yaml

version: v5.0

allowlist:
- name: Square

Expand Down
2 changes: 0 additions & 2 deletions docs/resources/getting_started/server-ddsrouter.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# server-ddsrouter.yaml

version: v5.0

allowlist:
- name: Square

Expand Down
2 changes: 0 additions & 2 deletions docs/resources/use_cases/ros_cloud/local-ddsrouter.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# local-ddsrouter.yaml

version: v5.0

allowlist:
- name: rt/chatter
type: std_msgs::msg::dds_::String_
Expand Down
2 changes: 0 additions & 2 deletions docs/resources/use_cases/wan_tcp/dds_router_net_A.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
version: v5.0

participants:

- name: DDS_LAN_A
Expand Down
2 changes: 0 additions & 2 deletions docs/resources/use_cases/wan_tcp/dds_router_net_B_lan.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
version: v5.0

participants:

- name: DDS_LAN_B
Expand Down
2 changes: 0 additions & 2 deletions docs/resources/use_cases/wan_tcp/dds_router_net_B_wan.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
version: v5.0

participants:

- name: DDS_LAN_B
Expand Down
Loading
Loading