Doc: Updated doc reviewed UI texts

contentstack · Nov 21, 2023 · e31cf15 · e31cf15
1 parent 8ed35fb
commit e31cf15
Show file tree

Hide file tree

Showing 4 changed files with 52 additions and 52 deletions.
diff --git a/packages/contentstack-audit/README.md b/packages/contentstack-audit/README.md
@@ -65,11 +65,11 @@ COMMON FLAGS
   -d, --data-dir=<value>  Path where the data is stored
 
 TABLE FLAGS
-  --columns=<value>  do not truncate output to fit screen
-  --csv              output is csv format [alias: --output=csv]
-  --filter=<value>   filter property by partial string matching, ex: name=foo
-  --no-truncate      do not truncate output to fit screen
-  --sort=<value>     property to sort by (prepend '-' for descending)
+  --columns=<value>  Show only the specified columns (comma-separated)
+  --csv              The output is in the CSV format [alias: --output=csv]
+  --filter=<value>   Filter property by partial string matching. For example: name=foo
+  --no-truncate      The output is not truncated to fit the screen
+  --sort=<value>     Property to sort by (prepend '-' for descending)
 
 DESCRIPTION
   Perform audits and find possible errors in the exported Contentstack data
@@ -115,11 +115,11 @@ COMMON FLAGS
   -d, --data-dir=<value>  Path where the data is stored
 
 TABLE FLAGS
-  --columns=<value>  do not truncate output to fit screen
-  --csv              output is csv format [alias: --output=csv]
-  --filter=<value>   filter property by partial string matching, ex: name=foo
-  --no-truncate      do not truncate output to fit screen
-  --sort=<value>     property to sort by (prepend '-' for descending)
+  --columns=<value>  Show only the specified columns (comma-separated)
+  --csv              The output is in the CSV format [alias: --output=csv]
+  --filter=<value>   Filter property by partial string matching. For example: name=foo
+  --no-truncate      The output is not truncated to fit the screen
+  --sort=<value>     Property to sort by (prepend '-' for descending)
 
 DESCRIPTION
   Perform audits and fix possible errors in the exported Contentstack data.
@@ -162,11 +162,11 @@ COMMON FLAGS
   -d, --data-dir=<value>  Path where the data is stored
 
 TABLE FLAGS
-  --columns=<value>  do not truncate output to fit screen
-  --csv              output is csv format [alias: --output=csv]
-  --filter=<value>   filter property by partial string matching, ex: name=foo
-  --no-truncate      do not truncate output to fit screen
-  --sort=<value>     property to sort by (prepend '-' for descending)
+  --columns=<value>  Show only the specified columns (comma-separated)
+  --csv              The output is in the CSV format [alias: --output=csv]
+  --filter=<value>   Filter property by partial string matching. For example: name=foo
+  --no-truncate      The output is not truncated to fit the screen
+  --sort=<value>     Property to sort by (prepend '-' for descending)
 
 DESCRIPTION
   Perform audits and find possible errors in the exported Contentstack data
@@ -214,11 +214,11 @@ COMMON FLAGS
   -d, --data-dir=<value>  Path where the data is stored
 
 TABLE FLAGS
-  --columns=<value>  do not truncate output to fit screen
-  --csv              output is csv format [alias: --output=csv]
-  --filter=<value>   filter property by partial string matching, ex: name=foo
-  --no-truncate      do not truncate output to fit screen
-  --sort=<value>     property to sort by (prepend '-' for descending)
+  --columns=<value>  Show only the specified columns (comma-separated)
+  --csv              The output is in the CSV format [alias: --output=csv]
+  --filter=<value>   Filter property by partial string matching. For example: name=foo
+  --no-truncate      The output is not truncated to fit the screen
+  --sort=<value>     Property to sort by (prepend '-' for descending)
 
 DESCRIPTION
   Perform audits and fix possible errors in the exported Contentstack data.

diff --git a/packages/contentstack-audit/src/messages/index.ts b/packages/contentstack-audit/src/messages/index.ts
@@ -1,11 +1,11 @@
 const errors = {};
 
 const tableColumnDescriptions = {
-  TABLE_COLUMN: 'only show provided columns (comma-separated)',
-  TABLE_SORT: "property to sort by (prepend '-' for descending)",
-  TABLE_CSV: 'output is csv format [alias: --output=csv]',
-  TABLE_FILTER: 'filter property by partial string matching, ex: name=foo',
-  'TABLE_NO-TRUNCATE': 'do not truncate output to fit screen',
+  TABLE_COLUMNS: 'Show only the specified columns (comma-separated)',
+  TABLE_SORT: "Property to sort by (prepend '-' for descending)",
+  TABLE_CSV: 'The output is in the CSV format [alias: --output=csv]',
+  TABLE_FILTER: 'Filter property by partial string matching. For example: name=foo',
+  'TABLE_NO-TRUNCATE': 'The output is not truncated to fit the screen',
 };
 
 const commonMsg = {

diff --git a/packages/contentstack-audit/src/util/flags.ts b/packages/contentstack-audit/src/util/flags.ts
@@ -22,7 +22,7 @@ function getTableFlags(
     flags[element].helpGroup = 'TABLE';
 
     const descriptionKey = `TABLE_${element.toUpperCase()}` as keyof typeof tableColumnDescriptions;
-    flags.columns.description = tableColumnDescriptions[descriptionKey] ?? flags.columns.description;
+    flags[element].description = tableColumnDescriptions[descriptionKey] ?? flags[element].description;
   });
 
   return flags;

diff --git a/packages/contentstack/README.md b/packages/contentstack/README.md
@@ -129,11 +129,11 @@ COMMON FLAGS
   -d, --data-dir=<value>  Path where the data is stored
 
 TABLE FLAGS
-  --columns=<value>  do not truncate output to fit screen
-  --csv              output is csv format [alias: --output=csv]
-  --filter=<value>   filter property by partial string matching, ex: name=foo
-  --no-truncate      do not truncate output to fit screen
-  --sort=<value>     property to sort by (prepend '-' for descending)
+  --columns=<value>  Show only the specified columns (comma-separated)
+  --csv              The output is in the CSV format [alias: --output=csv]
+  --filter=<value>   Filter property by partial string matching. For example: name=foo
+  --no-truncate      The output is not truncated to fit the screen
+  --sort=<value>     Property to sort by (prepend '-' for descending)
 
 DESCRIPTION
   Perform audits and find possible errors in the exported Contentstack data
@@ -179,11 +179,11 @@ COMMON FLAGS
   -d, --data-dir=<value>  Path where the data is stored
 
 TABLE FLAGS
-  --columns=<value>  do not truncate output to fit screen
-  --csv              output is csv format [alias: --output=csv]
-  --filter=<value>   filter property by partial string matching, ex: name=foo
-  --no-truncate      do not truncate output to fit screen
-  --sort=<value>     property to sort by (prepend '-' for descending)
+  --columns=<value>  Show only the specified columns (comma-separated)
+  --csv              The output is in the CSV format [alias: --output=csv]
+  --filter=<value>   Filter property by partial string matching. For example: name=foo
+  --no-truncate      The output is not truncated to fit the screen
+  --sort=<value>     Property to sort by (prepend '-' for descending)
 
 DESCRIPTION
   Perform audits and fix possible errors in the exported Contentstack data.
@@ -2380,11 +2380,11 @@ COMMON FLAGS
   -d, --data-dir=<value>  Path where the data is stored
 
 TABLE FLAGS
-  --columns=<value>  do not truncate output to fit screen
-  --csv              output is csv format [alias: --output=csv]
-  --filter=<value>   filter property by partial string matching, ex: name=foo
-  --no-truncate      do not truncate output to fit screen
-  --sort=<value>     property to sort by (prepend '-' for descending)
+  --columns=<value>  Show only the specified columns (comma-separated)
+  --csv              The output is in the CSV format [alias: --output=csv]
+  --filter=<value>   Filter property by partial string matching. For example: name=foo
+  --no-truncate      The output is not truncated to fit the screen
+  --sort=<value>     Property to sort by (prepend '-' for descending)
 
 DESCRIPTION
   Perform audits and find possible errors in the exported Contentstack data
@@ -2432,11 +2432,11 @@ COMMON FLAGS
   -d, --data-dir=<value>  Path where the data is stored
 
 TABLE FLAGS
-  --columns=<value>  do not truncate output to fit screen
-  --csv              output is csv format [alias: --output=csv]
-  --filter=<value>   filter property by partial string matching, ex: name=foo
-  --no-truncate      do not truncate output to fit screen
-  --sort=<value>     property to sort by (prepend '-' for descending)
+  --columns=<value>  Show only the specified columns (comma-separated)
+  --csv              The output is in the CSV format [alias: --output=csv]
+  --filter=<value>   Filter property by partial string matching. For example: name=foo
+  --no-truncate      The output is not truncated to fit the screen
+  --sort=<value>     Property to sort by (prepend '-' for descending)
 
 DESCRIPTION
   Perform audits and fix possible errors in the exported Contentstack data.
@@ -3363,7 +3363,7 @@ EXAMPLES
   $ csdx plugins
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.8.4/src/commands/plugins/index.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.3.2/src/commands/plugins/index.ts)_
 
 ## `csdx plugins:install PLUGIN...`
 
@@ -3428,7 +3428,7 @@ EXAMPLES
   $ csdx plugins:inspect myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.8.4/src/commands/plugins/inspect.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.3.2/src/commands/plugins/inspect.ts)_
 
 ## `csdx plugins:install PLUGIN...`
 
@@ -3468,7 +3468,7 @@ EXAMPLES
   $ csdx plugins:install someuser/someplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.8.4/src/commands/plugins/install.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.3.2/src/commands/plugins/install.ts)_
 
 ## `csdx plugins:link PLUGIN`
 
@@ -3497,7 +3497,7 @@ EXAMPLES
   $ csdx plugins:link myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.8.4/src/commands/plugins/link.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.3.2/src/commands/plugins/link.ts)_
 
 ## `csdx plugins:uninstall PLUGIN...`
 
@@ -3545,7 +3545,7 @@ ALIASES
   $ csdx plugins:remove
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.8.4/src/commands/plugins/uninstall.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.3.2/src/commands/plugins/uninstall.ts)_
 
 ## `csdx plugins:uninstall PLUGIN...`
 
@@ -3586,7 +3586,7 @@ DESCRIPTION
   Update installed plugins.
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.8.4/src/commands/plugins/update.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.3.2/src/commands/plugins/update.ts)_
 
 ## `csdx tokens`