Improve documentation about open vs closed #1483
Open
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.
What?
The documentation on open vs closed models needed improvement. The introduction stated:
But had no discussion whatsoever of which test aims were suited for which model.
In addition, the discussion about the drawbacks of the closed model was incorrect. It stated:
The second part of this sentence should be "latency", not "throughput". Its measuring latency that is affected by coordinated omission, as new requests wait for old ones to finish, and that waiting time is not included in the latency measurements. The closed model is actually useful for measuring throughput.
I've:
added a new section "Open vs Closed Model" to the end of this document,
moved the discussion of the drawbacks of the closed model to this new section, as it provides the necessary context and removed some duplication in the text,
fixed the wording of the drawbacks of the closed model,
added some notes about when one would prefer the closed model and when one would prefer the open model.
Checklist
Please fill in this template:
I have run theUnable to do so as the command does not work.make docs
command locally and verified that the changes look good.Select one of these and delete the others:
If updating the documentation for the next release of k6:
docs/sources/next
folder of the documentation.