Provide more details on each command in the online docs #137
Labels
documentation
Improvements or additions to documentation
friction
Issue causes friction in adoption of product
We should enhance the https://www.telepresence.io/docs/latest/reference/client page to provide more information on each command equivalent (or better to what the --help option would provide for each command):
An example of command line interface documentation can be found with IBM Rational's ClearCase(going waaaay back in the day) commands that can be used for inspiration on how to improve our documentation:
Feedback from Daniel:
I am loving the ability to set the Telepresence intercept ingress parameters via the command line (perfect for scripting dev environment setups :awesome:), and wanted to share a piece of docs/help feedback. I initially scanned telepresence intercept --help , saw the flags and crafted this command based on my previous experience of answering the questions that pop up in the terminal (edited)
Because the command returned a non-successful exit code my script failed and Telepresence quit
A quick bit of trial and error (and also re-reading the help a bit more closely) revealed that --ingress-tls is actually a flag that requires no value to be set 🙂 I wonder if other part-time/distracted developers like myself who have become used to answering the ingress questions (almost robotically) on the terminal may stumble into the same issue? (cc @eric Funk) (edited)
And following this thought, I wonder if including some example values in the help docs would be useful, especially for the host and l5 e.g. "ambassador.ambassador"
The text was updated successfully, but these errors were encountered: