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

added Publishing-Messages-Using-YAML-Files.rst and edited Intermediat… #5034

Merged
merged 10 commits into from
Feb 17, 2025

Conversation

NickTziaros
Copy link
Contributor

Closes #4984

I created a first draft of the tutorial.

I used a geometry_msgs/msg/Twist message for the demo, assuming that those new to ROS 2 are already familiar with it from the Understanding Topics tutorial. However, since this functionality is especially useful for editing and publishing more complex structured messages, I could switch to using a geometry_msgs/msg/PoseStamped message instead.

@fujitatomoya Let me know what you think and if this is what you had in mind.

@fujitatomoya fujitatomoya self-assigned this Feb 15, 2025
@fujitatomoya fujitatomoya self-requested a review February 15, 2025 01:00
Copy link
Collaborator

@fujitatomoya fujitatomoya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

overall, lgtm. i believe this documentation is really well-explained 👍

but i would like to hear opinion if we want to keep this tutorial under intermediate section. for me, this could be in beginner's tutorial aligned with https://docs.ros.org/en/rolling/Tutorials/Beginner-CLI-Tools/Understanding-ROS2-Topics/Understanding-ROS2-Topics.html. CC: @kscottz @christophebedard

NickTziaros and others added 2 commits February 15, 2025 19:06
…iles.rst

Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com>
…iles.rst

Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com>
@NickTziaros
Copy link
Contributor Author

but i would like to hear opinion if we want to keep this tutorial under intermediate section

I completely agree. I could even argue that it could be integrated into https://docs.ros.org/en/rolling/Tutorials/Beginner-CLI-Tools/Understanding-ROS2-Topics/Understanding-ROS2-Topics.html but that might be a strech

@fujitatomoya
Copy link
Collaborator

I could even argue that it could be integrated into https://docs.ros.org/en/rolling/Tutorials/Beginner-CLI-Tools/Understanding-ROS2-Topics/Understanding-ROS2-Topics.html but that might be a strech

yeah i thought that too. IMO https://docs.ros.org/en/rolling/Tutorials/Beginner-CLI-Tools/Understanding-ROS2-Topics/Understanding-ROS2-Topics.html just introduces each verbs for beginners, so that it can just introduce what kind of verbs are available, saying probably not describing the options or arguments like this case. i prefer to have another page aligned with it, and it can be under beginner's tutorial.

…iles.rst

Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com>
NickTziaros and others added 3 commits February 17, 2025 10:10
…iles.rst

Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com>
…iles.rst

Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com>
…iles.rst

Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com>
Thanks for pointing it out, I didnt notice the extention beeing there

Co-authored-by: Christophe Bedard <bedard.christophe@gmail.com>
Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com>
…iles.rst

Co-authored-by: Christophe Bedard <bedard.christophe@gmail.com>
Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com>
@christophebedard christophebedard added the backport-all backport at reviewers discretion; from rolling to all versions label Feb 17, 2025
Copy link
Member

@christophebedard christophebedard left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, thank you for the PR!

@christophebedard
Copy link
Member

but i would like to hear opinion if we want to keep this tutorial under intermediate section. for me, this could be in beginner's tutorial aligned with https://docs.ros.org/en/rolling/Tutorials/Beginner-CLI-Tools/Understanding-ROS2-Topics/Understanding-ROS2-Topics.html

I completely agree. I could even argue that it could be integrated into https://docs.ros.org/en/rolling/Tutorials/Beginner-CLI-Tools/Understanding-ROS2-Topics/Understanding-ROS2-Topics.html but that might be a stretch

yeah i thought that too. IMO https://docs.ros.org/en/rolling/Tutorials/Beginner-CLI-Tools/Understanding-ROS2-Topics/Understanding-ROS2-Topics.html just introduces each verbs for beginners, so that it can just introduce what kind of verbs are available, saying probably not describing the options or arguments like this case. i prefer to have another page aligned with it, and it can be under beginner's tutorial.

I really think we should keep the beginner tutorials very simple and not add too many tutorials there, which also means not having too many ways of doing things in them.

However, one thing we can do is to add more links between tutorials, e.g., a link at the end of a tutorial to another, more advanced tutorial.

@fujitatomoya
Copy link
Collaborator

@NickTziaros thanks for fixing. we can always come back to discussion on where this should land, i think that is okay to have this in intermediate section after the reviews from @christophebedard @ahcorde . so let's merge this 🚀

@fujitatomoya fujitatomoya merged commit ec89552 into ros2:rolling Feb 17, 2025
5 checks passed
@fujitatomoya
Copy link
Collaborator

Note that, we cannot backport this ros2/ros2cli#925 is only available on rolling.

mergify bot pushed a commit that referenced this pull request Feb 17, 2025
#5034)

* added Publishing-Messages-Using-YAML-Files.rst and edited Intermediate.rst

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com>

* Update source/Tutorials/Intermediate.rst

Thanks for pointing it out, I didnt notice the extention beeing there

Co-authored-by: Christophe Bedard <bedard.christophe@gmail.com>
Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Christophe Bedard <bedard.christophe@gmail.com>
Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com>

---------

Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com>
Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
Co-authored-by: Christophe Bedard <bedard.christophe@gmail.com>
(cherry picked from commit ec89552)
mergify bot pushed a commit that referenced this pull request Feb 17, 2025
#5034)

* added Publishing-Messages-Using-YAML-Files.rst and edited Intermediate.rst

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com>

* Update source/Tutorials/Intermediate.rst

Thanks for pointing it out, I didnt notice the extention beeing there

Co-authored-by: Christophe Bedard <bedard.christophe@gmail.com>
Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Christophe Bedard <bedard.christophe@gmail.com>
Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com>

---------

Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com>
Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
Co-authored-by: Christophe Bedard <bedard.christophe@gmail.com>
(cherry picked from commit ec89552)
@fujitatomoya fujitatomoya removed the backport-all backport at reviewers discretion; from rolling to all versions label Feb 17, 2025
DLu pushed a commit to DLu/ros2_documentation that referenced this pull request Feb 18, 2025
ros2#5034)

* added Publishing-Messages-Using-YAML-Files.rst and edited Intermediate.rst

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com>

* Update source/Tutorials/Intermediate.rst

Thanks for pointing it out, I didnt notice the extention beeing there

Co-authored-by: Christophe Bedard <bedard.christophe@gmail.com>
Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com>

* Update source/Tutorials/Intermediate/Publishing-Messages-Using-YAML-Files.rst

Co-authored-by: Christophe Bedard <bedard.christophe@gmail.com>
Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com>

---------

Signed-off-by: Nikos Tziaros <33639811+NickTziaros@users.noreply.github.com>
Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
Co-authored-by: Alejandro Hernández Cordero <ahcorde@gmail.com>
Co-authored-by: Christophe Bedard <bedard.christophe@gmail.com>
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.

Strategies for YAML Message Generation Using ROS CLI
4 participants