Update live reference docs #1902
Conversation
site/reference/live/apply/README.md
Outdated
| ### Synopsis | ||
| <!--mdtogo:Long--> | ||
| ``` | ||
| kpt live apply DIR [flags] | ||
| kpt live apply [DIR|-] [flags] |
There was a problem hiding this comment.
We're using PKG_PATH for package directories. DIR for normal directories. e.g.:
https://kpt.dev/reference/pkg/update/
Same for other commands.
There was a problem hiding this comment.
We should also have a consistent description for the flag. "Path to a directory containing KRM resources and a Kptfile" is a awkward (The critical thing is Kptfile, otherwise not having any other KRM resources is a valid case).
There was a problem hiding this comment.
I have updated the reference docs for all the live commands. I added some new language to the description, but I'm open to suggestions here.
site/reference/live/apply/README.md
Outdated
| ``` | ||
| --poll-period: | ||
| The frequency with which the cluster will be polled to determine | ||
| the status of the applied resources. The default value is every 2 seconds. | ||
| the status of the applied resources. The default value is 2 seconds. |
There was a problem hiding this comment.
General question: what's the ordering of the flag here? It should be alphabetical but it's not (Applies to other commands as well)
There was a problem hiding this comment.
Fixed this for the live reference docs. Will do another pass at the pkg docs when we have merged this one.
| @@ -1,111 +1,81 @@ | |||
| --- | |||
| title: "Status" | |||
| title: "`status`" | |||
There was a problem hiding this comment.
@phanimarupaka are we changing this command to be a verb i.e. observe? Same question for tree, there are the only two noun commands.
| DIR|-: | ||
| Path to a directory containing KRM resources and a Kptfile with inventory | ||
| information. The path can be relative or absolute. Providing '-' instead | ||
| of the path to a directory cause kpt to read from stdin. | ||
| ``` | ||
|
|
||
| #### Flags |
There was a problem hiding this comment.
should the ex-global flags (your other PR) be listed here?
There was a problem hiding this comment.
Those apply to all commands in live command group, so I think those should be included in the live page. Similar, we probably want to document the global flags on the top-level group.
Alternatively we can look into ways to include subtemplates so we can get the complete set of flags for every command, but this will lead to a pretty long list of flags.
There was a problem hiding this comment.
If they apply to all live commands, then we should include them in reference/live. Is that a follow up?
There was a problem hiding this comment.
If this looks good otherwise, I can do it as a follow-up.
* Update live reference docs * Addressed comments * Addressed comments
This covers the
kpt livecommands.