From c99ecd8e420a177969881eb104c1dc4a1393ae56 Mon Sep 17 00:00:00 2001 From: Allison Thackston <73732028+althack@users.noreply.github.com> Date: Sat, 28 Mar 2026 16:08:24 -0700 Subject: [PATCH 1/2] Add Notes to gz template --- templates/src/gz/NOTES.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 templates/src/gz/NOTES.md diff --git a/templates/src/gz/NOTES.md b/templates/src/gz/NOTES.md new file mode 100644 index 0000000..1e0d31c --- /dev/null +++ b/templates/src/gz/NOTES.md @@ -0,0 +1,12 @@ +## Additional Notes + +Use `distro` to select the Gazebo release and `imageVariant` to choose the container flavor: + +- `base`: lighter image for running and testing +- `dev`: includes extra development tooling + +The final container image tag is `-`. For example: + +- `distro=jetty` and `imageVariant=base` uses `althack/gz:jetty-base` + +This template uses host networking and host IPC so simulator and robotics tooling can communicate with local services more easily. From e601fc4b4ac2a411af50c8bc32597f89934c5613 Mon Sep 17 00:00:00 2001 From: althack <73732028+althack@users.noreply.github.com> Date: Sat, 28 Mar 2026 23:08:58 +0000 Subject: [PATCH 2/2] Update generated docs --- templates/src/gz/README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/templates/src/gz/README.md b/templates/src/gz/README.md index cf1a904..214f5d4 100644 --- a/templates/src/gz/README.md +++ b/templates/src/gz/README.md @@ -10,6 +10,18 @@ Gazebo development environment. | distro | Gazebo distribution to use. | string | jetty | | imageVariant | Container image variant to use for this Gazebo distro. | string | base | +## Additional Notes + +Use `distro` to select the Gazebo release and `imageVariant` to choose the container flavor: + +- `base`: lighter image for running and testing +- `dev`: includes extra development tooling + +The final container image tag is `-`. For example: + +- `distro=jetty` and `imageVariant=base` uses `althack/gz:jetty-base` + +This template uses host networking and host IPC so simulator and robotics tooling can communicate with local services more easily. ---