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

Refrain from using CLI short parameters in the tutorials #144

Open
walterdolce opened this issue May 4, 2018 · 2 comments
Open

Refrain from using CLI short parameters in the tutorials #144

walterdolce opened this issue May 4, 2018 · 2 comments

Comments

@walterdolce
Copy link

walterdolce commented May 4, 2018

As a first-time learner of Concourse, I am enjoying the tutorial you guys wrote. But as I read along I often found myself struggling to remember what the CLI shortcuts mean and this caused me to go back to my CLI and figure out what they were for.

I should not have to have to remember. I should just be able to read the CLI commands and their parameters as-is. I appreciate using the shortcuts makes the commands shorter, but a tutorial should strive for consistent clarity.

Leave the use of the CLI shortcuts to the Concourse's experienced users. Eventually, we - Concourse newbies - will get there and use the shortcuts ourselves.

If you are happy and agree with this, I am more than happy to convert all the shortcuts found in the tutorial pages into explicit parameters for you.

Thank you!

@rud
Copy link
Contributor

rud commented May 7, 2018

Concur - long options are awesome in documentation for immediate understanding.

@drnic
Copy link
Contributor

drnic commented May 8, 2018

Agreed.

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

No branches or pull requests

3 participants