Skip to content

Doc needed: tutorial for hands-on practice #681

@MattDodsonEnglish

Description

@MattDodsonEnglish

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

  1. Planning
  2. Testing
  3. Modifying
  4. Interpreting results
  5. 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

Metadata

Metadata

Assignees

Labels

Area: Cloud ContentDocs issues about k6 CloudArea: OSS ContentImprovements or additions to community/oss documentationTech WritersIssues that a writer could help with

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions