Updates to descriptions and examples for vip backup #1766
Conversation
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.OpenSSF Scorecard
Scanned Manifest Files |
|
| @@ -27,7 +27,7 @@ const runCmd = async function () { | |||
| cmd | |||
| .command( 'logout', 'Logout from your current session' ) | |||
| .command( 'app', 'List and modify your VIP applications' ) | |||
| .command( 'backup', 'Generate a backup for VIP applications' ) | |||
| .command( 'backup', 'Generate a backup of an environment.' ) | |||
There was a problem hiding this comment.
Should this match the text above?
Generate a new database backup of an environment.
There was a problem hiding this comment.
Sooo... this touches on our grander strategic discussion around the patterns that our VIP-CLI command library should follow in order to be truly extensible.
By adding the command vip backup, we should be doing so because we believe that we will be adding a group of subcommands related to backup (e.g., db, media).
In good faith that this might be the direction that we are heading in for vip backup, we are choosing to describe that command in a more neutral manner.
Description
Updated the voice, tense, and format of command descriptions, examples, and usage models for the
vip backupcommand group to follow the VIP-CLI style guide.Pull request checklist
New release checklist
Steps to Test
Observe the results of the --help display for impacted commands:
vip backupvip backup db