Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Library specific tutorials are not easily discoverable #19

Closed
azeey opened this issue Feb 21, 2023 · 8 comments
Closed

Library specific tutorials are not easily discoverable #19

azeey opened this issue Feb 21, 2023 · 8 comments

Comments

@azeey
Copy link
Collaborator

azeey commented Feb 21, 2023

Currently, to get to the gz-sim tutorials, one has to expand the "Library reference" menu, select Sim, and finally select Tutorials. I propose listing each library's tutorial in https://gazebosim.org/docs/garden/tutorials so they're just one link away from where users would go to find tutorials.

@j-rivero
Copy link

j-rivero commented Mar 7, 2023

Before we start to add new tutorials, I would like to propose the reorder of the sections. See gazebosim/docs#348

@mabelzhang
Copy link
Contributor

A followup issue is that the per-library links in the https://gazebosim.org/libs page are broken. I'm not finding the source code to that page anywhere.

@mabelzhang
Copy link
Contributor

I added the tutorial links as proposed in the original description, in a PR based on Jose's PR above gazebosim/docs#349

@j-rivero
Copy link

j-rivero commented Mar 8, 2023

As a side note: we can improve the accessibility of the tutorials for the users navigating the page but we might have a serious problem with web searches #20

@mabelzhang
Copy link
Contributor

Does the page need to be deployed manually? It isn't up.

@azeey
Copy link
Collaborator Author

azeey commented Mar 11, 2023

Does the page need to be deployed manually? It isn't up.

Yes, gazebosim-backend has to be deployed manually each time we make changes to gazebosim/docs. I'll deploy it now and close this issue.

@mabelzhang
Copy link
Contributor

Thanks! Now that it's deployed, I'm seeing some of the links I added are broken 😅

The sdformat link is broken because it's slightly different... fixed in gazebosim/docs#353

The gz-cmake and gz-utils links are broken. These specific ones are broken even if accessed from the Library Reference links - the API page is accessible, but the tutorial page doesn't exist.
https://gazebosim.org/api/cmake/3
https://gazebosim.org/api/utils/2
Should we just remove these from the newly added list, as opposed to having links that don't work?

@j-rivero
Copy link

These specific ones are broken even if accessed from the Library Reference links - the API page is accessible, but the tutorial page doesn't exist.
https://gazebosim.org/api/cmake/3
https://gazebosim.org/api/utils/2
Should we just remove these from the newly added list, as opposed to having links that don't work?

As one of the maintainers of cmake3 I think that we should try to add the tutorials or fix whatever is preventing them to have the tutorials page. Not that I think that removing them is the best temporary solution but given that we need to go win a cycle of manually deployment, if fix that in the code side of the libraries and that solves the problem best seems to me like going forward if possible.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants