-
Notifications
You must be signed in to change notification settings - Fork 277
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
Add tutorial for using components in systems #2207
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## gz-sim8 #2207 +/- ##
===========================================
- Coverage 65.63% 65.61% -0.02%
===========================================
Files 324 324
Lines 30925 30924 -1
===========================================
- Hits 20298 20292 -6
- Misses 10627 10632 +5 ☔ View full report in Codecov by Sentry. |
DCO was complaining because the 4 automatic signoffs via GitHub web UI used gmails. I just set it to pass since we'll squash before merging anyway. Ready for another look. |
Signed-off-by: Addisu Z. Taddese <[email protected]> Signed-off-by: Mabel Zhang <[email protected]>
Signed-off-by: Addisu Z. Taddese <[email protected]> Signed-off-by: Mabel Zhang <[email protected]>
* Remove ci-focal Signed-off-by: Addisu Z. Taddese <[email protected]> Signed-off-by: Mabel Zhang <[email protected]>
--------- Signed-off-by: Ian Chen <[email protected]> Signed-off-by: Mabel Zhang <[email protected]>
Signed-off-by: Mabel Zhang <[email protected]>
Signed-off-by: Mabel Zhang <[email protected]>
Co-authored-by: Alejandro Hernández Cordero <[email protected]> Signed-off-by: Mabel Zhang <[email protected]> Signed-off-by: Mabel Zhang <[email protected]>
Co-authored-by: Alejandro Hernández Cordero <[email protected]> Signed-off-by: Mabel Zhang <[email protected]> Signed-off-by: Mabel Zhang <[email protected]>
Co-authored-by: Alejandro Hernández Cordero <[email protected]> Signed-off-by: Mabel Zhang <[email protected]> Signed-off-by: Mabel Zhang <[email protected]>
Co-authored-by: Alejandro Hernández Cordero <[email protected]> Signed-off-by: Mabel Zhang <[email protected]> Signed-off-by: Mabel Zhang <[email protected]>
Signed-off-by: Mabel Zhang <[email protected]>
Signed-off-by: Mabel Zhang <[email protected]>
Signed-off-by: Addisu Z. Taddese <[email protected]> Signed-off-by: Mabel Zhang <[email protected]>
Signed-off-by: Mabel Zhang <[email protected]>
2e8d6ea
to
299cf20
Compare
DCO complained again, so I fixed it for real. |
Signed-off-by: Mabel Zhang <[email protected]>
Signed-off-by: Mabel Zhang <[email protected]>
Signed-off-by: Mabel Zhang <[email protected]>
🎉 New feature
Practices:
\ref
links or relative links, except for links going to GitHub source code.Summary
This PR adds two pages.
Parent page is an overview of using components in systems. It has a high-level overview of what people need to know, linking to prerequisites and resources. It then talks about the ECM object in practical terms as the gateway to access entities and components.
It then links to a list of case studies, of which there is just 1 item right now, for
JointForceCmd
component (child page). The assumption is that we will be adding more case studies to this list for other components.The child page uses the simplest built-in system plugin
ApplyJointForce
to explain how to use theJointForceCmd
component through the ECM, by finding the Joint and then modifying the component.Test it
Navigate browser to
build/gz-sim8/doxygen/html/usingcomponents.html
(parent page) andbuild/gz-sim8/doxygen/html/jointforcecmdcomponent.html
(child page).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.