{"id":13941290,"url":"https://github.com/grafana/k6-docs","last_synced_at":"2025-05-15T23:08:56.869Z","repository":{"id":37092214,"uuid":"256490317","full_name":"grafana/k6-docs","owner":"grafana","description":"The k6 documentation website.","archived":false,"fork":false,"pushed_at":"2025-05-12T07:24:10.000Z","size":81405,"stargazers_count":95,"open_issues_count":217,"forks_count":231,"subscribers_count":149,"default_branch":"main","last_synced_at":"2025-05-12T07:38:25.156Z","etag":null,"topics":["devops","docs","hacktoberfest","k6","performance-testing","reliability-engineering"],"latest_commit_sha":null,"homepage":"https://grafana.com/docs/k6/latest/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/grafana.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING/README.md","funding":null,"license":null,"code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-04-17T11:58:42.000Z","updated_at":"2025-05-08T18:06:37.000Z","dependencies_parsed_at":"2024-04-16T21:27:46.123Z","dependency_job_id":"76ecff50-2818-45b4-a604-44c4ecdff6b1","html_url":"https://github.com/grafana/k6-docs","commit_stats":{"total_commits":3446,"total_committers":220,"mean_commits":"15.663636363636364","dds":0.8421358096343587,"last_synced_commit":"23ec317fde9dffb8e89e71510a03165282847cf7"},"previous_names":[],"tags_count":565,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grafana%2Fk6-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grafana%2Fk6-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grafana%2Fk6-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grafana%2Fk6-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/grafana","download_url":"https://codeload.github.com/grafana/k6-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254436949,"owners_count":22070947,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["devops","docs","hacktoberfest","k6","performance-testing","reliability-engineering"],"created_at":"2024-08-08T02:01:15.730Z","updated_at":"2025-05-15T23:08:51.843Z","avatar_url":"https://github.com/grafana.png","language":"Python","readme":"# k6 Documentation\n\n![Staging](https://github.com/grafana/k6-docs/workflows/Staging/badge.svg)\n![Production](https://github.com/grafana/k6-docs/workflows/Production/badge.svg)\n\nWelcome to the k6 docs!\nThis repo contains the source code of the [k6 documentation](https://grafana.com/docs/k6/).\n\nSome key facts:\n\n- Issues and contributions are **always welcome**!\n- The docs are written in Markdown and built with Hugo.\n- The [Contributor's guide](./CONTRIBUTING) has meta-documentation about building locally, using special components and styling, deploying, troubleshooting, and more.\n- We have a [Code of conduct](https://github.com/grafana/k6-docs/blob/main/CODE_OF_CONDUCT.md).\n- We follow the Grafana Style Guide, and you can find more information about it in the [Writers' Toolkit](https://grafana.com/docs/writers-toolkit/).\n\n## Contributing\n\nDon't feel shy about contributing! All input is welcome. No fix is too trivial.\n\nIf something confuses you or feels lacking about the docs, make an issue.\nIf you find something that you think you can fix, please go ahead. You don't need to ask permission.\n\nMarkdown files for the documentation are located in the [`docs/sources/`](docs/sources) folder, with sub-folders for each k6 version. The URL structure is generated based on the folder structure and file names.\n\nFor small changes and spelling fixes, the GitHub UI is the most convenient way to contribute.\nFor larger contributions, consider running the project locally to see how the changes look like before making a pull request.\n\nThe following docs cover the different stages of the writing workflow:\n\n- [Local development](#local-development). For any large changes, being able to see a preview of the site can help make sure things are rendered correctly, and spot any issues before they're deployed to production.\n- [Writers' Toolkit](https://grafana.com/docs/writers-toolkit/). Learn more about the Grafana writing style guide, front matter properties, how to upload and add images, and much more.\n- [Preview and deploy](./CONTRIBUTING#deploy). Changes made to the files inside of `docs/sources` are automatically deployed to production once they're merged to the main branch.\n\nFor more details, refer to the [CONTRIBUTING](./CONTRIBUTING/README.md) section.\n\n## Local development\n\n### Before you begin\n\nTo build the k6 docs in your machine, you'll need:\n\n- [Docker](https://docs.docker.com/engine/install/) or [Podman](https://podman.io/docs/installation)\n\nIf you're using Docker, make sure you have the Docker Desktop application running.\n\n### Build and preview\n\nClone the repository to your machine:\n\n```bash\ngit clone https://github.com/grafana/k6-docs.git\n```\n\nRun `npm start`:\n\n```bash\nnpm start\n```\n\nYou should see an output similar to this when the site finishes building:\n\n```bash\nView documentation locally:\n                             http://localhost:3002/docs/k6/\n\n                                                           Press Ctrl+C to stop the server\n```\n\nGo to http://localhost:3002/docs/k6/, and you should be able to see a preview of the docs.\n","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrafana%2Fk6-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgrafana%2Fk6-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrafana%2Fk6-docs/lists"}