Updated documentation for tenant access set command in admin-cli to keep it consistent with the output of the CLI. #974
Conversation
docs/user-guide/admin-cli.md
Outdated
@@ -390,8 +390,8 @@ usage: vmdkops_admin.py tenant access set [-h] | |||
[--volume-totalsize Num{MB,GB,TB} - e.g. 2TB] | |||
--name NAME | |||
[--volume-maxsize Num{MB,GB,TB} - e.g. 2TB] | |||
[--allow-create] --datastore | |||
DATASTORE | |||
[--allow-create ALLOW_CREATE] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- How about changing "ALLOW_CREATE" to "True|False" to make it clearer?
- We need to make the same change for line 300.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As we discussed, we will address the change to make add and set commands consistent separately.
docs/user-guide/admin-cli.md
Outdated
@@ -401,7 +401,10 @@ optional arguments: | |||
--name NAME Tenant name | |||
--volume-maxsize Num{MB,GB,TB} - e.g. 2TB | |||
Maximum size of the volume that can be created | |||
--allow-create Allow create and delete on datastore if set to True | |||
--allow-create ALLOW_CREATE | |||
Allow create and delete on datastore if set to True; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need to make the same change for line 311.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As we discussed, we will address the change to make add and set commands consistent separately.
7549974
to
86e64e9
Compare
…eep it consistent with the output of the CLI. Addressed Sam's feedback.
eb51362
to
ed397c6
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
@@ -390,8 +390,8 @@ usage: vmdkops_admin.py tenant access set [-h] | |||
[--volume-totalsize Num{MB,GB,TB} - e.g. 2TB] | |||
--name NAME | |||
[--volume-maxsize Num{MB,GB,TB} - e.g. 2TB] | |||
[--allow-create] --datastore | |||
DATASTORE | |||
[--allow-create Value{True|False} e.g. True] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: I think we can remove "e.g. True"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would prefer to keep it as to keep it consistent with the rest.
@@ -401,7 +401,10 @@ optional arguments: | |||
--name NAME Tenant name | |||
--volume-maxsize Num{MB,GB,TB} - e.g. 2TB | |||
Maximum size of the volume that can be created | |||
--allow-create Allow create and delete on datastore if set to True | |||
--allow-create Value{True|False} - e.g. True |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same as above.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would prefer to keep it as to keep it consistent with the rest.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Updated documentation for tenant access set command in admin-cli to keep it consistent with the output of the CLI.