Skip to content
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.

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

Tutorial chapter about configuring FastDDS middleware with XML files #1

Open
wants to merge 79 commits into
base: master
Choose a base branch
from

Conversation

IkerLuengo
Copy link
Owner

Signed-off-by: Iker Luengo [email protected]

maryaB-osr and others added 30 commits December 3, 2020 04:34
* committing version test

* remove tags

Signed-off-by: maryaB-osr <[email protected]>

* adding whitelists and trying released/in-development

Signed-off-by: maryaB-osr <[email protected]>

* comment out unused config with wrong type causing warning

* Enable pulling from origin and released flag

* Example warning banner

* reverse order and move version list below navigation

Signed-off-by: maryaB-osr <[email protected]>

* reorder version list

Signed-off-by: maryaB-osr <[email protected]>

* refactored after separating versions

Signed-off-by: maryaB-osr <[email protected]>

* lowercase branch names, add dashing

Signed-off-by: maryaB-osr <[email protected]>

* fixing branch versioning

Signed-off-by: maryaB-osr <[email protected]>

* travis.yml: pip3 install sphinx_multiversion

Signed-off-by: maryaB-osr <[email protected]>

* remove missing-reference function

Signed-off-by: maryaB-osr <[email protected]>

* fix typo

Signed-off-by: maryaB-osr <[email protected]>

* no env config video for rolling

Signed-off-by: maryaB-osr <[email protected]>

Co-authored-by: Tully Foote <[email protected]>
* XML launch files are still supported in ROS2

Should this also mention YAML? I saw in the source code that there is also a YAML frontend.

* Shorten long sentence

* Add "and YAML"

(cherry picked from commit e86c950)

Co-authored-by: Nikolai Morin <[email protected]>
…os2#955)

Signed-off-by: Chris Lalancette <[email protected]>
(cherry picked from commit 34b1b3b)

Co-authored-by: Chris Lalancette <[email protected]>
(cherry picked from commit 69712f7)

Co-authored-by: Andre Nguyen <[email protected]>
Mark items as complete, add in new items, and update time
estimates.

Signed-off-by: Chris Lalancette <[email protected]>
(cherry picked from commit aa228e9)

Co-authored-by: Chris Lalancette <[email protected]>
Signed-off-by: maryaB-osr <[email protected]>
(cherry picked from commit d73b030)

Co-authored-by: Marya Belanger <[email protected]>
Signed-off-by: Chris Lalancette <[email protected]>
(cherry picked from commit dab7090
and commit 9289f21)

Co-authored-by: Chris Lalancette <[email protected]>
* Add a section on becoming a core maintainer.

Signed-off-by: Chris Lalancette <[email protected]>
Co-authored-by: William Woodall <[email protected]>
(cherry picked from commit 654c0c2)

Co-authored-by: Chris Lalancette <[email protected]>
* Add EOL banner to eloquent

Signed-off-by: maryaB-osr <[email protected]>

* Change the wording for version banners (ros2#991)

* Change the wording for version banners

Signed-off-by: maryaB-osr <[email protected]>

* Apply suggestions from code review

Co-authored-by: Chris Lalancette <[email protected]>

* add commas to review change

Signed-off-by: maryaB-osr <[email protected]>

Co-authored-by: Chris Lalancette <[email protected]>

Co-authored-by: Chris Lalancette <[email protected]>
* Update Single-Package-Define-And-Use-Interface.rst

* Update Single-Package-Define-And-Use-Interface.rst

fix typo

* Update source/Tutorials/Single-Package-Define-And-Use-Interface.rst

Co-authored-by: Marya Belanger <[email protected]>
(cherry picked from commit afae75e)

Co-authored-by: woodz- <[email protected]>
Signed-off-by: Chris Lalancette <[email protected]>
(cherry picked from commit 1edebe3)

# Conflicts:
#	source/Tutorials/Working-with-multiple-RMW-implementations.rst
Signed-off-by: Chris Lalancette <[email protected]>
(cherry picked from commit 22800cd)
Signed-off-by: Chris Lalancette <[email protected]>
(cherry picked from commit d944d4d)
Signed-off-by: Chris Lalancette <[email protected]>
(cherry picked from commit 9271039)
Signed-off-by: Chris Lalancette <[email protected]>
…#1005)

Signed-off-by: maryaB-osr <[email protected]>
(cherry picked from commit a34a067)

Co-authored-by: Marya Belanger <[email protected]>
Signed-off-by: ruffsl <[email protected]>
(cherry picked from commit 438bc79)

Co-authored-by: Ruffin <[email protected]>
(cherry picked from commit e730d33)

Co-authored-by: Geoffrey Biggs <[email protected]>
…os2#1029)

Signed-off-by: maryaB-osr <[email protected]>
(cherry picked from commit 109b41a)

Co-authored-by: Marya Belanger <[email protected]>
Co-authored-by: Brian Gerkey <[email protected]>
(cherry picked from commit 7fd6133)

Co-authored-by: gerkey <[email protected]>
…os2#1039)

* Add Galactic feature note for externally configuring QoS

Signed-off-by: Jacob Perron <[email protected]>
(cherry picked from commit 76c31dc)

Co-authored-by: Jacob Perron <[email protected]>
… (ros2#1045)

* Remove Sony logo pending permission for use in this context

Co-authored-by: Brian Gerkey <[email protected]>
(cherry picked from commit 49c28d8)

Co-authored-by: gerkey <[email protected]>
In particular, make it so that requirements.txt has all of
the requirements (including sphinx-multiversion), and that the
Makefile has a target for building multiversion.

Signed-off-by: Chris Lalancette <[email protected]>
This will be used by the buildfarm job to build the documentation
and upload it to docs.ros.org.

Signed-off-by: Chris Lalancette <[email protected]>
(cherry picked from commit 0bfc167)

Co-authored-by: Abrar Rahman Protyasha <[email protected]>
clalancette and others added 9 commits February 18, 2021 08:23
That way it renders more nicely from other pages.

Signed-off-by: Chris Lalancette <[email protected]>
(cherry picked from commit bcd1972)
…2#1118)

* Add crystal to the list of branches to be built by multiversion.

Also make sure to mark it EOL.

Signed-off-by: Chris Lalancette <[email protected]>
'release-foxy' does not point to a valid file and 'release-latest' is no longer used.

Signed-off-by: Jacob Perron <[email protected]>
(cherry picked from commit b0f7676)

# Conflicts:
#	source/Installation/Maintaining-a-Source-Checkout.rst

Co-authored-by: Jacob Perron <[email protected]>
Co-authored-by: Brian Gerkey <[email protected]>
(cherry picked from commit 4d34976)

Co-authored-by: gerkey <[email protected]>
(cherry picked from commit 1a5d5b2)

Co-authored-by: Connor Anderson <[email protected]>
…#1139) (ros2#1144)

These two directories seem common enough, and already a convention,
that we should consider adding them to the recommended package layout.

Signed-off-by: Jacob Perron <[email protected]>
(cherry picked from commit 5eb270f)

Co-authored-by: Jacob Perron <[email protected]>
* remove rolling installation landing page

Signed-off-by: maryaB-osr <[email protected]>

* remove rolling installation landing page

Signed-off-by: maryaB-osr <[email protected]>

* Fix the links.

Signed-off-by: Chris Lalancette <[email protected]>

* shorten title, mention distro in first line

Signed-off-by: maryaB-osr <[email protected]>

* shorten title

Signed-off-by: maryaB-osr <[email protected]>

* Fix one more installation link.

Signed-off-by: Chris Lalancette <[email protected]>

Co-authored-by: Chris Lalancette <[email protected]>
@clalancette clalancette force-pushed the tutorials/fastdds-configuration branch from a561a28 to 63da3eb Compare March 1, 2021 14:06
clalancette and others added 10 commits March 1, 2021 13:29
The read-the-docs theme is far nicer (in my opinion) than the
default 'alabaster' theme.  Also, it gives us links to GitHub
sources and the version picker without additional plugins
needed.  This theme also puts the table-of-contents for
subsections in the order they were written, not in alphabetical
order.

Signed-off-by: Chris Lalancette <[email protected]>
This should make it a little easier for readers to understand
which branch of the documentation they are reading.

Signed-off-by: Chris Lalancette <[email protected]>
Signed-off-by: maryaB-osr <[email protected]>

add/update doc-type descriptions
also update some other small parts of the overview page

Signed-off-by: maryaB-osr <[email protected]>

partial move

Signed-off-by: maryaB-osr <[email protected]>

partial move

Signed-off-by: maryaB-osr <[email protected]>

move troubleshooting to guides, add redirect-from to pages moved so far

Signed-off-by: maryaB-osr <[email protected]>

moved remaining pages, added redirects

Signed-off-by: maryaB-osr <[email protected]>
Signed-off-by: maryaB-osr <[email protected]>
Signed-off-by: maryaB-osr <[email protected]>
Signed-off-by: maryaB-osr <[email protected]>
Signed-off-by: maryaB-osr <[email protected]>
@IkerLuengo IkerLuengo force-pushed the tutorials/fastdds-configuration branch from 9c6f4ac to 2efee1f Compare March 4, 2021 15:03
Since the PR was retargeted to the rolling branch, the remark is not
needed anymore

Signed-off-by: Iker Luengo <[email protected]>
@IkerLuengo IkerLuengo force-pushed the tutorials/fastdds-configuration branch from 2efee1f to 4e27308 Compare March 4, 2021 15:11
@IkerLuengo IkerLuengo force-pushed the tutorials/fastdds-configuration branch from 0710a10 to bc6c47f Compare March 23, 2021 12:08
@IkerLuengo IkerLuengo force-pushed the tutorials/fastdds-configuration branch from bc6c47f to 075165e Compare March 23, 2021 12:11
@IkerLuengo IkerLuengo force-pushed the tutorials/fastdds-configuration branch from e132631 to 29d264d Compare April 9, 2021 06:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants