-
Notifications
You must be signed in to change notification settings - Fork 222
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
scenarios, rework top-level page #934
Conversation
- Use bulleted description list to list benefits - Summarize executors instead of duplicating table - Add two scenarios to example, to show it's possible - Hide full log output - shorten options slug, and fix all references Early work for #808
I don't think these edits are controversial, but I'm tagging you, @javaducky , because I did make some small assumptions about how scenarios work and their benefits, and you, @ppcano , because this a small info-architecture change, as it modifies the entrypoint to broader scenario docs. |
There's a version of the docs published here: https://mdr-ci.staging.k6.io/docs/refs/pull/934/merge It will be deleted automatically in 30 days. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good other than you have confusion between scenario-example.js
and example-scenario.js
usage. I've added replacements if you were going with scenario-example.js
since that appeared as your initial desired name (I'm fine with either name as long as it's applied consistently 😸).
src/data/markdown/translated-guides/en/02 Using k6/14 Scenarios.md
Outdated
Show resolved
Hide resolved
src/data/markdown/translated-guides/en/02 Using k6/14 Scenarios.md
Outdated
Show resolved
Hide resolved
src/data/markdown/translated-guides/en/02 Using k6/14 Scenarios.md
Outdated
Show resolved
Hide resolved
src/data/markdown/translated-guides/en/02 Using k6/14 Scenarios.md
Outdated
Show resolved
Hide resolved
src/data/markdown/translated-guides/en/02 Using k6/14 Scenarios.md
Outdated
Show resolved
Hide resolved
…s.md Co-authored-by: Paul Balogh <javaducky@gmail.com>
…s.md Co-authored-by: Paul Balogh <javaducky@gmail.com>
…s.md Co-authored-by: Paul Balogh <javaducky@gmail.com>
…s.md Co-authored-by: Paul Balogh <javaducky@gmail.com>
…s.md Co-authored-by: Paul Balogh <javaducky@gmail.com>
Thanks Paul! You have an eye for detail that I really should develop in myself 😆 . |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@MattDodsonEnglish added a suggestion and approved it.
|
||
<CodeGroup labels={["scenario example output"]} lineNumbers={[false]}> | ||
|
||
```bash |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
```bash | |
```javascript |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ppcano , just wondering, what's your preference for Javascript over bash to highlight text output? Originally, I was going to use txt
, which would have rendered the text all white, then switched to bash since it highlights the number values.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@MattDodsonEnglish sorry. This should be bash
. My suggestion was for scenario-example.js
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh that's a good catch anyway, thanks! Fixed with: bd01aed
Early work for #808