SOLR-15625 Improve documentation for the benchmark module. #406
Conversation
markrmiller
force-pushed
the
SOLR-15625
branch
from
ed3d15f to
aded469
Compare
|
This PR had no visible activity in the past 60 days, labeling it as stale. Any new activity will remove the stale label. To attract more reviewers, please tag someone or notify the dev@solr.apache.org mailing list. Thank you for your contribution! |
|
This PR is now closed due to 60 days of inactivity after being marked as stale. Re-opening this PR is still possible, in which case it will be marked as active again. |
|
This looks like a great doc improvement, and we need to make benchmarking easier to approach. @gerlowskija I know you have actually used it... If you were to LGTM this PR, I'd be happy to merge it etc. |
|
I'll take a look when I get a few moments @epugh But it's worth pinging @markrmiller to see if he might recall why this never got in - did it just fall through the cracks or was there some additional work needed? |
github-actions
bot
removed
closed-stale
|
This PR has had no activity for 60 days and is now labeled as stale. Any new activity will remove the stale label. To attract more reviewers, please tag people who might be familiar with the code area and/or notify the dev@solr.apache.org mailing list. To exempt this PR from being marked as stale, make it a draft PR or add the label "exempt-stale". If left unattended, this PR will be closed after another 60 days of inactivity. Thank you for your contribution! |
|
I might have violated etiquette, but I emailed @markrmiller directly ;-) |
solr/benchmark/README.md
Outdated
| Be aware that with this system property set, that same mini-cluster will be reused for any benchmarks run, regardless of | ||
| if that makes sense or not. | ||
| - 📒 [docs/jmh-profilers.md](docs/docs/jmh-profilers.md) | ||
| - 📒 [docs/jmh-profilers-setup.md](docs/docs/jmh-profilers-setup.md) |
There was a problem hiding this comment.
is docs/docs correct for these two links?
There was a problem hiding this comment.
It's not - I fixed the links in a recent patch.
|
|
||
| <br/> | ||
|
|
||
| We do not want **debug symbols** stripped from Java for the best experience. |
There was a problem hiding this comment.
maybe something a little more specific, like "... stripped from Java for optimal profiling accuracy and heap allocation analysis"
There was a problem hiding this comment.
Made some wording tweaks here to be more specific 👍
- Fixes a few broken section-links - Removes Lucene-centric images - Small wording tweaks - Adds lead-in blurb for the "profiling" sub-pages
|
LGTM - I made a few tiny tweaks, but otherwise this is a clear net-positive for the benchmarking docs. Thanks to:
Will merge later this morning. |
SOLR-15625 Proper documentation for the benchmark module.