enhance docs (#96)

instana · Aug 1, 2024 · d2cbe6e · d2cbe6e
1 parent e38d964
commit d2cbe6e
Show file tree

Hide file tree

Showing 15 changed files with 35 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -44,7 +44,7 @@ pip3 install --upgrade synctl==<version>
 
 **Incompatible Options:**
 - Option `--from-json` removed: Use the `-f, --from-file` option instead. The `-f, --from-file` option reads synthetic test payload from `.json` files.
-- Option `--bundle-entry-file` replaces `entry-file`: `--bundle-entry-file` option is now used to set entry file name of a bundle test.
+- Option `--bundle-entry-file` replaces `--entry-file`: `--bundle-entry-file` option is now used to set entry file name of a bundle test.
 - Option `--script` added: `--script` options reads different files according to their suffix, such as `.js`and `.side`.
 # Configuration
 
@@ -103,7 +103,6 @@ Usage: synctl [--verify-tls] <command> [options]
 Options:
   -h, --help            show this help message and exit
   --version, -v         show version
-  --verify-tls          verify tls certificate
 
 Commands:
     config              manage configuration file
@@ -140,7 +139,7 @@ Synthetic smart alert management:
 - [synctl update alert](docs/synctl-update-alert.md) - Update properties of Smart Alert.
 - [synctl delete alert](docs/synctl-delete-alert.md) - Delete smart alert.
 
-Synthetic credentials management:
+Synthetic credential management:
 - [synctl get/create/update/delete cred](docs/synctl-credential.md) - Manage credentials.
 
 Others:

diff --git a/docs/synctl-create-alert.md b/docs/synctl-create-alert.md
@@ -10,6 +10,7 @@ synctl create alert [options]
 ## Options
 ```
     -h, --help                        show this help message and exit
+    --verify-tls                      verify tls certificate
 
     --test id [id ...]                Synthetic test id, support multiple Synthetic tests id
     --name <string>                   friendly name of the Smart Alerts

diff --git a/docs/synctl-create-test.md b/docs/synctl-create-test.md
@@ -11,6 +11,8 @@ synctl create test [options]
 ### Common options
 ```
     -h, --help                          show this help message and exit
+    --verify-tls                        verify tls certificate
+
 
     -t <int>, --type <int>              Synthetic type: 0 API Simple, 1 API Script, 2 Browser Script, 3 Webpage Script, 4 Webpage Simple, 5 SSLCertificate
     --location id [id ...]              location id, support multiple locations id

diff --git a/docs/synctl-credential.md b/docs/synctl-credential.md
@@ -1,5 +1,12 @@
 # Manage Credentials
 
+Manage Synthetic credentials.
+
+## Options
+```
+    -h, --help            show this help message and exit
+    --verify-tls          verify tls certificate
+```
 ### Display all credentials
 ```
 synctl get cred

diff --git a/docs/synctl-delete-alert.md b/docs/synctl-delete-alert.md
@@ -6,6 +6,11 @@ Delete Synthetic smart alert.
 ```
 synctl delete alert [id...] 
 ```
+## Options
+```
+    -h, --help            show this help message and exit
+    --verify-tls          verify tls certificate
+```
 
 ## Examples
 

diff --git a/docs/synctl-delete-loc.md b/docs/synctl-delete-loc.md
@@ -6,6 +6,11 @@ Delete Synthetic location.
 ```
 synctl delete location <location-id>
 ```
+## Options
+```
+    -h, --help            show this help message and exit
+    --verify-tls          verify tls certificate
+```
 
 ## Examples
 

diff --git a/docs/synctl-delete-test.md b/docs/synctl-delete-test.md
@@ -10,6 +10,7 @@ synctl delete test [id...] [options]
 ## Options
 ``` 
     -h, --help            show this help message and exit
+    --verify-tls          verify tls certificate
 
     --match-regex <regex> use a regex to match synthetic label
     --match-location <id> delete tests match this location id

diff --git a/docs/synctl-get-alert.md b/docs/synctl-get-alert.md
@@ -11,6 +11,8 @@ synctl get alert [id] [options]
 ## Options
 ```
     -h, --help             show this help message and exit
+    --verify-tls           verify tls certificate
+    
     --show-details         output alert details to terminal
     --show-json            output alert json to terminal
 

diff --git a/docs/synctl-get-app.md b/docs/synctl-get-app.md
@@ -14,6 +14,8 @@ commands:
 
 options:
   -h, --help            show this help message and exit
+  --verify-tls           verify tls certificate
+  
   --name-filter <app>   filter application by name
 ```
 

diff --git a/docs/synctl-get-loc.md b/docs/synctl-get-loc.md
@@ -10,6 +10,7 @@ synctl get location|lo [id] [options]
 ## Options
 ```
     -h, --help            show this help message and exit
+    --verify-tls          verify tls certificate
 
     --show-details        output location details to console
 ```

diff --git a/docs/synctl-get-result.md b/docs/synctl-get-result.md
@@ -9,9 +9,12 @@ synctl get result [id] [options]
 ## Options
 ```
     -h, --help               show this help message and exit
+    --verify-tls             verify tls certificate
+
     --test                   Synthetic test id
     --window-size <window>   set synthetic result window size, support [1,60]m, [1-24]h
     --har                    save HAR to local
+
     --use-env, -e <name>     use a specified config
     --host <host>            set hostname
     --token <token>          set token

diff --git a/docs/synctl-get-test.md b/docs/synctl-get-test.md
@@ -9,6 +9,7 @@ synctl get test [id] [options]
 ## Options
 ```
     -h, --help              show this help message and exit
+    --verify-tls            verify tls certificate
 
     --type, -t <int>        Synthetic type, 0 HTTPAction, 1 HTTPScript, 2 BrowserScript, 3 WebpageScript, 4 WebpageAction, 5 SSLCertificate
     --window-size <window>  set synthetic result window size, support [1,60]m, [1-24]h

diff --git a/docs/synctl-patch-test.md b/docs/synctl-patch-test.md
@@ -11,6 +11,7 @@ synctl patch test id [options]
 ### Common options
 ```
     -h, --help                         show this help message and exit
+    --verify-tls                       verify tls certificate
 
     --active <boolean>                 set active
     --frequency <int>                  set frequency

diff --git a/docs/synctl-update-alert.md b/docs/synctl-update-alert.md
@@ -8,6 +8,7 @@ synctl update alert <id> [options]
 ## Options
 ```
     -h, --help                          show this help message and exit
+    --verify-tls                        verify tls certificate
 
     --from-file,-f <file-name>          json payload
     --test id [id ...]                  synthetic-test id, support multiple synthetic tests id

diff --git a/docs/synctl-update-test.md b/docs/synctl-update-test.md
@@ -12,6 +12,7 @@ synctl update test <id> [options]
 ### Common options
 ```
     -h, --help                         show this help message and exit
+    --verify-tls                       verify tls certificate
 
     --active <boolean>                 set active
     --frequency <int>                  set frequency