olmv1 subcommand documentation #238
Conversation
| operator olmv1 create [command] | ||
|
|
||
| Available Commands: | ||
| catalog Create a new catalog |
There was a problem hiding this comment.
Replacing catalog with ClusterCatalog to keep the naming consistent across the doc
| catalog Create a new catalog | |
| catalog Create a new ClusterCatalog |
Suggest naming extension to ClusterExtension as well wherever applicable
There was a problem hiding this comment.
I am keeping the help text consistent for this PR to match the help text that gets generated. There is another issue to track the change #237
There was a problem hiding this comment.
Oh, so the actual command help text says "catalog" everywhere right now. That makes sense to me to keep these docs parallel to the current help text and change both the docs and command help text in the future.
There was a problem hiding this comment.
Apart from this, there are also inconsistencies in flag definitions across commands (--available vs --availability-mode, partial support for flag shorthands between commands, etc.)
| Create a new `ClusterCatalog` with the provided name and catalog image reference. | ||
|
|
||
| ```bash | ||
| Create a new catalog |
There was a problem hiding this comment.
| Create a new catalog | |
| Create a new ClusterCatalog |
| operator olmv1 delete [command] | ||
|
|
||
| Available Commands: | ||
| catalog Delete either a single or all of the existing catalogs |
There was a problem hiding this comment.
| catalog Delete either a single or all of the existing catalogs | |
| catalog Delete either a single or all of the existing `ClusterCatalogs` |
| Delete either a single `ClusterCatalog` by name, or all `ClusterCatalogs` on cluster. The `--all` flag allows for cleaning up all existing catalogs on cluster, and cannot be used when a `ClusterCatalog` name is passed as an argument. | ||
|
|
||
| ```bash | ||
| Delete either a single or all of the existing catalogs |
There was a problem hiding this comment.
| Delete either a single or all of the existing catalogs | |
| Delete either a single or all of the existing `ClusterCatalogs` |
| catalog, catalogs [catalog_name] | ||
|
|
||
| Flags: | ||
| --all delete all catalogs |
There was a problem hiding this comment.
| --all delete all catalogs | |
| --all delete all `ClusterCatalogs` |
| operator olmv1 update [command] | ||
|
|
||
| Available Commands: | ||
| catalog Update a catalog |
There was a problem hiding this comment.
| catalog Update a catalog | |
| catalog Update a `ClusterCatalog` |
| operator olmv1 get [command] | ||
|
|
||
| Available Commands: | ||
| catalog Display one or many installed catalogs |
There was a problem hiding this comment.
| catalog Display one or many installed catalogs | |
| catalog Display one or many installed `ClusterCatalogs` |
|
|
||
| Available Commands: | ||
| catalog Display one or many installed catalogs | ||
| extension Display one or many installed extensions |
There was a problem hiding this comment.
| extension Display one or many installed extensions | |
| extension Display one or many installed `ClusterExtensions` |
| Display status information of installed `ClusterExtensions`. | ||
|
|
||
| ```bash | ||
| Display one or many installed extensions |
There was a problem hiding this comment.
| Display one or many installed extensions | |
| Display one or many installed `ClusterExtensions` |
There was a problem hiding this comment.
Looks great overall.
(optional): A couple of suggestions:
- It'd be nice to add one example for each subcommand so it's easier for users to understand expected usage quickly.
- Add a short description for ClusterCatalog and ClusterExtension before linking to the respective APIs
ankitathomas
force-pushed
the
readme
branch
2 times, most recently
from
d3461a9 to
bcbb0a3
Compare
| Available Commands: | ||
| create Create a resource | ||
| delete Delete a resource | ||
| get Display one or many resource(s) |
There was a problem hiding this comment.
I think the most idiomatic phrasing here would be "Display one or more resources" or perhaps just "Display resources" which captures both cases
There was a problem hiding this comment.
If this is what the actual command help text says though, then disregard
There was a problem hiding this comment.
Keeping the comment unresolved since follow up work on improving help text #237 needs to address this.
| operator olmv1 create [command] | ||
|
|
||
| Available Commands: | ||
| catalog Create a new catalog |
There was a problem hiding this comment.
Oh, so the actual command help text says "catalog" everywhere right now. That makes sense to me to keep these docs parallel to the current help text and change both the docs and command help text in the future.
| Flags: | ||
| -c, --channels strings channels which would be used for getting updates, e.g, --channels "stable,dev-preview,preview" | ||
| -d, --cleanup-timeout duration the amount of time to wait before cancelling cleanup after a failed creation attempt (default 1m0s) | ||
| -n, --namespace string namespace to install the operator in |
There was a problem hiding this comment.
if separate from the cli help text, would reword to something like "installation namespace for the operator" or "destination namespace for the operator installation"
Added examples for list to have an example of what the output looks like for |
ankitathomas
force-pushed
the
readme
branch
4 times, most recently
from
eaeea71 to
deb52e5
Compare
Signed-off-by: Ankita Thomas <[email protected]>
3 participants
Add documentation to describe current state of olmv1 support in subcommands.
see #236