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

Add docs URL to the output of k6 --help #1154

Open
sniku opened this issue Sep 12, 2019 · 2 comments
Open

Add docs URL to the output of k6 --help #1154

sniku opened this issue Sep 12, 2019 · 2 comments

Comments

@sniku
Copy link
Collaborator

sniku commented Sep 12, 2019

I suggest we add the following sentence to the output of k6 --help:
"Full CLI documentation available at https://docs.k6.io/docs/options"

09_12_2019__13:21:08

@sniku sniku added the ux label Sep 12, 2019
@sniku sniku changed the title Add link to the k6 docs when executing k6 --help Add docs URL to the output of k6 --help` Sep 12, 2019
@sniku sniku changed the title Add docs URL to the output of k6 --help` Add docs URL to the output of k6 --help Sep 12, 2019
@imiric
Copy link
Contributor

imiric commented Sep 12, 2019

I see you tried man k6 before --help. ;)

On that note, what do you think about distributing a man page as well? I'm not sure how easy it would be to convert the current documentation, but maybe something to consider for the upcoming documentation restructuring. It would be great for the repo to be the single source for docs, which can be built to several targets.

@na--
Copy link
Member

na-- commented Sep 12, 2019

I'm very much in favor of having man pages for k6, especially since we distribute some os packages anyway, so feel free to create one 😄 Though it's going to be very tricky to reuse the same text for our man pages and the real docs... And it's likely that man pages would come much later than the new docs, given how they'll probably be tied together with the configuration restructuring of k6...

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

No branches or pull requests

4 participants