Merge pull request #1701 from contentstack/fix/dx-1887-ui-docs-mismatch

dx | 1887 UI docs mismatch

packages/contentstack-audit/README.md

@@ -269,7 +269,7 @@ EXAMPLES
   $ csdx plugins
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.19/src/commands/plugins/index.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.22/src/commands/plugins/index.ts)_
 
 ## `csdx plugins:add PLUGIN`
 
@@ -343,7 +343,7 @@ EXAMPLES
   $ csdx plugins:inspect myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.19/src/commands/plugins/inspect.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.22/src/commands/plugins/inspect.ts)_
 
 ## `csdx plugins:install PLUGIN`
 
@@ -392,7 +392,7 @@ EXAMPLES
     $ csdx plugins:install someuser/someplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.19/src/commands/plugins/install.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.22/src/commands/plugins/install.ts)_
 
 ## `csdx plugins:link PATH`
 
@@ -423,7 +423,7 @@ EXAMPLES
   $ csdx plugins:link myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.19/src/commands/plugins/link.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.22/src/commands/plugins/link.ts)_
 
 ## `csdx plugins:remove [PLUGIN]`
 
@@ -464,7 +464,7 @@ FLAGS
   --reinstall  Reinstall all plugins after uninstalling.
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.19/src/commands/plugins/reset.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.22/src/commands/plugins/reset.ts)_
 
 ## `csdx plugins:uninstall [PLUGIN]`
 
@@ -492,7 +492,7 @@ EXAMPLES
   $ csdx plugins:uninstall myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.19/src/commands/plugins/uninstall.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.22/src/commands/plugins/uninstall.ts)_
 
 ## `csdx plugins:unlink [PLUGIN]`
 
@@ -536,5 +536,5 @@ DESCRIPTION
   Update installed plugins.
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.19/src/commands/plugins/update.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.22/src/commands/plugins/update.ts)_
 <!-- commandsstop -->

packages/contentstack-auth/README.md

@@ -49,9 +49,9 @@ USAGE
   $ csdx auth:login [-u <value> | --oauth] [-p <value> | ]
 
 FLAGS
-  -p, --password=<value>  Password of your Contentstack app
+  -p, --password=<value>  Password of your Contentstack app.
   -u, --username=<value>  Email address of your Contentstack account.
-  --oauth                 Enables single sign-on (SSO) in Contentstack CLI
+  --oauth                 Enables single sign-on (SSO) in Contentstack CLI.
 
 DESCRIPTION
   User sessions login
@@ -82,7 +82,7 @@ USAGE
   $ csdx auth:logout [-y]
 
 FLAGS
-  -y, --yes  Force log out by skipping the confirmation
+  -y, --yes  Force log out by skipping the confirmation.
 
 DESCRIPTION
   User session logout
@@ -230,9 +230,9 @@ USAGE
   $ csdx login [-u <value> | --oauth] [-p <value> | ]
 
 FLAGS
-  -p, --password=<value>  Password of your Contentstack app
+  -p, --password=<value>  Password of your Contentstack app.
   -u, --username=<value>  Email address of your Contentstack account.
-  --oauth                 Enables single sign-on (SSO) in Contentstack CLI
+  --oauth                 Enables single sign-on (SSO) in Contentstack CLI.
 
 DESCRIPTION
   User sessions login
@@ -261,7 +261,7 @@ USAGE
   $ csdx logout [-y]
 
 FLAGS
-  -y, --yes  Force log out by skipping the confirmation
+  -y, --yes  Force log out by skipping the confirmation.
 
 DESCRIPTION
   User session logout

packages/contentstack-auth/messages/index.json

@@ -23,7 +23,7 @@
   "CLI_AUTH_WHOAMI_DESCRIPTION": "Display current users email address",
   "CLI_AUTH_TOKENS_ADD_ASK_TOKEN_ALIAS": "Provide alias to store token",
   "CLI_AUTH_TOKENS_ADD_CONFIRM_ALIAS_REPLACE": "Alias is already exists, do you want to replace?",
-  "CLI_AUTH_TOKENS_ADD_ENTER_API_KEY": "Enter the api key",
+  "CLI_AUTH_TOKENS_ADD_ENTER_API_KEY": "Enter the API key",
   "CLI_AUTH_TOKENS_ADD_ENTER_TOKEN": "Enter the token",
   "CLI_AUTH_TOKENS_ADD_ENTER_ENVIRONMENT": "Enter the environment name",
   "CLI_AUTH_TOKENS_ADD_REPLACE_SUCCESS": "Successfully replaced the token",

packages/contentstack-auth/src/commands/auth/login.ts

@@ -34,13 +34,13 @@ export default class LoginCommand extends BaseCommand<typeof LoginCommand> {
     }),
     password: flags.string({
       char: 'p',
-      description: 'Password of your Contentstack app',
+      description: 'Password of your Contentstack app.',
       multiple: false,
       required: false,
       exclusive: ['oauth'],
     }),
     oauth: flags.boolean({
-      description: 'Enables single sign-on (SSO) in Contentstack CLI',
+      description: 'Enables single sign-on (SSO) in Contentstack CLI.',
       required: false,
       default: false,
       exclusive: ['username', 'password'],

packages/contentstack-auth/src/commands/auth/logout.ts

@@ -20,13 +20,13 @@ export default class LogoutCommand extends BaseCommand<typeof LogoutCommand> {
   static flags: FlagInput = {
     yes: flags.boolean({
       char: 'y',
-      description: 'Force log out by skipping the confirmation',
+      description: 'Force log out by skipping the confirmation.',
       required: false,
       default: false,
     }),
     force: flags.boolean({
       char: 'f',
-      description: 'Force log out by skipping the confirmation',
+      description: 'Force log out by skipping the confirmation.',
       required: false,
       hidden: true,
       default: false,

packages/contentstack-bootstrap/README.md

@@ -50,7 +50,7 @@ USAGE
 FLAGS
   -a, --alias=<value>          Alias of the management token
   -k, --stack-api-key=<value>  Provide stack API key to seed content
-  -n, --stack-name=<value>     Name of a new stack that will be created.
+  -n, --stack-name=<value>     Name of the new stack that will be created.
   -y, --yes=<value>            [Optional] Skip stack confirmation
   --app-name=<value>           App name, reactjs-starter, nextjs-starter, gatsby-starter, angular-starter, nuxt-starter,
                                vue-starter, stencil-starter

packages/contentstack-bootstrap/src/commands/cm/bootstrap.ts

@@ -66,7 +66,7 @@ export default class BootstrapCommand extends Command {
     }),
     'stack-name': flags.string({
       char: 'n',
-      description: 'Name of a new stack that will be created.',
+      description: 'Name of the new stack that will be created.',
       multiple: false,
       required: false,
       exclusive: ['stack-api-key'],

packages/contentstack-branches/README.md

@@ -145,7 +145,7 @@ USAGE
   $ csdx cm:branches:diff [--base-branch <value>] [--compare-branch <value>] [-k <value>][--module <value>]
 
 FLAGS
-  -k, --stack-api-key=<value>  [optional] Provide the Stack API key to show the difference between branches.
+  -k, --stack-api-key=<value>  [optional] Provide the stack API key to show the difference between branches.
   --base-branch=<value>        [optional] Base branch (Target branch).
   --compare-branch=<value>     [optional] Compare branch (Source branch).
   --format=<option>            [default: compact-text] [default: compact-text] [optional] Type of flags to show the

packages/contentstack-branches/src/commands/cm/branches/diff.ts

@@ -37,7 +37,7 @@ export default class BranchDiffCommand extends Command {
     }),
     'stack-api-key': flags.string({
       char: 'k',
-      description: '[optional] Provide the Stack API key to show the difference between branches.',
+      description: '[optional] Provide the stack API key to show the difference between branches.',
     }),
     format: flags.string({
       default: 'compact-text',

packages/contentstack-bulk-publish/README.md

@@ -470,7 +470,7 @@ FLAGS
                                selected)
   -a, --alias=<value>          Alias(name) for the management token
   -c, --config=<value>         Path to the config file
-  -k, --stack-api-key=<value>  Stack api key to be used
+  -k, --stack-api-key=<value>  Stack API key to be used
   -y, --yes                    Agree to process the command with the current configuration
   --api-version=<value>        API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
   --bulk-publish=<value>       [default: true] Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by
@@ -856,7 +856,7 @@ FLAGS
   -a, --alias=<value>          Alias(name) for the management token
   -c, --config=<value>         Path to the config file
   -e, --environment=<value>    Source Environment
-  -k, --stack-api-key=<value>  Stack api key to be used
+  -k, --stack-api-key=<value>  Stack API key to be used
   -l, --locale=<value>         Locale filter
   -y, --yes                    Agree to process the command with the current configuration
   --api-version=<value>        API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
@@ -1705,7 +1705,7 @@ FLAGS
   -a, --alias=<value>          Alias(name) for the management token
   -c, --config=<value>         Path to the config file
   -e, --environment=<value>    Source Environment
-  -k, --stack-api-key=<value>  Stack api key to be used
+  -k, --stack-api-key=<value>  Stack API key to be used
   -l, --locale=<value>         Locale filter
   -y, --yes                    Agree to process the command with the current configuration
   --api-version=<value>        API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].

packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/cross-publish.js

@@ -174,7 +174,7 @@ CrossPublishCommand.flags = {
   alias: flags.string({ char: 'a', description: 'Alias(name) for the management token' }),
   'stack-api-key': flags.string({
     char: 'k',
-    description: 'Stack api key to be used',
+    description: 'Stack API key to be used',
     required: false,
   }),
   retryFailed: flags.string({

packages/contentstack-bulk-publish/src/commands/cm/stacks/unpublish.js

@@ -169,7 +169,7 @@ UnpublishCommand.flags = {
   }),
   'stack-api-key': flags.string({
     char: 'k',
-    description: 'Stack api key to be used',
+    description: 'Stack API key to be used',
   }),
   environment: flags.string({
     char: 'e',

packages/contentstack-clone/README.md

@@ -55,14 +55,14 @@ FLAGS
   -n, --stack-name=<value>                      Provide a name for the new stack to store the cloned content.
   -y, --yes                                     Force override all Marketplace prompts.
   --destination-management-token-alias=<value>  Destination management token alias.
-  --destination-stack-api-key=<value>           Destination stack API Key
-  --import-webhook-status=<option>              [default: disable] [Optional] The status of the import webhook.
-                                                <options: disable, current>
+  --destination-stack-api-key=<value>           Destination stack API key
+  --import-webhook-status=<option>              [default: disable] [default: disable] (optional) The status of the
+                                                import webhook. <options: disable|current>
                                                 <options: disable|current>
   --skip-audit                                  (optional) Skips the audit fix that occurs during an import operation.
   --source-branch=<value>                       Branch of the source stack.
   --source-management-token-alias=<value>       Source management token alias.
-  --source-stack-api-key=<value>                Source stack API Key
+  --source-stack-api-key=<value>                Source stack API key
   --target-branch=<value>                       Branch of the target stack.
   --type=<option>                               Type of data to clone. You can select option a or b.
                                                 a) Structure (all modules except entries & assets).
@@ -107,14 +107,14 @@ FLAGS
   -n, --stack-name=<value>                      Provide a name for the new stack to store the cloned content.
   -y, --yes                                     Force override all Marketplace prompts.
   --destination-management-token-alias=<value>  Destination management token alias.
-  --destination-stack-api-key=<value>           Destination stack API Key
-  --import-webhook-status=<option>              [default: disable] [Optional] The status of the import webhook.
-                                                <options: disable, current>
+  --destination-stack-api-key=<value>           Destination stack API key
+  --import-webhook-status=<option>              [default: disable] [default: disable] (optional) The status of the
+                                                import webhook. <options: disable|current>
                                                 <options: disable|current>
   --skip-audit                                  (optional) Skips the audit fix that occurs during an import operation.
   --source-branch=<value>                       Branch of the source stack.
   --source-management-token-alias=<value>       Source management token alias.
-  --source-stack-api-key=<value>                Source stack API Key
+  --source-stack-api-key=<value>                Source stack API key
   --target-branch=<value>                       Branch of the target stack.
   --type=<option>                               Type of data to clone. You can select option a or b.
                                                 a) Structure (all modules except entries & assets).

packages/contentstack-clone/src/commands/cm/stacks/clone.js

@@ -234,13 +234,13 @@ b) Structure with content (all modules including entries & assets).
     `,
   }),
   'source-stack-api-key': flags.string({
-    description: 'Source stack API Key',
+    description: 'Source stack API key',
   }),
   'destination-stack-api-key': flags.string({
-    description: 'Destination stack API Key',
+    description: 'Destination stack API key',
   }),
   'import-webhook-status': flags.string({
-    description: '[Optional] The status of the import webhook. <options: disable, current>',
+    description: '[default: disable] (optional) The status of the import webhook. <options: disable|current>',
     options: ['disable', 'current'],
     required: false,
     default: 'disable',

packages/contentstack-export-to-csv/src/commands/cm/export-to-csv.js

@@ -17,7 +17,7 @@ class ExportToCsvCommand extends Command {
       required: false,
       multiple: false,
       options: ['entries', 'users', 'teams', 'taxonomies'],
-      description: 'Option to export data (entries, users, teams, taxonomies). [options: entries|users|teams|taxonomies]',
+      description: 'Option to export data (entries, users, teams, taxonomies). <options: entries|users|teams|taxonomies>',
     }),
     alias: flags.string({
       char: 'a',
@@ -67,7 +67,7 @@ class ExportToCsvCommand extends Command {
       description: 'Provide the taxonomy UID of the related terms you want to export.',
     }),
     delimiter: flags.string({
-      description: '[default: ,] [optional] Provide a delimiter to separate individual data fields within the CSV file. For example: cm:export-to-csv --delimiter \'|\'',
+      description: '[optional] Provide a delimiter to separate individual data fields within the CSV file. For example: cm:export-to-csv --delimiter \'|\'',
       default: ',',
     }),
   };