k6-operator: add link to CRD reference doc #2026
Merged
Conversation
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
heitortsergent
approved these changes
Aug 14, 2025
docs/sources/k6/next/set-up/set-up-distributed-k6/usage/configuring-testrun-crd.md
Outdated
Show resolved
Hide resolved
docs/sources/k6/v1.0.x/set-up/set-up-distributed-k6/usage/configuring-testrun-crd.md
Outdated
Show resolved
Hide resolved
docs/sources/k6/v1.1.x/set-up/set-up-distributed-k6/usage/configuring-testrun-crd.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actually, could we rename the file to "configure-testrun-crd.md"? This would affect the grafana/k6-operator#630 PR as well, but that would fit our style guide better.
I also left a comment to update the title and h1.
docs/sources/k6/next/set-up/set-up-distributed-k6/usage/configuring-testrun-crd.md
Outdated
Show resolved
Hide resolved
docs/sources/k6/next/set-up/set-up-distributed-k6/usage/configuring-testrun-crd.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Heitor Tashiro Sergent <[email protected]>
|
💻 Deploy preview deleted. |
yorugac
force-pushed
the
chore/add-reference-to-crd-doc
branch
from
044ede1 to
522376b
Compare
|
All renamings done and local preview looks 👌 Thanks Heitor! |
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.
What?
We decided to keep the machine-generated CRD reference in the k6-operator repo, as it's unclear how to move it to the k6-docs. But there must be at least a link to it from the official docs. Let's add it here.
Checklist
npm startcommand locally and verified that the changes look good.docs/sources/k6/nextfolder of the documentation.docs/sources/k6/v{most_recent_release}folder of the documentation.docs/sources/k6/nextfolder of the documentation.Related PR(s)/Issue(s)
Related past work:
grafana/k6-operator#352