-
Notifications
You must be signed in to change notification settings - Fork 241
Description
The docs start off with a nice example of running k6. Users can easily copy and paste to follow along and it has them running a successfully test quickly. After that, the docs “jump up” a grade. The topics in "Using k6" more or less assume that the reader knows why they would want to implement such a feature.
It would be good to create a set of tutorials that gives reader more hands-on practice. In addition to providing follow-along steps, the tutorial could provide some more context about what end goal this feature supports.
Topics
The topics should flow together, providing some skeleton of the stages of
- Planning
- Testing
- Modifying
- Interpreting results
- Automating
## Make a test
## Add a check
## Authenticate with through request body
## Add a threshold
## Analyze results with tags
## Run k6 in your CI
The k6 workshop has loads of useful pages that are grounded in real world examples.
The test builder doc offers a pretty good list of features that could be expanded.
Structure
This should not leave room for interpretation or error. Each topic should follow this general structure.
## State Problem
And describe how you are going to fix it.
## Demonstrate the fix
Be clear, exact, and granular.
## State what was just done