Learning about parameters - tutorial

[kacperbojakowski-3di]

Updated the article "Learning about parameters - tutorial".

This update is part of #6827.

Description

Related to: ros2/ros2#1725

• Title changed to "Learning about parameters - tutorial".
• Sections rewritten to reflect the new content model.
• Replaced command-named headings with task-oriented headings.
• Reworded explanations for clarity.
• Clarified expected terminal output by separating sample results into their own console blocks.
• Clarified that omitting the node name with ros2 param get works only on Lyrical, Rolling, and later.
• Added an FAQ section and related content.
• Tested on Ubuntu. The underlying procedures are unchanged.

Did you use Generative AI?

Yes, GPT-5 for the FAQ section.

Additional Information

Documentation updates from 3di Information Solutions, agreed with Geoff and Tully.

Label

Please add backport-lyrical.

[kscottz]

This is fine as is. My only concern is that if we are touching this tutorial we really should add a section that asks the user to run ros2 param --help. Most of the intro tutorials really should be showing users how they can help themselves figure out a command.

[mergify]

Tick the box to add this pull request to the merge queue (same as @mergifyio queue).

• Queue this pull request

[fujitatomoya]

lgtm with green CI.

[fujitatomoya]

@kacperbojakowski-3di thanks for the PR, all the backports to the downstream branches have some conflicts. can you resolve those?

[kacperbojakowski-3di]

Backport conflicts resolved via fresh PRs (no write access to push onto the Mergify branches):

• lyrical: Learning about parameters - tutorial (backport #7031) #7047 (replaces Learning about parameters - tutorial (backport #7031) #7038)
• kilted: Learning about parameters - tutorial (backport #7031) #7048 (replaces Learning about parameters - tutorial (backport #7031) #7039)
• jazzy: Learning about parameters - tutorial (backport #7031) #7049 (replaces Learning about parameters - tutorial (backport #7031) #7040)
• humble: Learning about parameters - tutorial (backport #7031) #7050 (replaces Learning about parameters - tutorial (backport #7031) #7041)

Each keeps only the parameters tutorial rewrite on the Tutorials/Beginner-CLI-Tools path with legacy doc links. The Rolling-only How-ROS-Works / ROS-Framework.rst additions from the cherry-pick were dropped.

[kacperbojakowski-3di]

@kacperbojakowski-3di thanks for the PR, all the backports to the downstream branches have some conflicts. can you resolve those?

Hi @fujitatomoya,

Thanks! Sorry for the noise with extra requests, but apparently I don’t have the write access to push onto Mergify branches, so instead I opened four clean replacement backports:

• lyrical: Learning about parameters - tutorial (backport #7031) #7047 (to replace Learning about parameters - tutorial (backport #7031) #7038)
• kilted: Learning about parameters - tutorial (backport #7031) #7048 (to replace Learning about parameters - tutorial (backport #7031) #7039)
• jazzy: Learning about parameters - tutorial (backport #7031) #7049 (to replace Learning about parameters - tutorial (backport #7031) #7040)
• humble: Learning about parameters - tutorial (backport #7031) #7050 (to replace Learning about parameters - tutorial (backport #7031) #7041)

You can merge those, and then the conflicted Mergify PRs can be closed. Unless I should have handled this differently, then let me know.

The big caveat here is that I have resolved these with the assumption that the structure on lyrical, kilted, jazzy and humble stays as is, but eventually the topic is going to change its position once #6998 is backported.

@dmarshant FYI, not sure how you would like to go about this.

[fujitatomoya]

@kacperbojakowski-3di thanks for creating backports.

before moving on to review indivisual backport PRs, something i want to confirm here.

i think we need to backport #6998 in lyrical (and downstream branches) in the 1st place? that said, we can avoid those conflicts during brackports. to keep the consistency and maitainability (this is exactly why the conflicts are happening), i say we need to backport #6998 to the downstream branches in the 1st. what is your plan with OSRA ROS TGC?

CC: @kscottz @gbiggs @mjcarroll @ahcorde