Feedback fixes

fboucquez · Jan 19, 2021 · b25cb1b · b25cb1b
1 parent 847a92f
commit b25cb1b
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -264,7 +264,7 @@ General users should install this tool like any other node module.
 <!-- commands -->
 # Command Topics
 
-* [`symbol-bootstrap backup`](docs/backup.md) - The command backups the Mongo and RocksDb data folder into a Zip file that can be used for --backupSync feature. Bootstrap compose services must be stopped before calling this command.
+* [`symbol-bootstrap backup`](docs/backup.md) - The command backs up the Mongo and RocksDb data folder into a Zip file that can then be used by the `--backupSync` feature. Bootstrap compose services must be stopped before calling this command.
 * [`symbol-bootstrap clean`](docs/clean.md) - It removes the target folder deleting the generated configuration and data
 * [`symbol-bootstrap compose`](docs/compose.md) - It generates the `docker-compose.yml` file from the configured network.
 * [`symbol-bootstrap config`](docs/config.md) - Command used to set up the configuration files and the nemesis block for the current network

diff --git a/docs/backup.md b/docs/backup.md
@@ -1,15 +1,15 @@
 `symbol-bootstrap backup`
 =========================
 
-The command backups the Mongo and RocksDb data folder into a Zip file that can be used for --backupSync feature. Bootstrap compose services must be stopped before calling this command.
+The command backs up the Mongo and RocksDb data folder into a Zip file that can then be used by the `--backupSync` feature. Bootstrap compose services must be stopped before calling this command.
 
 Note: this command is designed for NGL to be used when running public main or public test networks. It's not backing up any node specific information.
 
 * [`symbol-bootstrap backup`](#symbol-bootstrap-backup)
 
 ## `symbol-bootstrap backup`
 
-The command backups the Mongo and RocksDb data folder into a Zip file that can be used for --backupSync feature. Bootstrap compose services must be stopped before calling this command.
+The command backs up the Mongo and RocksDb data folder into a Zip file that can then be used by the `--backupSync` feature. Bootstrap compose services must be stopped before calling this command.
 
 ```
 USAGE

diff --git a/docs/config.md b/docs/config.md
@@ -33,6 +33,9 @@ OPTIONS
   --backupSync                      It downloads a backup with the Mongo and RocksDb databases for faster
                                     synchronization.
 
+                                    The location of the backup can be found and changed using the 'backupSyncLocation'
+                                    preset configuration. This configuration allows local files and remote URLs
+
   --pullImages                      It pulls the utility images from DockerHub when running the configuration. It only
                                     affects alpha/dev docker images.
 

diff --git a/docs/start.md b/docs/start.md
@@ -49,6 +49,9 @@ OPTIONS
   --backupSync
       It downloads a backup with the Mongo and RocksDb databases for faster synchronization.
 
+      The location of the backup can be found and changed using the 'backupSyncLocation' preset configuration. This 
+      configuration allows local files and remote URLs
+
   --healthCheck
       It checks if the services created with docker compose are up and running.
 

diff --git a/src/commands/backup.ts b/src/commands/backup.ts
@@ -17,7 +17,7 @@ import { Command, flags } from '@oclif/command';
 import { BootstrapService, BootstrapUtils } from '../service';
 
 export default class Backup extends Command {
-    static description = `The command backups the Mongo and RocksDb data folder into a Zip file that can be used for --backupSync feature. Bootstrap compose services must be stopped before calling this command.
+    static description = `The command backs up the Mongo and RocksDb data folder into a Zip file that can then be used by the \`--backupSync\` feature. Bootstrap compose services must be stopped before calling this command.
 
 Note: this command is designed for NGL to be used when running public main or public test networks. It's not backing up any node specific information.`;
 

diff --git a/src/commands/config.ts b/src/commands/config.ts
@@ -59,7 +59,9 @@ export default class Config extends Command {
         }),
 
         backupSync: flags.boolean({
-            description: 'It downloads a backup with the Mongo and RocksDb databases for faster synchronization.',
+            description: `It downloads a backup with the Mongo and RocksDb databases for faster synchronization.
+
+The location of the backup can be found and changed using the 'backupSyncLocation' preset configuration. This configuration allows local files and remote URLs`,
             default: ConfigService.defaultParams.backupSync,
         }),