docs: add orcadev tutorial (roundtrip, bench, scenarios) to quickstart#177
Merged
Merged
Conversation
Adds a new Step 8 to hack/orca/quickstart.md walking through the
common orcadev workflows against a running dev cluster:
8a Roundtrip - one-command SHA-256 correctness check,
including a sample --dump-diff mismatch
output for triage.
8b Benchmarks - throughput + latency runs, plus the
jq-based comparison workflow using
--json-out + --label across iterations.
8c Scenarios - one-line invocations of cold-warm,
range-stress, empty-object, etag-change.
8d Cache inspection - cache-list / cache-inspect / cache-clear
for inspect-and-clear-between-experiments
workflows.
The existing 'Tear down' section becomes Step 9. dev-harness.md's
'Exercise the cache' section gets a one-line pointer to the new
step so readers landing there for benchmarking find their way to
the tutorial.
Collaborator
Author
|
GitHub auto-marked this as merged when the docs commit was fast-forwarded into |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a new tutorial Step 8 to
hack/orca/quickstart.mdwalking through the commonorcadevworkflows against a running dev cluster. The existing 'Tear down' section becomes Step 9.What's new
--dump-diffmismatch output for triage (per decision to show one failure-path example).jq-based comparison workflow using--json-out+--labelacross iterations.cold-warm,range-stress,empty-object,etag-change.cache-list/cache-inspect/cache-clearfor inspect-and-clear-between-experiments workflows.Cross-references
dev-harness.md's 'Exercise the cache' section gets a one-line pointer to the new step so readers landing there for benchmarking find their way to the tutorial.Style
Tutorial-style: step-by-step, copy-pasteable commands; minimal prose; one failure-output block for the
--dump-diffexample; referencesorcadev bench --helpfor the long tail of flags rather than enumerating them.Size
+123 / -7 lines, two files.