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

create targeted tutorials on yargs website #26

Open
bcoe opened this issue Aug 7, 2016 · 7 comments
Open

create targeted tutorials on yargs website #26

bcoe opened this issue Aug 7, 2016 · 7 comments

Comments

@bcoe
Copy link
Member

bcoe commented Aug 7, 2016

like the approach we're starting to take with http://istanbul.js.org/, I'd love to see us split our very long yargs README document into various targeted tutorials. e.g.,

What do you think? also looping in @maxrimue @Charlotteis.

@varjmes
Copy link
Contributor

varjmes commented Aug 8, 2016

Hey @bcoe!

That sounds fantastic. I'm on board.
puts hand in
Go team!

@bcoe
Copy link
Member Author

bcoe commented Aug 9, 2016

@Charlotteis I was thinking as a stop gap, until we can write some content, putting a link to a Gitter chat on the website would be good, and in the yargs README.md; various folks have requested this.

@lrlna
Copy link
Member

lrlna commented Aug 9, 2016

hey folks!

I've had ideas to do this forever and literally never got around to it. Ideally I would like to see it as a set of tutorials set up as levels: i.e. first you want to get your options, then you want to have options with aliases, then you want to use a command builder. Basically you level-up. I think as a first thing, I want to compile a list of exact tutorials, and then start building them one by one. Maybe even release one weekly, like a newsletter \o/ ?

I also think they should be relevant to what people normally do, so I ran a twitter quetionnaire, so I can hopefully get some data. I know I've written a bunch of tests with marsupial examples, but I think we should have these as IRL stuff.

@lrlna
Copy link
Member

lrlna commented Aug 9, 2016

In fact, so I give myself some deadlines, I'll start with option parsing this week and actually get it done.

@varjmes
Copy link
Contributor

varjmes commented Aug 10, 2016

I was thinking as a stop gap, until we can write some content, putting a link to a Gitter chat on the website would be good, and in the yargs README.md; various folks have requested this

I am biased toward Slack, but that sounds like a good idea as any :)

I've had ideas to do this forever and literally never got around to it. Ideally I would like to see it as a set of tutorials set up as levels: i.e. first you want to get your options, then you want to have options with aliases, then you want to use a command builder. Basically you level-up. I think as a first thing, I want to compile a list of exact tutorials, and then start building them one by one. Maybe even release one weekly, like a newsletter \o/ ?

I love this. Too many times do I get tutorials that are "HERE ARE ALL THE THINGS, BYE!!!!"
I like the idea of "you have done this, now try this, yay awesome learning, next up is this!"

@bcoe
Copy link
Member Author

bcoe commented Aug 14, 2016

@Charlotteis would you like to join the yargs maintainer slack? if so what email should I send an invite to?

@varjmes
Copy link
Contributor

varjmes commented Aug 15, 2016

@bcoe [email protected] :)

@maxrimue maxrimue mentioned this issue Dec 29, 2016
7 tasks
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

3 participants