Refrain from using CLI short parameters in the tutorials
walterdolce opened this issue · comments
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!
Concur - long options are awesome in documentation for immediate understanding.
Agreed.