Skip to content

Commit 786f914

Browse files
depink5depink5
authored
Refactor DDS Router Documentation (#496)
* Refactor DDS Router Documentation Signed-off-by: Denisa <[email protected]> * Fix documentation tests Signed-off-by: Denisa <[email protected]> * Fix windows installation Signed-off-by: Denisa <[email protected]> * Modify the Discovery Server Participant and Installation Signed-off-by: Denisa <[email protected]> --------- Signed-off-by: Denisa <[email protected]>
1 parent 9d03cc8 commit 786f914

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+685
-457
lines changed

‎docs/conf.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -364,7 +364,7 @@ def select_css(html_css_dir):
364364
# for a list of supported languages.
365365
#
366366
# This is also used if you do content translation via gettext catalogs.
367-
# Usually you set 'language' from the command line for these cases.
367+
# Usually you set "language" from the command line for these cases.
368368
language = 'en'
369369

370370
# There are two options for replacing |today|: either, you set today to some

‎docs/index.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
Windows </rst/installation/windows.rst>
2525
Linux </rst/installation/linux.rst>
2626
Docker Image </rst/installation/docker.rst>
27+
Vulcanexus Cloud </rst/installation/vulcanexus.rst>
2728

2829

2930
.. _index_getting_started:

‎docs/resources/examples/change_domain.yaml‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@
22
# CHANGE DDS DOMAIN EXAMPLE #
33
#############################
44

5-
# Yaml configuration file version
6-
version: v5.0
7-
85
# DDS Router participants
96
participants:
107

‎docs/resources/examples/change_domain_allowlist.yaml‎

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,14 @@
11
########################################
22
# CHANGE DOMAIN WITH ALLOWLIST EXAMPLE #
3-
########################################
4-
5-
##################################
6-
# CONFIGURATION VERSION
7-
version: v5.0 # 0
3+
######################################## # 0
84

95
##################################
106
# ALLOWED TOPICS
117
# Allowing FastDDS and ROS2 HelloWorld demo examples topics
128

139
allowlist:
1410
- name: HelloWorldTopic # 1
15-
type: HelloWorld # 1
1611
- name: rt/chatter # 2
17-
type: std_msgs::msg::dds_::String_
1812

1913
##################################
2014
# PARTICIPANTS

‎docs/resources/examples/echo.yaml‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,13 @@
22
# ECHO EXAMPLE #
33
################
44

5-
##################################
6-
# CONFIGURATION VERSION
7-
version: v5.0 # 0
8-
95
##################################
106
# ALLOWED TOPICS
117
# Allowing FastDDS and ROS2 HelloWorld demo examples topics
128

139
allowlist:
1410
- name: HelloWorldTopic # 1
15-
type: HelloWorld # 1
1611
- name: rt/chatter # 2
17-
type: std_msgs::msg::dds_::String_
1812

1913
##################################
2014
# PARTICIPANTS

‎docs/resources/examples/forwarding_routes.yaml‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
######################
22
# FORWARDING ROUTES #
3-
######################
4-
5-
#######################
6-
# CONFIGURATION VERSION
7-
version: v5.0 # 0
3+
###################### # 0
84

95
##############
106
# PARTICIPANTS
@@ -50,7 +46,7 @@ routes: # 5
5046
topic-routes: # 11
5147

5248
- name: Circle # 12
53-
type: HelloWorld # 13
49+
type: Configuration # 13
5450

5551
routes: # 14
5652

‎docs/resources/examples/repeater_client.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ version: v5.0 # 0
1111
# Allowing ROS2 HelloWorld demo_nodes
1212

1313
allowlist:
14-
- name: rt/chatter # 1
15-
type: std_msgs::msg::dds_::String_ # 1
14+
- name: HelloWorldTopic # 1
15+
- name: rt/chatter # 2
1616

1717
##################################
1818
# PARTICIPANTS

‎docs/resources/examples/repeater_server.yaml‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,8 @@ version: v5.0 # 0
1111
# Allowing FastDDS and ROS2 HelloWorld demo examples topics
1212

1313
allowlist:
14-
- name: HelloWorldTopic # 1
15-
type: HelloWorld # 1
14+
- name: HelloWorldTopic # 1
1615
- name: rt/chatter # 2
17-
type: std_msgs::msg::dds_::String_
18-
1916
##################################
2017
# PARTICIPANTS
2118
participants:

‎docs/resources/examples/ros_discovery_client.yaml‎

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
#######################################
22
# ROS DISCOVERY SERVER CLIENT EXAMPLE #
3-
#######################################
4-
5-
##################################
6-
# CONFIGURATION VERSION
7-
version: v5.0 # 0
3+
####################################### # 0
84

95
##################################
106
# ALLOWED TOPICS
@@ -32,13 +28,10 @@ participants:
3228

3329
- name: ClientROS2 # 5
3430
kind: local-discovery-server # 6
35-
discovery-server-guid:
36-
ros-discovery-server: true # 7
37-
id: 2 # 8
38-
connection-addresses: # 9
39-
- domain: localhost # 10
40-
port: 11888 # 11
41-
# 12
31+
connection-addresses: # 7
32+
- domain: localhost # 8
33+
port: 11888 # 9
34+
# 10
4235

4336
##################################
4437
# CONFIGURATION DESCRIPTION

‎docs/resources/examples/ros_discovery_server.yaml‎

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22
# ROS DISCOVERY SERVER EXAMPLE #
33
################################
44

5-
##################################
6-
# CONFIGURATION VERSION
7-
version: v5.0 # 0
8-
95
##################################
106
# ALLOWED TOPICS
117
# Allowing ROS2 HelloWorld demo_nodes topic
@@ -32,13 +28,10 @@ participants:
3228

3329
- name: ServerROS2 # 5
3430
kind: local-discovery-server # 6
35-
discovery-server-guid:
36-
ros-discovery-server: true # 7
37-
id: 1 # 8
38-
listening-addresses: # 9
39-
- domain: localhost # 10
40-
port: 11888 # 11
41-
# 12
31+
listening-addresses: # 7
32+
- domain: localhost # 8
33+
port: 11888 # 9
34+
# 10
4235

4336
##################################
4437
# CONFIGURATION DESCRIPTION

0 commit comments

Comments
 (0)