Create command reference topics for AMC #319
Conversation
* Add landing page with all commands of `amc` * Add command reference for `amc addon`
|
|
||
| amc addon add <addon_name> (<directory> | <tarball> | <zip archive>) --timeout=3m | ||
|
|
||
| where `-t` or --`timeout` is a string value to denote the maximum wait time for the operation to complete. The default is `5m`. |
There was a problem hiding this comment.
should we keep this consistent like the table created below for delete ?
There was a problem hiding this comment.
I just didn't want to add a table for just one flag and maybe -h. But if you feel it reads better that way, I can change it.
There was a problem hiding this comment.
I don't have a strong perference. But for me personally, I like consistency so if some are in a table, I feel it might read better if all of them are. But if it is too much work to identify each one and you have to create it manually, then it is fine as is too.
There was a problem hiding this comment.
Okay, I will push this as is for now, since there is a good chance of these getting overwritten when we automate the command docs.
|
|
||
| amc addon list --format=(table | json |csv) | ||
|
|
||
| where `--format` option controls the output format which can be in the form of a table, JSON or CSV. The default value is `table`. |
There was a problem hiding this comment.
same as above and for others with a single option ?
It's not fully automatic. I used some automation to pull content out and transform it into markdown format but either way, we can make changes. |
This is just a stop-gap until we have the auto generated docs in place. This PR does not require a lot of review as it is mostly from the CLI, just a quick one to see if there are any outdated commands listed.