I only fixed Harmonic, to avoid too many files flying around. Once people are happy with the changes, I'll copy the changes to Garden and Fortress in one go.
Summary
I noticed that the ROS tutorials were only in the left menu bar, and not on the actual tutorials page.
The order of tutorials in the left menu bar was also in reverse of what's on the page, which can be confusing.
Some of the longer titles didn't look good in the menu. Two of the ROS tutorials had very similar titles, "ROS 2 integration" and "ROS 2 and Gazebo Integration Tutorial," which are basically saying the same thing and is confusing to the reader what the difference is. The first tutorial seems to be about the ros_gz_bridge, the second one about all the other interoperability stuff. So I renamed the latter "ROS 2 interoperability."
Some of the links were broken. (I wasn't able to preview the docs page locally when we added those tutorials. So I didn't catch them back then.)
This PR tidies things up a bit.
Before:
After:
To test
Use docker_dev branch of frontend and backend repos.
Put this docs repo in the root directory of gazebosim-web-backend.
Change the ~/ws/gz-docs line in frontend/docker-compose.yml to point to the absolute path of your docs repo.
Build the frontend docker image
cd path/to/gazeobsim-web-frontend
docker build . -t gazebosim_web_frontend
Build the backend docker image
cd path/to/gazebosim-web-backend
docker build . -t gazebosim_web_backend
Go to the frontend directory
cd path/to/gazeobsim-web-frontend
docker-compose up
Checklist
[x] Signed all commits for DCO
[ ] Added tests
[x] Updated documentation (as needed)
[ ] Updated migration guide (as needed)
[ ] Consider updating Python bindings (if the library has them)
[ ] 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.
🦟 Bug fix
Tidy up tutorial menu. Fix links.
I only fixed Harmonic, to avoid too many files flying around. Once people are happy with the changes, I'll copy the changes to Garden and Fortress in one go.
Summary
I noticed that the ROS tutorials were only in the left menu bar, and not on the actual tutorials page. The order of tutorials in the left menu bar was also in reverse of what's on the page, which can be confusing.
Some of the longer titles didn't look good in the menu. Two of the ROS tutorials had very similar titles, "ROS 2 integration" and "ROS 2 and Gazebo Integration Tutorial," which are basically saying the same thing and is confusing to the reader what the difference is. The first tutorial seems to be about the ros_gz_bridge, the second one about all the other interoperability stuff. So I renamed the latter "ROS 2 interoperability."
Some of the links were broken. (I wasn't able to preview the docs page locally when we added those tutorials. So I didn't catch them back then.)
This PR tidies things up a bit.
Before:![Screenshot from 2023-09-28 20-17-24_before](https://github.com/gazebosim/docs/assets/7608908/1206cb11-1938-4e91-abb2-1e49c19345ce)
After:![Screenshot from 2023-09-28 20-50-00_after](https://github.com/gazebosim/docs/assets/7608908/22d071f4-c93a-4609-ab4f-4b6027e04d1a)
To test
Use
docker_dev
branch of frontend and backend repos. Put thisdocs
repo in the root directory of gazebosim-web-backend. Change the~/ws/gz-docs
line infrontend/docker-compose.yml
to point to the absolute path of yourdocs
repo.Build the frontend docker image
Build the backend docker image
Go to the frontend directory
Checklist
codecheck
passed (See contributing)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.