Skip to content

Add performance_tuning to jetty/tutorials#683

Open
ammaarrahmed wants to merge 10 commits into
gazebosim:masterfrom
ammaarrahmed:jetty/tutorials/performancetuning
Open

Add performance_tuning to jetty/tutorials#683
ammaarrahmed wants to merge 10 commits into
gazebosim:masterfrom
ammaarrahmed:jetty/tutorials/performancetuning

Conversation

@ammaarrahmed
Copy link
Copy Markdown

@ammaarrahmed ammaarrahmed commented Apr 3, 2026

New feature

Part of #673

Summary

Add a Jetty performance tuning guide with a short set of practical tips for improving simulation performance and real-time factor.

This PR keeps the first pass small:

  • adds a new performance_tuning.md page under Jetty tutorials
  • links it from the Jetty tutorials landing page and sidebar
  • focuses on documented tuning knobs such as physics step size, sensor update rates, simpler collision / visual models, rendering settings, and GPU setup
  • links out to existing docs or external references for more specialized options instead of trying to cover everything in one page

Checklist

  • Signed all commits for DCO
  • Added a screen capture or video to the PR description that demonstrates the feature
  • 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)
  • Updated Bazel files (if adding new files). Created an issue otherwise.
  • While waiting for a review on your PR, please help review another open pull request to support the maintainers
  • Was GenAI used to generate this PR? If so, make sure to add "Generated-by" to your commits. (See this policy for more info.)

Generated-by: copilot for .md content

Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining Signed-off-by and Generated-by messages.

Backports: If this is a backport, please use Rebase and Merge instead.

@ammaarrahmed
add performance_tuning to jetty/tutorials
09a41ff 
Signed-off-by: Ammaar Ahmed <ammaarlatif53@gmail.com>
Copilot AI review requested due to automatic review settings April 3, 2026 04:28
@ammaarrahmed ammaarrahmed requested a review from azeey as a code owner April 3, 2026 04:28
Copilot AI reviewed Apr 3, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new Jetty documentation page that guides users through practical steps to improve simulation performance / real-time factor, and exposes it through the tutorials landing page and sidebar.

Changes:

  • Added a new jetty/performance_tuning.md performance tuning guide.
  • Linked the new guide from jetty/tutorials.md.
  • Registered the new page in the Jetty docs sidebar via jetty/index.yaml.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File Description
jetty/tutorials.md Adds a “Performance tuning” entry under Basics tutorials.
jetty/performance_tuning.md New tutorial page describing measurement and common tuning knobs, plus links to advanced/external options.
jetty/index.yaml Adds the new page to the tutorials section so it appears in the docs sidebar.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread jetty/performance_tuning.md Outdated
Comment thread jetty/performance_tuning.md Outdated
Comment thread jetty/tutorials.md Outdated
ammaarrahmed and others added 3 commits April 3, 2026 05:36
@ammaarrahmed
Update jetty/performance_tuning.md
4cc73f7 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Ammaar Ahmed <ammaarlatif53@gmail.com>
@ammaarrahmed
Update jetty/tutorials.md
6666b20 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Ammaar Ahmed <ammaarlatif53@gmail.com>
@ammaarrahmed
Update jetty/performance_tuning.md
a267372 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Ammaar Ahmed <ammaarlatif53@gmail.com>
@ammaarrahmed
Copy link
Copy Markdown
Author

ammaarrahmed commented Apr 16, 2026

Hey @azeey , sorry to nudge , I would really appreciate some feedback on this PR and what could I further do to get this merged , please let me know, thanks.

peci1
peci1 suggested changes Apr 28, 2026
View reviewed changes
Comment thread jetty/performance_tuning.md Outdated
Comment thread jetty/performance_tuning.md Outdated
Comment thread jetty/performance_tuning.md Outdated
Comment thread jetty/performance_tuning.md Outdated
Comment thread jetty/performance_tuning.md Outdated
Comment thread jetty/performance_tuning.md
Comment thread jetty/performance_tuning.md
Comment thread jetty/performance_tuning.md Outdated
Comment thread jetty/performance_tuning.md
@github-project-automation github-project-automation Bot moved this from Inbox to In review in Core development Apr 28, 2026
@caguero
Copy link
Copy Markdown
Contributor

caguero commented May 7, 2026

@ammaarrahmed, there are some conflicts in your PR and some pending feedback, friendly ping.

ammaarrahmed and others added 2 commits May 8, 2026 08:09
@ammaarrahmed @peci1
Update jetty/performance_tuning.md
55a7fef 
Co-authored-by: Martin Pecka <peci1@seznam.cz>
Signed-off-by: Ammaar Ahmed <ammaarlatif53@gmail.com>
@ammaarrahmed @peci1
Update jetty/performance_tuning.md
4d1b450 
Co-authored-by: Martin Pecka <peci1@seznam.cz>
Signed-off-by: Ammaar Ahmed <ammaarlatif53@gmail.com>
@ammaarrahmed
Copy link
Copy Markdown
Author

ammaarrahmed commented May 8, 2026

hey @caguero thanks for the friendly ping, and sorry for the quiet period. I was tied up with GSoC community bonding and exams, but I’m back on this now. I’ve already committed two of Martin’s suggestions and I’m working through the remaining feedback plus the conflicts from the recent docs navigation rework. I’ll push the updated branch shortly.

@ammaarrahmed
Addressed Performance tuning review feedback
457f83a 
Signed-off-by: Ammaar Ahmed <ammaarlatif53@gmail.com>
@ammaarrahmed
Merge remote-tracking branch 'origin/jetty/tutorials/performancetunin…
c8de809 
…g' into jetty/tutorials/performancetuning

Signed-off-by: Ammaar Ahmed <ammaarlatif53@gmail.com>
@ammaarrahmed
Remove conflict markers from performance tuning guide
a9ebaeb 
Signed-off-by: Ammaar Ahmed <ammaarlatif53@gmail.com>
@ammaarrahmed
Copy link
Copy Markdown
Author

ammaarrahmed commented May 8, 2026

hey @caguero thanks for the ping. I’ve resolved the navigation conflict and addressed the remaining review feedback. Sorry for the delay, ready for another look when you have time. Thanks again.

@ammaarrahmed ammaarrahmed requested a review from peci1 May 8, 2026 08:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@azeey azeey Awaiting requested review from azeey azeey is a code owner

@peci1 peci1 Awaiting requested review from peci1

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

🪵 jetty

Projects

Core development
Status: In review

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@ammaarrahmed @caguero @peci1 @azeey