Skip to content
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

relref replace - k6 #1888

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

relref replace - k6 #1888

wants to merge 2 commits into from

Conversation

robbymilo
Copy link
Contributor

@robbymilo robbymilo commented Mar 11, 2025

For https://github.com/grafana/website/issues/24017

Removes all relref shortcodes.

Repository: grafana/k6-docs
Website-Pull-Request: https://github.com/grafana/website/pull/24498

@robbymilo robbymilo requested a review from jdbaldry March 11, 2025 14:54
@robbymilo robbymilo marked this pull request as ready for review March 11, 2025 14:54
@robbymilo robbymilo requested review from heitortsergent and a team as code owners March 11, 2025 14:54
@robbymilo robbymilo requested review from codebien and joanlopez and removed request for a team March 11, 2025 14:54
@@ -7,6 +7,6 @@ title: jslib/aws module blocking admonition
In some cases, using this library's operations might impact performance and skew your test results.
<br>
<br>
To ensure accurate results, consider executing these operations in the `setup` and `teardown` [lifecycle functions]({{< relref "../using-k6/test-lifecycle" >}}). These functions run before and after the test run and have no impact on the test results.
To ensure accurate results, consider executing these operations in the `setup` and `teardown` [lifecycle functions](../../using-k6/test-lifecycle/). These functions run before and after the test run and have no impact on the test results.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To ensure accurate results, consider executing these operations in the `setup` and `teardown` [lifecycle functions](../../using-k6/test-lifecycle/). These functions run before and after the test run and have no impact on the test results.
To ensure accurate results, consider executing these operations in the `setup` and `teardown` [lifecycle functions](htts://grafana.com/docs/k6/<K6_VERSION>/using-k6/test-lifecycle/). These functions run before and after the test run and have no impact on the test results.

I tried to run this locally and I think the link isn't working. :( Maybe we just replace it with the full URL?

@@ -7,6 +7,6 @@ title: k6/crypto module admonition
A module with a better and standard API exists.
<br>
<br>
The new [k6/experimental/webcrypto API]({{< relref "../javascript-api/k6-experimental/webcrypto" >}}) partially implements the [WebCryptoAPI](https://www.w3.org/TR/WebCryptoAPI/), supporting more features than [k6/crypto]({{< relref "../javascript-api/k6-crypto" >}}).
The new [k6/experimental/webcrypto API](../../javascript-api/k6-experimental/webcrypto/) partially implements the [WebCryptoAPI](https://www.w3.org/TR/WebCryptoAPI/), supporting more features than [k6/crypto](../../javascript-api/k6-crypto/).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The new [k6/experimental/webcrypto API](../../javascript-api/k6-experimental/webcrypto/) partially implements the [WebCryptoAPI](https://www.w3.org/TR/WebCryptoAPI/), supporting more features than [k6/crypto](../../javascript-api/k6-crypto/).
The new [k6/experimental/webcrypto API](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/webcrypto/) partially implements the [WebCryptoAPI](https://www.w3.org/TR/WebCryptoAPI/), supporting more features than [k6/crypto](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-crypto/).

@@ -7,7 +7,7 @@ title: Experimental module admonition
This is an experimental module.
<br>
<br>
While we intend to keep experimental modules as stable as possible, we may need to introduce breaking changes. This could happen at future k6 releases until the module becomes fully stable and graduates as a k6 core module. For more information, refer to the [extension graduation process]({{< relref "../extensions/explanations/extension-graduation" >}}).
While we intend to keep experimental modules as stable as possible, we may need to introduce breaking changes. This could happen at future k6 releases until the module becomes fully stable and graduates as a k6 core module. For more information, refer to the [extension graduation process](../../extensions/explanations/extension-graduation/).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
While we intend to keep experimental modules as stable as possible, we may need to introduce breaking changes. This could happen at future k6 releases until the module becomes fully stable and graduates as a k6 core module. For more information, refer to the [extension graduation process](../../extensions/explanations/extension-graduation/).
While we intend to keep experimental modules as stable as possible, we may need to introduce breaking changes. This could happen at future k6 releases until the module becomes fully stable and graduates as a k6 core module. For more information, refer to the [extension graduation process](https://grafana.com/docs/k6/<K6_VERSION>/extensions/explanations/extension-graduation/).

@@ -7,7 +7,7 @@ title: k6/ws module admonition
A module with a better and standard API exists.
<br>
<br>
The new [k6/experimental/websockets API]({{< relref "../javascript-api/k6-experimental/websockets" >}}) partially implements the [WebSockets API living standard](https://websockets.spec.whatwg.org/).
The new [k6/experimental/websockets API](../../javascript-api/k6-experimental/websockets/) partially implements the [WebSockets API living standard](https://websockets.spec.whatwg.org/).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The new [k6/experimental/websockets API](../../javascript-api/k6-experimental/websockets/) partially implements the [WebSockets API living standard](https://websockets.spec.whatwg.org/).
The new [k6/experimental/websockets API](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-experimental/websockets/) partially implements the [WebSockets API living standard](https://websockets.spec.whatwg.org/).

@heitortsergent
Copy link
Collaborator

@robbymilo thank you so much for opening this. 🙇

I left some comments there, could we replace the relative links with the full URLs? I think we ended up with some broken links because of it.

@robbymilo
Copy link
Contributor Author

Thanks for the catch @heitortsergent! https://github.com/grafana/website/pull/24498#issuecomment-2717032275 shows that the original commit did introduce some errors due to the shared files. I've fixed them and now https://github.com/grafana/website/pull/24498#issuecomment-2717083340 is showing no broken links.

Copy link
Collaborator

@heitortsergent heitortsergent left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, thanks again for fixing these @robbymilo! \o/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants