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

Categorize tutorials list #2028

Merged
merged 4 commits into from
Jul 14, 2023
Merged

Conversation

mabelzhang
Copy link
Contributor

🎉 New feature

Categorize tutorials so that it’s easier for users to find what they need. (Also fixed formatting inconsistencies as I clicked through all the tutorials.)

Previously, all the tutorials were in a big list of arbitrary order. As the number of tutorials grew, we continued to add to the list but did not index them in a digestible way.

This PR doesn’t aim for a perfect categorization. It’s just a “better” categorization than what it is now - any categorization is better than no categorization.

It can always be modified or refined again later.

Summary

I just went down the list and looked for what natural groupings there were. The way I structured the page is meant to go in a general progression from beginner, intermediate, advanced users, to developers. Aside from that, there were sets of tutorials for GUI, Blender, and very very specific tutorials for one system plugin that only some users would find useful, so I grouped them accordingly.

Open to feedback.

Test it

Preview the rendered Doxygen pages in build/gz-sim7/doxygen/html/tutorials.html

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.

Signed-off-by: Mabel Zhang <[email protected]>
Signed-off-by: Mabel Zhang <[email protected]>
@mabelzhang mabelzhang added the documentation Improvements or additions to documentation label Jul 1, 2023
@github-actions github-actions bot added the 🌱 garden Ignition Garden label Jul 1, 2023
@codecov
Copy link

codecov bot commented Jul 1, 2023

Codecov Report

Merging #2028 (40ea620) into gz-sim7 (b2c576b) will decrease coverage by 0.03%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##           gz-sim7    #2028      +/-   ##
===========================================
- Coverage    65.02%   65.00%   -0.03%     
===========================================
  Files          354      354              
  Lines        28636    28636              
===========================================
- Hits         18621    18615       -6     
- Misses       10015    10021       +6     

see 1 file with indirect coverage changes

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.

This looks really great, thanks! I have just one minor comment about a heading.

I was also talking to Chris about this and he suggested the idea of documentation having four parts: concepts, tutorials, API, and how-to guides. I've also found https://documentation.divio.com/ and https://docs-guide.readthedocs.io/en/latest/doctypes/ that more or less align with those. Maybe we can start thinking about our documentation in these terms.

tutorials.md.in Show resolved Hide resolved
Signed-off-by: Mabel Zhang <[email protected]>
@mabelzhang
Copy link
Contributor Author

mabelzhang commented Jul 13, 2023

Yeah, he told me about those 4 categories they incorporated for ROS 2 docs. We should brainstorm a bit about that...
Thanks for the links! I'll have a closer read. The video is already entertaining :D

@mabelzhang mabelzhang merged commit 59b9723 into gz-sim7 Jul 14, 2023
6 of 8 checks passed
@mabelzhang mabelzhang deleted the mabelzhang/categorize_tutorials branch July 14, 2023 01:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation 🌱 garden Ignition Garden
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants