-
Notifications
You must be signed in to change notification settings - Fork 222
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Publish documentation to grafana.com website #1386
Conversation
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit
doc-validator
docs/sources/v0.47.x/misc/glossary.md|34 col 3| The anchor 'load-test' does not exist in the file 'docs/sources/v0.47.x/misc/glossary.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "glossary"
docs/sources/v0.47.x/misc/glossary.md|35 col 3| The anchor 'load-zone' does not exist in the file 'docs/sources/v0.47.x/misc/glossary.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "glossary"
docs/sources/v0.47.x/misc/glossary.md|36 col 3| The anchor 'lifecycle-function' does not exist in the file 'docs/sources/v0.47.x/misc/glossary.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "glossary"
docs/sources/v0.47.x/misc/glossary.md|37 col 3| The anchor 'metric' does not exist in the file 'docs/sources/v0.47.x/misc/glossary.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "glossary"
docs/sources/v0.47.x/misc/glossary.md|38 col 3| The anchor 'metric-sample' does not exist in the file 'docs/sources/v0.47.x/misc/glossary.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "glossary"
docs/sources/v0.47.x/misc/glossary.md|39 col 3| The anchor 'operator-pattern' does not exist in the file 'docs/sources/v0.47.x/misc/glossary.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "glossary"
docs/sources/v0.47.x/misc/glossary.md|40 col 3| The anchor 'parallelism' does not exist in the file 'docs/sources/v0.47.x/misc/glossary.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "glossary"
docs/sources/v0.47.x/misc/glossary.md|41 col 3| The anchor 'reliability' does not exist in the file 'docs/sources/v0.47.x/misc/glossary.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "glossary"
docs/sources/v0.47.x/misc/glossary.md|42 col 3| The anchor 'requests-per-second' does not exist in the file 'docs/sources/v0.47.x/misc/glossary.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "glossary"
docs/sources/v0.47.x/misc/glossary.md|43 col 3| The anchor 'saturation' does not exist in the file 'docs/sources/v0.47.x/misc/glossary.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "glossary"
docs/sources/v0.47.x/misc/glossary.md|44 col 3| The anchor 'scenario' does not exist in the file 'docs/sources/v0.47.x/misc/glossary.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "glossary"
docs/sources/v0.47.x/misc/glossary.md|45 col 3| The anchor 'scenario-executor' does not exist in the file 'docs/sources/v0.47.x/misc/glossary.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "glossary"
docs/sources/v0.47.x/misc/glossary.md|46 col 3| The anchor 'smoke-test' does not exist in the file 'docs/sources/v0.47.x/misc/glossary.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "glossary"
docs/sources/v0.47.x/misc/glossary.md|47 col 3| The anchor 'soak-test' does not exist in the file 'docs/sources/v0.47.x/misc/glossary.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "glossary"
docs/sources/v0.47.x/misc/glossary.md|48 col 3| The anchor 'stability' does not exist in the file 'docs/sources/v0.47.x/misc/glossary.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "glossary"
docs/sources/v0.47.x/misc/glossary.md|49 col 3| The anchor 'stress-test' does not exist in the file 'docs/sources/v0.47.x/misc/glossary.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "glossary"
docs/sources/v0.47.x/misc/glossary.md|50 col 3| The anchor 'system-under-test' does not exist in the file 'docs/sources/v0.47.x/misc/glossary.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "glossary"
docs/sources/v0.47.x/misc/glossary.md|51 col 3| The anchor 'test-run' does not exist in the file 'docs/sources/v0.47.x/misc/glossary.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "glossary"
docs/sources/v0.47.x/misc/glossary.md|52 col 3| The anchor 'test-concurrency' does not exist in the file 'docs/sources/v0.47.x/misc/glossary.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "glossary"
docs/sources/v0.47.x/misc/glossary.md|53 col 3| The anchor 'test-duration' does not exist in the file 'docs/sources/v0.47.x/misc/glossary.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "glossary"
docs/sources/v0.47.x/misc/glossary.md|54 col 3| The anchor 'test-script' does not exist in the file 'docs/sources/v0.47.x/misc/glossary.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "glossary"
docs/sources/v0.47.x/misc/glossary.md|55 col 3| The anchor 'threshold' does not exist in the file 'docs/sources/v0.47.x/misc/glossary.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "glossary"
docs/sources/v0.47.x/misc/glossary.md|56 col 3| The anchor 'throughput' does not exist in the file 'docs/sources/v0.47.x/misc/glossary.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "glossary"
docs/sources/v0.47.x/misc/glossary.md|57 col 3| The anchor 'virtual-user' does not exist in the file 'docs/sources/v0.47.x/misc/glossary.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "glossary"
docs/sources/v0.47.x/misc/glossary.md|58 col 3| The anchor 'yaml' does not exist in the file 'docs/sources/v0.47.x/misc/glossary.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "glossary"
docs/sources/v0.47.x/misc/glossary.md|74 col 23| The anchor 'kubernetes' does not exist in the file 'docs/sources/v0.47.x/misc/glossary.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "glossary"
docs/sources/v0.47.x/misc/glossary.md|77 col 25| The anchor 'dynamic-data' does not exist in the file 'docs/sources/v0.47.x/misc/glossary.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "glossary"
docs/sources/v0.47.x/misc/glossary.md|86 col 17| The anchor 'soak-test' does not exist in the file 'docs/sources/v0.47.x/misc/glossary.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "glossary"
docs/sources/v0.47.x/misc/glossary.md|92 col 53| The anchor 'test-run' does not exist in the file 'docs/sources/v0.47.x/misc/glossary.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "glossary"
docs/sources/v0.47.x/misc/glossary.md|137 col 11| The anchor 'kubernetes' does not exist in the file 'docs/sources/v0.47.x/misc/glossary.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "glossary"
docs/sources/v0.47.x/misc/glossary.md|137 col 69| The anchor 'custom-resource' does not exist in the file 'docs/sources/v0.47.x/misc/glossary.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "glossary"
docs/sources/v0.47.x/misc/glossary.md|155 col 20| The anchor 'scenario' does not exist in the file 'docs/sources/v0.47.x/misc/glossary.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "glossary"
docs/sources/v0.47.x/misc/integrations.md|6 col 3| The first heading 'Integrations & Tools' does not match the title 'Integrations'.
Decide which of the first heading or title is most applicable and change the other to match, or update them both to a new title.
docs/sources/v0.47.x/results-output/real-time/prometheus-remote-write.md|34 col 13| The anchor 'counter-and-gauges' does not exist in the file 'docs/sources/v0.47.x/results-output/real-time/prometheus-remote-write.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "prometheus-remote-write, metrics-mapping, trend-metric-conversions, 1-counter-and-gauges, 2-prometheus-native-histogram, send-test-metrics-to-a-remote-write-endpoint, options, stale-trend-metrics, time-series-visualization, docker-compose-example"
docs/sources/v0.47.x/results-output/real-time/prometheus-remote-write.md|34 col 68| The anchor 'prometheus-native-histogram' does not exist in the file 'docs/sources/v0.47.x/results-output/real-time/prometheus-remote-write.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "prometheus-remote-write, metrics-mapping, trend-metric-conversions, 1-counter-and-gauges, 2-prometheus-native-histogram, send-test-metrics-to-a-remote-write-endpoint, options, stale-trend-metrics, time-series-visualization, docker-compose-example"
docs/sources/v0.47.x/results-output/real-time/prometheus-remote-write.md|40 col 4| The anchor 'counter-and-gauges' does not exist in the file 'docs/sources/v0.47.x/results-output/real-time/prometheus-remote-write.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "prometheus-remote-write, metrics-mapping, trend-metric-conversions, 1-counter-and-gauges, 2-prometheus-native-histogram, send-test-metrics-to-a-remote-write-endpoint, options, stale-trend-metrics, time-series-visualization, docker-compose-example"
docs/sources/v0.47.x/results-output/real-time/prometheus-remote-write.md|41 col 4| The anchor 'prometheus-native-histogram' does not exist in the file 'docs/sources/v0.47.x/results-output/real-time/prometheus-remote-write.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "prometheus-remote-write, metrics-mapping, trend-metric-conversions, 1-counter-and-gauges, 2-prometheus-native-histogram, send-test-metrics-to-a-remote-write-endpoint, options, stale-trend-metrics, time-series-visualization, docker-compose-example"
docs/sources/v0.47.x/results-output/real-time/prometheus-remote-write.md|162 col 136| The anchor 'prometheus-native-histogram' does not exist in the file 'docs/sources/v0.47.x/results-output/real-time/prometheus-remote-write.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "prometheus-remote-write, metrics-mapping, trend-metric-conversions, 1-counter-and-gauges, 2-prometheus-native-histogram, send-test-metrics-to-a-remote-write-endpoint, options, stale-trend-metrics, time-series-visualization, docker-compose-example"
docs/sources/v0.47.x/testing-guides/injecting-faults-with-xk6-disruptor/_index.md|49 col 12| The relref
shortcode argument '{{< relref "docs/k6/latest/testing-guides/injecting-faults-with-xk6-disruptor/examples/" >}}' has a trailing slash, which can break the resolution.
You can reference an index.md
file either by its path or by its containing folder without the ending /
.
You can reference an _index.md
file only by its containing folder.
Remove the trailing slash to make sure that changing the index type doesn't break the link.
docs/sources/v0.47.x/testing-guides/injecting-faults-with-xk6-disruptor/examples/_index.md|7 col 3| The first heading 'xk6-disruptor examples' does not match the title 'Examples'.
Decide which of the first heading or title is most applicable and change the other to match, or update them both to a new title.
docs/sources/v0.47.x/testing-guides/injecting-faults-with-xk6-disruptor/examples/inject-grpc-faults-into-service.md|21 col 85| The link to the project page ' relref "/docs/k6/latest/javascript-api/xk6-disruptor/servicedisruptor" ' is invalid.
Links to project pages must use a Hugo relref
shortcode like {{< relref "./path/to/page" >}}
.
Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md
.
docs/sources/v0.47.x/testing-guides/injecting-faults-with-xk6-disruptor/examples/inject-grpc-faults-into-service.md|21 col 287| The link to the project page ' relref "/docs/k6/latest/javascript-api/k6-net-grpc/" ' is invalid.
Links to project pages must use a Hugo relref
shortcode like {{< relref "./path/to/page" >}}
.
Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md
.
docs/sources/v0.47.x/testing-guides/injecting-faults-with-xk6-disruptor/examples/inject-grpc-faults-into-service.md|21 col 418| The link to the project page ' relref "/docs/k6/latest/using-k6/checks/" ' is invalid.
Links to project pages must use a Hugo relref
shortcode like {{< relref "./path/to/page" >}}
.
Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md
.
docs/sources/v0.47.x/testing-guides/injecting-faults-with-xk6-disruptor/examples/inject-grpc-faults-into-service.md|94 col 23| The link to the project page ' relref "/docs/k6/latest/using-k6/scenarios/" ' is invalid.
Links to project pages must use a Hugo relref
shortcode like {{< relref "./path/to/page" >}}
.
Links to project assets must be made from a bundle (index.md or _index.md file).
The asset must be contained within the bundle directory, it must have an extension, and must not have the extension .md
.
docs/sources/v0.47.x/testing-guides/injecting-faults-with-xk6-disruptor/first-steps.md|7 col 3| The first heading 'xk6-disruptor first steps' does not match the title 'First steps'.
Decide which of the first heading or title is most applicable and change the other to match, or update them both to a new title.
docs/sources/v0.47.x/testing-guides/running-distributed-tests.md|202 col 8| The anchor 'install-the-operator' does not exist in the file 'docs/sources/v0.47.x/testing-guides/running-distributed-tests.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "running-distributed-tests, introducing-k6-operator, get-started-with-k6-operator, 1-install-the-operator, 2-create-a-test-script, 3-add-test-scripts, add-as-a-configmap, add-inside-a-persistentvolume, 4-create-a-custom-resource, script-in-a-configmap, script-in-a-persistentvolume, configure-the-environment, change-command-line-arguments, 5-run-your-test, 6-when-things-go-wrong, see-also"
docs/sources/v0.47.x/testing-guides/running-large-tests.md|103 col 165| The anchor 'memory' does not exist in the file 'docs/sources/v0.47.x/testing-guides/running-large-tests.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "running-large-tests, os-fine-tuning, hardware-considerations, monitoring-the-load-generator, monitoring-guidelines, error-handling-should-be-resilient, k6-options-to-reduce-resource-use, save-memory-with-discardresponsebodies, when-streaming-use---no-thresholds-and---no-summary, script-optimizations, limit-resource-intensive-k6-operations, javascript-optimizations, file-upload-considerations, common-errors, read-connection-reset-by-peer, context-deadline-exceeded, dial-tcp-52182422280-io-timeout, socket-too-many-open-files, benchmarking-k6, distributed-execution, large-scale-tests-in-the-cloud, read-more"
docs/sources/v0.47.x/using-k6/k6-options/how-to.md|49 col 95| The anchor 'order-of-precedence' does not exist in the file 'docs/sources/v0.47.x/using-k6/k6-options/how-to.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "how-to-use-options, order-of-precedence-order-of-precedence, where-to-set-options, examples-of-setting-options, set-options-in-the-script, set-options-with-environment-variables, set-options-from-k6-variables, set-options-with-the---config-flag, get-an-option-value-from-the-script"
docs/sources/v0.47.x/using-k6/k6-options/reference.md|1476 col 120| The anchor 'options' does not exist in the file 'docs/sources/v0.47.x/using-k6/k6-options/reference.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "options-reference, quick-reference-of-options, address, batch, batch-per-host, blacklist-ip, block-hostnames, compatibility-mode, config, console-output, discard-response-bodies, dns, duration, extension-options, execution-segment, exit-on-running, hosts, http-debug, include-system-env-vars, insecure-skip-tls-verify, iterations, linger, local-ips, log-output, loki, file, logformat, max-redirects, minimum-iteration-duration, no-color, no-connection-reuse, no-cookies-reset, no-summary, no-setup, no-teardown, no-thresholds, no-usage-report, no-vu-connection-reuse, paused, quiet, results-output, rps, considerations-when-running-in-the-cloud, scenarios, setup-timeout, show-logs, stages, summary-export, supply-environment-variables, system-tags, summary-time-unit, summary-trend-stats, tags, teardown-timeout, thresholds, throw, tls-auth, tls-cipher-suites, tls-version, upload-only, user-agent, verbose, vus"
docs/sources/v0.47.x/using-k6/modules.md|17 col 3| The anchor 'remote-http-s-modules' does not exist in the file 'docs/sources/v0.47.x/using-k6/modules.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "modules, importing-modules, built-in-modules, local-filesystem-modules, remote-https-modules, the-jslib-repository, bundling-node-modules, setting-up-the-bundler, running-the-bundling, running-the-tests, using-local-modules-with-docker, read-more"
docs/sources/v0.47.x/using-k6/modules.md|87 col 7| The anchor 'installing-packages' does not exist in the file 'docs/sources/v0.47.x/using-k6/modules.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "modules, importing-modules, built-in-modules, local-filesystem-modules, remote-https-modules, the-jslib-repository, bundling-node-modules, setting-up-the-bundler, running-the-bundling, running-the-tests, using-local-modules-with-docker, read-more"
docs/sources/v0.47.x/using-k6/modules.md|88 col 7| The anchor 'configuring-webpack' does not exist in the file 'docs/sources/v0.47.x/using-k6/modules.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "modules, importing-modules, built-in-modules, local-filesystem-modules, remote-https-modules, the-jslib-repository, bundling-node-modules, setting-up-the-bundler, running-the-bundling, running-the-tests, using-local-modules-with-docker, read-more"
docs/sources/v0.47.x/using-k6/modules.md|89 col 7| The anchor 'adding-a-bundle-command' does not exist in the file 'docs/sources/v0.47.x/using-k6/modules.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "modules, importing-modules, built-in-modules, local-filesystem-modules, remote-https-modules, the-jslib-repository, bundling-node-modules, setting-up-the-bundler, running-the-bundling, running-the-tests, using-local-modules-with-docker, read-more"
docs/sources/v0.47.x/using-k6/thresholds.md|93 col 81| The anchor 'abort' does not exist in the file 'docs/sources/v0.47.x/using-k6/thresholds.md'.
Replace the anchor with one of the available anchors.
Available anchors are: "thresholds, thresholds-example-for-http-errors-and-response-duration, threshold-syntax, threshold-expression-syntax, aggregation-methods-by-type, threshold-examples-to-copy-and-paste, a-percentile-of-requests-finishes-in-a-specified-duration, error-rate-is-lower-than-1-percent, multiple-thresholds-on-a-single-metric, threshold-on-group-duration, set-thresholds-for-specific-tags, abort-a-test-when-a-threshold-is-crossed-abort, fail-a-load-test-using-checks"
docs/sources/v0.47.x/javascript-api/jslib/k6chaijs/error-handling.md
Outdated
Show resolved
Hide resolved
There's a version of the docs published here: https://mdr-ci.staging.k6.io/docs/refs/pull/1386/merge It will be deleted automatically in 30 days. |
docs/sources/v0.47.x/testing-guides/injecting-faults-with-xk6-disruptor/_index.md
Outdated
Show resolved
Hide resolved
...sting-guides/injecting-faults-with-xk6-disruptor/examples/inject-grpc-faults-into-service.md
Outdated
Show resolved
Hide resolved
...sting-guides/injecting-faults-with-xk6-disruptor/examples/inject-grpc-faults-into-service.md
Outdated
Show resolved
Hide resolved
...sting-guides/injecting-faults-with-xk6-disruptor/examples/inject-grpc-faults-into-service.md
Outdated
Show resolved
Hide resolved
...sting-guides/injecting-faults-with-xk6-disruptor/examples/inject-grpc-faults-into-service.md
Outdated
Show resolved
Hide resolved
…e present Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
They behave the same but are more obviously recognizable as URLs. Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
make docs
proceduremake docs
procedure up to dateI can periodically sync back the docs from the website repository branch up until this PR is merged.