CLOUDP-196976: Publish compliancePolicy commands #2494
Conversation
blva
changed the title
| * - -h, --help | ||
| - | ||
| - false | ||
| - help for disable |
There was a problem hiding this comment.
| - help for disable | |
| - Help information for disable command. |
There was a problem hiding this comment.
This one is also automatically generated format is help for and its the same pattern across all commands
| * - -w, --watch | ||
| - | ||
| - false | ||
| - Flag that indicates whether to watch the command until it completes its execution or the watch times out. |
There was a problem hiding this comment.
| - Flag that indicates whether to watch the command until it completes its execution or the watch times out. | |
| - Flag that indicates whether to watch the command until it completes its execution or the time out and stop watching the command. |
There was a problem hiding this comment.
FYI: The flag --watch is used across other commands and has been reviewed in the past. Updating this will update docs for all related commands.
I think "and stop watching the command" seems a bit more confusing here and would prefer to keep as is.
| * - -h, --help | ||
| - | ||
| - false | ||
| - help for enable |
There was a problem hiding this comment.
| - help for enable | |
| - Help information for enable command. |
| * - --projectId | ||
| - string | ||
| - false | ||
| - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. |
There was a problem hiding this comment.
| - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. | |
| - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file and the environment variable. |
There was a problem hiding this comment.
FYI: This flag is used in all projects, and it will get updated in all docs and we'll have many updates. if we really want to update the copy of this flag we should do in another PR
| * - -w, --watch | ||
| - | ||
| - false | ||
| - Flag that indicates whether to watch the command until it completes its execution or the watch times out. |
There was a problem hiding this comment.
| - Flag that indicates whether to watch the command until it completes its execution or the watch times out. | |
| - Flag that indicates whether to watch the command until it completes its execution or time out and stop watching the command. |
docs/atlascli/command/atlas-backups-compliancePolicy-encryptionAtRest.txt
Outdated
Show resolved
Hide resolved
docs/atlascli/command/atlas-backups-compliancePolicy-policies-ondemand-create.txt
Outdated
Show resolved
Hide resolved
docs/atlascli/command/atlas-backups-compliancePolicy-policies-ondemand-create.txt
Outdated
Show resolved
Hide resolved
docs/atlascli/command/atlas-backups-compliancePolicy-policies-ondemand-update.txt
Outdated
Show resolved
Hide resolved
docs/atlascli/command/atlas-backups-compliancePolicy-policies-ondemand-update.txt
Outdated
Show resolved
Hide resolved
|
@kanchana-mongodb rfal, I've updated everything that is not --projectId (global flag), --help description or --watch, which are common flags and changing them would change docs everywhere, so better to address separately if we have strong opinion. |
Proposed changes
Jira ticket: CLOUDP-196976
Closes #[issue number]
Checklist
make fmtand formatted my codeFurther comments