docs: sync k6 docs with code [automated] - #2283
Draft
cursor[bot] wants to merge 4 commits into
Draft
Conversation
Co-authored-by: Heitor Tashiro Sergent <heitortsergent@gmail.com>
Co-authored-by: Heitor Tashiro Sergent <heitortsergent@gmail.com>
Co-authored-by: Heitor Tashiro Sergent <heitortsergent@gmail.com>
|
|
1 similar comment
|
|
Contributor
|
🔴 🔴 🔴 This PR introduces the following broken links: 🔴 🔴 🔴
Questions? Ask in #docs-platform. ( |
Contributor
|
💻 Deploy preview available (docs: sync k6 docs with code [automated]): |
Co-authored-by: Heitor Tashiro Sergent <heitortsergent@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Clone summary: ✅
grafana/k6cloned successfully to/tmp/k6at commit82b9d626fabe9b98279c79d2c37166f23bcd0761(k6 v2.1.0).What?
The same corrections were applied to
docs/sources/k6/next/anddocs/sources/k6/v2.1.x/. Each{next,v2.1.x}path below identifies both changed files.docs/sources/k6/{next,v2.1.x}/examples/get-started-with-k6/test-for-performance.md— The threshold abort output saidbreached; source sayscrossed. Source:internal/metrics/engine/engine.go:181-183.docs/sources/k6/{next,v2.1.x}/extensions/create/output-extensions.md— Examples used the removed--no-summaryflag; they now use--summary-mode=disabled. Source:internal/cmd/runtime_options.go:33-35.docs/sources/k6/{next,v2.1.x}/extensions/create/secret-source_extensions.md— Examples used the removed--no-summaryflag; they now use--summary-mode=disabled. Source:internal/cmd/runtime_options.go:33-35.docs/sources/k6/{next,v2.1.x}/javascript-api/jslib/k6chaijs/error-handling.md— The JSON parsing example reported character 2 instead of character 1. Source:js/modules/k6/http/response.go:29-37.docs/sources/k6/{next,v2.1.x}/reference/archive.md— The archive tree still used obsoletefiles/andscripts/prefixes and stale metadata fields. It now usesfile/andhttps/and reflects the v2.1 metadata schema. Source:lib/archive.go:47-79,lib/archive.go:270-360, andlib/options.go:232-350.docs/sources/k6/{next,v2.1.x}/reference/k6-rest-api.md— Status fields were incomplete, live VU updates were incorrectly documented, Run Setup had the wrong method, Update Setup had the wrong request envelope, andPOST /v1/teardownwas missing. Source:api/v1/status.go:9-18,api/v1/status_routes.go:25-70,api/v1/routes.go:60-80, andapi/v1/setup_teardown_routes.go:43-88.docs/sources/k6/{next,v2.1.x}/release-notes/v2.1.0.md— Removed the description of the still-experimental native-histograms capability while preserving the feature-flag system release note. Source:internal/features/features.go:42-45.docs/sources/k6/{next,v2.1.x}/results-output/end-of-test/_index.md— The page listed removedlegacyand--no-summarychoices instead ofdisabled. Source:internal/lib/summary/summary.go:15-27andinternal/cmd/runtime_options.go:33-35.docs/sources/k6/{next,v2.1.x}/results-output/end-of-test/custom-summary.md— The new summary format was incorrectly described as becoming the v2 default, the legacytextSummary()layout was called the built-in default, and the machine-readable/legacy schemas were conflated. Source:internal/cmd/runtime_options.go:41-43,internal/js/summary-wrapper.js:36-77, andinternal/lib/summary/machinereadable/types_gen.go:625-633.docs/sources/k6/{next,v2.1.x}/results-output/grafana-dashboards.md— Removed the native-histogram dashboard path because the underlying k6 behavior remains feature-gated. Source:internal/features/features.go:42-45andinternal/output/prometheusrw/remotewrite/remotewrite.go:47-51.docs/sources/k6/{next,v2.1.x}/results-output/real-time/prometheus-remote-write.md— Removed native-histogram setup, options, and dashboard guidance because the capability remains behind the experimentalnative-histogramsflag. Source:internal/features/features.go:42-45andinternal/output/prometheusrw/remotewrite/remotewrite.go:47-51.docs/sources/k6/{next,v2.1.x}/set-up/set-up-distributed-k6/troubleshooting.md— Removed a stale CSV-based--tagparsing error that no longer matches the StringArray parser. Source:internal/cmd/options.go:218-228andinternal/cmd/options.go:251-267.docs/sources/k6/{next,v2.1.x}/testing-guides/api-load-testing.md— Replaced obsoletesome thresholds have failedoutput with the current crossed-metrics message. Source:internal/cmd/run.go:357-366.docs/sources/k6/{next,v2.1.x}/testing-guides/injecting-faults-with-xk6-disruptor/examples/inject-http-faults-into-pod.md— Commands used removed--summary-mode=legacy; they now usecompact. Source:internal/lib/summary/summary.go:15-27.docs/sources/k6/{next,v2.1.x}/testing-guides/running-large-tests.md— Commands used removed--no-summary; they now use--summary-mode=disabled. Source:internal/cmd/runtime_options.go:33-35.docs/sources/k6/{next,v2.1.x}/using-k6/assertions.md— The command used removed--no-summary; it now uses--summary-mode=disabled. Source:internal/cmd/runtime_options.go:33-35.docs/sources/k6/{next,v2.1.x}/using-k6/feature-flags.md— Removed descriptions and examples for concrete still-flagged capabilities while retaining generic flag discovery and configuration guidance. Source:internal/features/features.go:42-45.docs/sources/k6/{next,v2.1.x}/using-k6/k6-options/reference.md— Replaced the concrete experimental feature example and added the missing--new-machine-readable-summaryoption, environment variable, and default. Source:internal/features/features.go:42-45andinternal/cmd/runtime_options.go:41-43,77-86,130-133.Validation:
git diff --check main...HEADmetadata.json--summary-mode=disabledin a test runnextfiles match theirv2.1.xcounterpartsmd-k6.pywas also attempted. It reached unchanged assertion examples, then stopped because the existing{{< param "JSLIB_TESTING_VERSION" >}}shortcode wasn't resolved by the standalone runner.Checklist
npm startcommand locally and verified that the changes look good.docs/sources/k6/nextfolder of the documentation.docs/sources/k6/v2.1.xfolder of the documentation.Related PR(s)/Issue(s)
Automated weekly source synchronization.