Welcome to the k6 docs! This repo contains the source code of the k6 documentation.
Some key facts:
Don't feel shy about contributing! All input is welcome. No fix is too trivial.
If something confuses you or feels lacking about the docs, make an issue. If you find something that you think you can fix, please go ahead. You don't need to ask permission.
Markdown files for the documentation are located in the docs/sources/
folder, with sub-folders for each k6 version. The URL structure is generated based on the folder structure and file names.
For small changes and spelling fixes, the GitHub UI is the most convenient way to contribute. For larger contributions, consider running the project locally to see how the changes look like before making a pull request.
The following docs cover the different stages of the writing workflow:
docs/sources
are automatically deployed to production once they're merged to the main branch.For more details, refer to the CONTRIBUTING section.
To build the k6 docs in your machine, you'll need:
If you're using Docker, make sure you have the Docker Desktop application running.
Clone the repository to your machine:
git clone https://github.com/grafana/k6-docs.git
Run npm start
:
npm start
You should see an output similar to this when the site finishes building:
View documentation locally:
http://localhost:3002/docs/k6/
Press Ctrl+C to stop the server
Go to http://localhost:3002/docs/k6/, and you should be able to see a preview of the docs.