Added documentation for usage of setup-gazebo

[sauk2]

🎉 New feature

Closes #529

Summary

Added a new section with information on setup-gazebo, followed by subsections on how to use it on each of the three supported platforms.

Checklist

• Signed all commits for DCO
• Added tests
• Added example and/or tutorial
• 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.

[azeey]

Awesome! Thanks for adding this documentation. I only have one small comment.

[azeey]

Garden is pretty much EOL now, so it can be removed.

[sauk2]

Thanks for pointing it out.

However, currently, the action reads from the collections file - https://github.com/gazebo-tooling/release-tools/blob/8483b5c73e47aa1e098f7dbbee29a7b3fc0ae3b8/jenkins-scripts/dsl/gz-collections.yaml#L190

So it will still support the installation of Garden as long as it is in that file. Would you still like me to remove it?

[j-rivero]

I think that we can remove it yes. I will remove it from collections as soon as the release is EOL.

[sauk2]

Thanks for the clarification. I have removed the mention of Garden.

[j-rivero]

Thanks @sauk2 for the PR. I think that there is a good part of the content directly copied from the README.md in the setup-gazebo repository. I'm worried about the amount of maintenance work that this can cause when we update/change the setup-gazebo README. I would be more inclined to create a single document where we point the users to read the README file in github or the Marketplace instructions (the same text) of the setup-gazebo instead of recreating the content here. We can have a nice introduction about CI like the one we have now.

[sauk2]

Thanks @sauk2 for the PR. I think that there is a good part of the content directly copied from the README.md in the setup-gazebo repository. I'm worried about the amount of maintenance work that this can cause when we update/change the setup-gazebo README. I would be more inclined to create a single document where we point the users to read the README file in github or the Marketplace instructions (the same text) of the setup-gazebo instead of recreating the content here. We can have a nice introduction about CI like the one we have now.

Thanks for the feedback! This makes a lot of sense. I have updated instructions to direct users to the Marketplace page.

[j-rivero]

yay !! I really like it. Good to go if @azeey is fine with it. Thanks so much @sauk2 !!