Added link to documentation in k6 --help output #4984
Conversation
|
|
|
Hi @Nishant891, Thanks for your contribution! 🙇🏻 I'm not 100% sure if we really want to add this reference to the CLI help output, but even in case that's what we (still) want, you should refer to the corresponding page within https://grafana.com/docs/k6/, as k6.io is deprecated and it will eventually stopped. I'll let you know what's the team preference once we have a consensus. |
|
@joanlopez Thank you for the quick feedback! 🙏🏻 I'll wait for the team’s decision regarding whether this addition is desired in the CLI help output. Let me know once there’s a consensus! 😊 |
|
@Nishant891 Thanks for your contribution. Can you apply this suggestion and also fix the linter warning? Thanks. |
Thank you for the confirmation. I'll apply the suggestion and fix the linter issues. |
|
Hello @inancgumus I have made the necessary changes and fixed the linter issue. |
|
Hey @Nishant891, Looks like the Lint check is still failing, see this. Not sure if you have access, but the error looks like: Error: ../../../internal/cmd/root.go:64:1: File is not properly formatted (gofmt)Please, can you take a look at it and fix? Thanks! 🙇🏻 |
|
Hello @joanlopez I believe the linter issue is fixed now. |
internal/cmd/root.go
Outdated
| Use: gs.BinaryName, | ||
| Short: "a next-generation load generator", | ||
| Long: "\n" + getBanner(gs.Flags.NoColor || !gs.Stdout.IsTTY, isTrueColor(gs.Env)) + | ||
| "\n\nFull CLI documentation is available at: https://grafana.com/docs/k6", |
There was a problem hiding this comment.
@heitortsergent WDYT about this text?
There was a problem hiding this comment.
I think the text is ok. Would it be better to link directly to https://grafana.com/docs/k6/latest/using-k6/k6-options/reference/? I wonder if someone who goes to the docs homepage might get confused if they're not seeing anything CLI specific.
There was a problem hiding this comment.
Yeah sure. I'll edit this line.
There was a problem hiding this comment.
I changed the link.
Added "Full CLI documentation available at https://docs.k6.io/docs/options" in the output of k6 --help command. Related to grafana#1154
Updated link to https://grafana.com/docs/k6/
Co-authored-by: Joan López de la Franca Beltran <[email protected]>
Added "Full CLI documentation available at https://docs.k6.io/docs/options" in the output of k6 --help command.
Related to #1154
What?
The current output from k6 --help does not provides a link to the documentation while a man page for k6 --help would be a better option this provides a temporary fix to the issue.
Why?
Checklist
make check) and all pass.Checklist: Documentation (only for k6 maintainers and if relevant)
Please do not merge this PR until the following items are filled out.
Related PR(s)/Issue(s)