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

Documentation about CR #352

Open
DanielCastronovo opened this issue Dec 13, 2023 · 4 comments
Open

Documentation about CR #352

DanielCastronovo opened this issue Dec 13, 2023 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@DanielCastronovo
Copy link

Feature Description

Provide a exhaustive list of options related to create a CR definition

Suggested Solution (optional)

No response

Already existing or connected issues / PRs (optional)

No response

@DanielCastronovo DanielCastronovo added the enhancement New feature or request label Dec 13, 2023
@yorugac
Copy link
Collaborator

yorugac commented Jan 8, 2024

Thanks for opening this @DanielCastronovo!
This was definitely discussed before internally so it is in the plans as part of improvement of k6-operator docs 👍

Ideally, I'd prefer to have an automated task generating some kind of table of options, in Markdown, etc., which we could then include into other docs.

@yorugac yorugac added documentation Improvements or additions to documentation and removed enhancement New feature or request labels Jan 8, 2024
@yorugac
Copy link
Collaborator

yorugac commented Jan 8, 2024

Btw, apparently quiet option is not easy to find: #331 (comment)

@yorugac
Copy link
Collaborator

yorugac commented Feb 8, 2024

Some options for docs generation to consider:

@yorugac
Copy link
Collaborator

yorugac commented Jun 19, 2024

Another question came up about CRD option paused:
https://community.grafana.com/t/v0-0-14-testrun-property-spec-paused-not-behaving-as-expected/124255/3

This question adds a requirement about defaults: in generated documentation, we should have default values specified so the automation must be able to extract the default values correctly as well. E.g. in Go, default value for string is "" but for paused it's actually "true".

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

No branches or pull requests

2 participants