update command description

RasaHQ · Jun 20, 2023 · 18b0469 · 18b0469
1 parent 75fac49
commit 18b0469
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 14 deletions.
diff --git a/docs/docs/command-line-interface.mdx b/docs/docs/command-line-interface.mdx
@@ -662,28 +662,50 @@ Python Logging Options:
   --quiet               Be quiet! Sets logging level to WARNING. (default: None)
 ```
 
-## rasa marker upload
+## rasa markers upload
 
 This command is only relevant for Rasa Pro users with an Analytics Data Pipeline.
 It applies to [markers](./markers.mdx) and their [real-time processing](./monitoring/analytics/realtime-markers.mdx).
 Running this command validates the marker configuration file against the domain file and uploads the configuration to Analytics Data Pipeline
 
 ```
-usage: rasa markers upload [-h] [--config CONFIG]
+usage: rasa markers upload [-h] [-v] [-vv] [--quiet]
+                           [--logging-config-file LOGGING_CONFIG_FILE]
+                           [--config CONFIG]
                            [--rasa-pro-services-url RASA_PRO_SERVICES_URL]
-                           -d DOMAIN
+                           [-d DOMAIN]
 
-This command uploads Markers to the Rasa Pro Services for real-time analysis and insights generation.
-
-Optional Arguments:
-  -h, --help            Show this help message and exit.
-  --config CONFIG       Path to the marker configuration file(s) containing marker definitions. This can be a single YAML file or a directory that contains multiple files with marker definitions. The content of these files will be read and merged together. (default: markers.yml)
+optional arguments:
+  -h, --help            show this help message and exit
+  --config CONFIG       The marker configuration file(s) containing marker
+                        definitions. This can be a single YAML file, or a
+                        directory that contains several files with marker
+                        definitions in it. The content of these files will be
+                        read and merged together. (default: markers.yml)
   --rasa-pro-services-url RASA_PRO_SERVICES_URL
-                        The URL of the Rasa Pro Services instance to upload markers to. The specified URL should not contain a trailing slash.
-
-Required Arguments:
+                        The URL of the Rasa Pro Services instance to upload
+                        markers to.Specified URL should not contain a trailing
+                        slash. (default: )
   -d DOMAIN, --domain DOMAIN
-                        Path to the Rasa domain file.
+                        Domain specification. This can be a single YAML file,
+                        or a directory that contains several files with domain
+                        specifications in it. The content of these files will
+                        be read and merged together. (default: domain.yml)
+
+Python Logging Options:
+  You can control level of log messages printed. In addition to these
+  arguments, a more fine grained configuration can be achieved with
+  environment variables. See online documentation for more info.
+
+  -v, --verbose         Be verbose. Sets logging level to INFO. (default:
+                        None)
+  -vv, --debug          Print lots of debugging statements. Sets logging level
+                        to DEBUG. (default: None)
+  --quiet               Be quiet! Sets logging level to WARNING. (default:
+                        None)
+  --logging-config-file LOGGING_CONFIG_FILE
+                        If set, the name of the logging configuration file
+                        will be set to the given name. (default: None)
 
 Description:
   The `rasa markers upload` command allows you to upload Markers to the Rasa Pro Services. Markers are custom conversational events that provide additional context for analysis and insights generation. By uploading Markers, you can enable real-time analysis and enhance the performance of your Rasa Assistant.

diff --git a/docs/docs/monitoring/analytics/realtime-markers.mdx b/docs/docs/monitoring/analytics/realtime-markers.mdx
@@ -36,14 +36,14 @@ for details about defining Markers.
 ## Enable Real-time Processing
 
 To enable real-time analysis of Markers in your Rasa project, you need to
-upload the markers to Analytics Data Pipeline with the `rasa marker upload`
+upload the markers to Analytics Data Pipeline with the `rasa markers upload`
 command. This command uploads the marker configuration YAML and starts the
 processing of Markers in the Analytics Data Pipeline. To get started,
 make sure you have the latest version of Rasa installed. Then, open your command line
 interface and navigate to your Rasa project directory. Run the following command:
 
 ```
-rasa marker upload --config=<path-to-config-file> -d=<path-to-domain-file> -rasa-pro-services-url=<url>
+rasa markers upload --config=<path-to-config-file> -d=<path-to-domain-file> -rasa-pro-services-url=<url>
 ```
 
 By default, this command validates the marker configuration file against