From 4e45389ce1653571bc2c8db5a331a13984c6f766 Mon Sep 17 00:00:00 2001 From: Yoli Hodde Date: Tue, 9 Apr 2024 16:33:58 -0700 Subject: [PATCH 1/3] Updates to descriptions and examples for vip backup --- src/bin/vip-backup-db.ts | 9 +++++++-- src/bin/vip-backup.ts | 10 +++++++--- src/bin/vip.js | 2 +- 3 files changed, 15 insertions(+), 6 deletions(-) diff --git a/src/bin/vip-backup-db.ts b/src/bin/vip-backup-db.ts index d49668d1f..15f74ef0c 100755 --- a/src/bin/vip-backup-db.ts +++ b/src/bin/vip-backup-db.ts @@ -7,8 +7,13 @@ import { makeCommandTracker } from '../lib/tracker'; const examples = [ { - usage: 'vip backup db @mysite.develop', - description: 'Trigger a new backup for your database of the @mysite.develop environment', + usage: + 'vip @example-app.develop backup db\n' + + ' Generating a new database backup...\n' + + ' ✓ Preparing for backup generation\n' + + ' ✓ Generating backup\n' + + ' New database backup created', + description: 'Generate a fresh database backup for an environment.', }, ]; diff --git a/src/bin/vip-backup.ts b/src/bin/vip-backup.ts index 9dead51d3..991f67dc8 100755 --- a/src/bin/vip-backup.ts +++ b/src/bin/vip-backup.ts @@ -4,10 +4,14 @@ import command from '../lib/cli/command'; import { trackEvent } from '../lib/tracker'; void command( { usage: 'vip backup' } ) - .command( 'db', 'Trigger a new backup for your database' ) + .command( 'db', 'Generate a fresh database backup for an environment.' ) .example( - 'vip backup db @mysite.develop', - 'Trigger a new backup for your database of the @mysite.develop environment' + 'vip @example-app.develop backup db\n' + + ' Generating a new database backup...\n' + + ' ✓ Preparing for backup generation\n' + + ' ✓ Generating backup\n' + + ' New database backup created', + 'Generate a fresh database backup for an environment.' ) .argv( process.argv, async () => { await trackEvent( 'vip_backup_command_execute' ); diff --git a/src/bin/vip.js b/src/bin/vip.js index b132f08ff..f5f6dcfed 100755 --- a/src/bin/vip.js +++ b/src/bin/vip.js @@ -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 for an environment.' ) .command( 'cache', 'Manage page cache for your VIP applications' ) .command( 'config', 'Set configuration for your VIP applications' ) .command( 'dev-env', 'Use local dev-environment' ) From b4235c7d828bbabac5ed9674473507343c390dad Mon Sep 17 00:00:00 2001 From: Yoli Hodde Date: Tue, 16 Apr 2024 15:49:50 -0700 Subject: [PATCH 2/3] Updates requested in pull request review --- src/bin/vip-backup-db.ts | 2 +- src/bin/vip.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/bin/vip-backup-db.ts b/src/bin/vip-backup-db.ts index 15f74ef0c..45b7d535a 100755 --- a/src/bin/vip-backup-db.ts +++ b/src/bin/vip-backup-db.ts @@ -13,7 +13,7 @@ const examples = [ ' ✓ Preparing for backup generation\n' + ' ✓ Generating backup\n' + ' New database backup created', - description: 'Generate a fresh database backup for an environment.', + description: 'Generate a new database backup for an environment.', }, ]; diff --git a/src/bin/vip.js b/src/bin/vip.js index 32acca1f0..6a63e576a 100755 --- a/src/bin/vip.js +++ b/src/bin/vip.js @@ -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 an environment.' ) + .command( 'backup', 'Generate a backup of an environment.' ) .command( 'cache', 'Manage page cache for your VIP applications' ) .command( 'config', 'Manage environment configurations.' ) .command( 'dev-env', 'Use local dev-environment' ) From 1067f3d61f3ae08cb40518e73b73f0137c73fe0d Mon Sep 17 00:00:00 2001 From: Yoli Hodde Date: Wed, 17 Apr 2024 09:11:44 -0700 Subject: [PATCH 3/3] Second round of updates based on review --- src/bin/vip-backup-db.ts | 2 +- src/bin/vip-backup.ts | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/bin/vip-backup-db.ts b/src/bin/vip-backup-db.ts index 45b7d535a..c1d966cb1 100755 --- a/src/bin/vip-backup-db.ts +++ b/src/bin/vip-backup-db.ts @@ -13,7 +13,7 @@ const examples = [ ' ✓ Preparing for backup generation\n' + ' ✓ Generating backup\n' + ' New database backup created', - description: 'Generate a new database backup for an environment.', + description: 'Generate a new database backup of an environment.', }, ]; diff --git a/src/bin/vip-backup.ts b/src/bin/vip-backup.ts index 991f67dc8..60a462dfc 100755 --- a/src/bin/vip-backup.ts +++ b/src/bin/vip-backup.ts @@ -4,14 +4,14 @@ import command from '../lib/cli/command'; import { trackEvent } from '../lib/tracker'; void command( { usage: 'vip backup' } ) - .command( 'db', 'Generate a fresh database backup for an environment.' ) + .command( 'db', 'Generate a new database backup of an environment.' ) .example( 'vip @example-app.develop backup db\n' + ' Generating a new database backup...\n' + ' ✓ Preparing for backup generation\n' + ' ✓ Generating backup\n' + ' New database backup created', - 'Generate a fresh database backup for an environment.' + 'Generate a new database backup of an environment.' ) .argv( process.argv, async () => { await trackEvent( 'vip_backup_command_execute' );