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

ros_gz documentation updates #508

Merged
merged 4 commits into from
Sep 11, 2024
Merged

ros_gz documentation updates #508

merged 4 commits into from
Sep 11, 2024

Conversation

caguero
Copy link
Contributor

@caguero caguero commented Sep 11, 2024

🦟 Bug fix

Documentation updates including updated bridge parameters, links to other ros_gz tutorials and a note about the functionality only available in Rolling.

Summary

Checklist

  • Signed all commits for DCO
  • Added tests
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • Consider updating Python bindings (if the library has them)
  • codecheck passed (See contributing)
  • All tests passed (See test coverage)
  • While waiting for a review on your PR, please help review another open pull request to support the maintainers

Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining Signed-off-by messages.

…ther ros_gz tutorials and note about the functionality only available in Rolling.

Signed-off-by: Carlos Agüero <[email protected]>
Signed-off-by: Carlos Agüero <[email protected]>
Signed-off-by: Carlos Agüero <[email protected]>
@github-actions github-actions bot added the 🎵 harmonic Gazebo Harmonic label Sep 11, 2024
@@ -43,9 +43,9 @@ within this tag. Here's an example:
<gz_spawn_model
world="$(var world)"
file="$(var file)"
xml_string="$(var xml_string)"
world_string="$(var world_string)"
Copy link
Contributor

Choose a reason for hiding this comment

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

I just realized this change was merged recently, but I don't think it makes sense to call this world_string since this is being used to spawn a model. Mind changing this to model_string here and in ros_gz?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated in ab674e3 and gazebosim/ros_gz#605

Signed-off-by: Carlos Agüero <[email protected]>
Copy link
Contributor

@azeey azeey left a comment

Choose a reason for hiding this comment

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

Can you mention that some of these instructions require Rolling?

@caguero
Copy link
Contributor Author

caguero commented Sep 11, 2024

Can you mention that some of these instructions require Rolling?

I mentioned it here. https://github.com/gazebosim/docs/pull/508/files#diff-85712e72cdaaf1dc8adface4ae8ab48e71e322457abf1d334f665ddd387dbb20R29-R30

Do you think that's enough?

Copy link
Contributor

@azeey azeey left a comment

Choose a reason for hiding this comment

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

Sorry, I missed that somehow. Thanks!

Can you go ahead and make a release of ros_gz into rolling so the instructions will match what users install?

@caguero
Copy link
Contributor Author

caguero commented Sep 11, 2024

Sorry, I missed that somehow. Thanks!

Can you go ahead and make a release of ros_gz into rolling so the instructions will match what users install?

Sure, I'm about to create another PR with another Python example. We can trigger the release afterwards if that's OK.

@azeey
Copy link
Contributor

azeey commented Sep 11, 2024

Great!

@caguero caguero merged commit e8533dd into master Sep 11, 2024
5 checks passed
@caguero caguero deleted the caguero/ros_gz_updates branch September 11, 2024 19:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🎵 harmonic Gazebo Harmonic
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants