Skip to content

docs: update the convention and mention sync-params workflow#804

Open
paulsohn wants to merge 6 commits into
autowarefoundation:mainfrom
paulsohn:sohn/launch-and-params
Open

docs: update the convention and mention sync-params workflow#804
paulsohn wants to merge 6 commits into
autowarefoundation:mainfrom
paulsohn:sohn/launch-and-params

Conversation

@paulsohn

@paulsohn paulsohn commented Jun 23, 2026

Copy link
Copy Markdown

Description

This updates and clarifies the current conventions:

  • tier4_*_launch files are moved to autoware_launch, since Migrate tier4_xxx_launcher from autoware_universe into autoware_launch autoware#6774 .
  • how the reusable nodes and example integration are (at least they should be) distinguished by autoware_universe / autoware_launch boundary
  • the role differences of upstream (node) parameter files and downstream (launch) parameter files
    • the motivation why should the contributors update the node parameter files in autoware_universe, even though it is not directly used in the autoware_launch system
  • how to use sync-params workflow to automate parameter file sync, which is introduced in Add sync-params workflow autoware#7048

Plus minor grammar fixes.

Disclaimer: the current version does not mention any ongoing migrations such as autoware index, and assuming that the autoware_universe is gigantic as it is for now. Can be updated after the migration gain its momentum.

Signed-off-by: Taeseung Sohn <taeseung.sohn@tier4.jp>
@paulsohn
paulsohn requested review from mitsudome-r and xmfcx June 23, 2026 14:10
@paulsohn paulsohn added the tag:deploy-docs Mark for deploy-docs action generation. (used-by-ci) label Jun 23, 2026
@github-actions

Copy link
Copy Markdown

Thank you for contributing to the Autoware project!

🚧 If your pull request is in progress, switch it to draft mode.

Please ensure:

@technolojin technolojin left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

There are some spoken English, but those are from the original.

For the sync-params process and its policy, I used the process and worked well.
Drawbacks are

  • title is not intuitive (because of fixed template)
  • parameter update could contain multiple updates of origins(universe, core), which makes hard to cherry-pick for specific combination.
  • this sync-params process requires sequential process, so downtime occurs between the original update to this sync. manual process of merging could make almost zero downtime by merge two PRs in the same time.

Comment thread docs/contributing/coding-guidelines/ros-nodes/launch-files.md Outdated
Comment thread docs/contributing/coding-guidelines/ros-nodes/launch-files.md Outdated
Comment on lines +60 to +61
In order to automatically load the newly added package (in `autoware_core` or `autoware_universe`) when starting Autoware, you need to make some necessary changes to the corresponding launch file.
For example, if you want to use ICP instead of NDT as the pointcloud registration algorithm, you can go to `autoware_launch` repository and modify the `tier4_universe_launch/tier4_localization_launch/launch/pose_twist_estimator/pose_twist_estimator.launch.xml` file to load the newly added ICP package.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

  1. Instead of showing example and not explain detail, please describe what the modification is.
  • topology modification
  • replacement of using node
  • add a new node, with parameter file registration
  1. What "automatically" load the newly added package means?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

It seems the sentences are from the original. Is someone have any idea of this?

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Thank you for your comment. Personally, I guess we can remove the second sentence as this my proposal. Because what we want to say here is, "please fix launch file if you want to launch new package which is added to latest autoware_universe".

Signed-off-by: Taeseung Sohn <taeseung.sohn@tier4.jp>
@paulsohn
paulsohn force-pushed the sohn/launch-and-params branch from 0c43973 to cbf853f Compare June 24, 2026 02:25

@xmfcx xmfcx left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

A few editorial fixes from a close read. The first three are content defects (a truncated sentence, a fragment, and a verb that inverts an instruction's meaning); the rest are minor. Left as committable suggestions where possible.

Non-inline note: the mermaid diagram still shows pose_estimator.launch.xml (line 43) while the updated prose now uses pose_twist_estimator — worth aligning for consistency, though it's a pre-existing node outside this diff.

Comment thread docs/contributing/coding-guidelines/ros-nodes/launch-files.md Outdated
Comment thread docs/contributing/coding-guidelines/ros-nodes/launch-files.md Outdated
Comment thread docs/contributing/coding-guidelines/ros-nodes/launch-files.md Outdated
Comment thread docs/contributing/coding-guidelines/ros-nodes/parameters.md Outdated
Comment thread docs/contributing/coding-guidelines/ros-nodes/parameters.md Outdated
Comment thread docs/contributing/coding-guidelines/ros-nodes/parameters.md Outdated
Comment thread docs/contributing/coding-guidelines/ros-nodes/parameters.md Outdated
Comment thread docs/contributing/coding-guidelines/ros-nodes/parameters.md Outdated
Signed-off-by: Taeseung Sohn <taeseung.sohn@tier4.jp>
@paulsohn

Copy link
Copy Markdown
Author

@xmfcx Thanks for the review! I have updated the sentences as in 6bbf6f1 . Marking all of your comments as resolved.

Signed-off-by: Taeseung Sohn <taeseung.sohn@tier4.jp>
@paulsohn
paulsohn requested a review from xmfcx July 8, 2026 16:13
@sasakisasaki
sasakisasaki self-requested a review July 9, 2026 08:13

@sasakisasaki sasakisasaki left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Reviewed. I agree with merging this PR while put some quick win comments 👍

Comment thread docs/contributing/coding-guidelines/ros-nodes/launch-files.md Outdated
Comment thread docs/contributing/coding-guidelines/ros-nodes/launch-files.md Outdated
Comment thread docs/contributing/coding-guidelines/ros-nodes/launch-files.md Outdated
Comment thread docs/contributing/coding-guidelines/ros-nodes/launch-files.md Outdated
@sasakisasaki

Copy link
Copy Markdown

@xmfcx @mitsudome-r Could you please review this PR?

paulsohn added 2 commits July 9, 2026 18:26
Signed-off-by: Taeseung Sohn <taeseung.sohn@tier4.jp>
Signed-off-by: Taeseung Sohn <taeseung.sohn@tier4.jp>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

tag:deploy-docs Mark for deploy-docs action generation. (used-by-ci)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants