diff --git a/.github/workflows/deploy-pr-preview.yml b/.github/workflows/deploy-pr-preview.yml new file mode 100644 index 0000000000..c0f3450519 --- /dev/null +++ b/.github/workflows/deploy-pr-preview.yml @@ -0,0 +1,36 @@ +name: Deploy pr preview + +on: + pull_request: + types: + - opened + - synchronize + - closed + paths: + - "docs/sources/k6/**" + +jobs: + deploy-pr-preview: + if: "!github.event.pull_request.head.repo.fork" + uses: grafana/writers-toolkit/.github/workflows/deploy-preview.yml@main + with: + branch: ${{ github.head_ref }} + event_number: ${{ github.event.number }} + repo: k6-docs + sha: ${{ github.event.pull_request.head.sha }} + sources: | + [ + { + "relative_prefix": "/docs/k6/", + "repo": "k6-docs", + "source_directory": "docs/sources/k6", + "website_directory": "content/docs/k6" + }, + { + "relative_prefix": "/docs/k6/latest", + "repo": "k6-docs", + "source_directory": "docs/sources/k6/next", + "website_directory": "content/docs/k6/latest" + } + ] + title: ${{ github.event.pull_request.title }} diff --git a/docs/sources/k6/next/get-started/resources.md b/docs/sources/k6/next/get-started/resources.md index 73bbdbb749..d28c69a457 100644 --- a/docs/sources/k6/next/get-started/resources.md +++ b/docs/sources/k6/next/get-started/resources.md @@ -27,11 +27,15 @@ These resources help you write and run k6 tests in a safe environment and explor ## Test servers -If you need a place to learn k6 and test your scripts, you can use these playground/demo applications: +If you need a place to learn k6 and test your scripts, you can use these demo applications: -- [grafana/quickpizza](https://github.com/grafana/quickpizza). A simple demo web application. +- [`grafana/quickpizza`](https://github.com/grafana/quickpizza). A demo web application. -Note that these are shared testing environments - please avoid high-load tests. Alternatively, you can deploy and host them on your infrastructure and run the examples in the repository. +{{< admonition type="note" >}} +These are testing environments shared by everyone - avoid high-load tests. + +If you want to run tests with high loads, you can deploy and host them on your infrastructure and run the examples in the repository. +{{< /admonition >}} ## k6 + your favorite tool