Merge pull request #76 from eslam-gomaa/feat/document-new-kptop-custo…

…m-commands documenting dashboard data types > done
eslam-gomaa · Jul 1, 2024 · 78c7516 · 78c7516
2 parents 38a85e4 + 7131275
commit 78c7516
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/docs/dashboards/yaml_structure.md b/docs/dashboards/yaml_structure.md
@@ -207,7 +207,7 @@ visualization:
 | box<br />                  | `Boolean`     | The layout box to display the graph in,<br />*Example*: `right` , `right_a` , `left_b`                                                                                      | <br />                        | True     |
 | type                   |      | Graph data type - Options: [`asciiGraph`, `progressBarList`, `simpleTable`, `advancedTable`]                                                                                                    |                           | True     |
 | metricUnit             | `String`     | the metirc value unit - Options: [`None`, `byte`, `mb`, `gb`, `tb`, `seconds`, `percentage`]                                                                                        |                           |          |
-| custom_key             | `String`     | custom key for the metric result key, <br />*Example: *`🥕 '{{pod}}'`  would be translated to `🥕 POD-NAME` <br />                                                                   | Metric default result key |          |
+| custom_key             | `String`     | custom key for the metric result key, <br />*Example: *`🥕 {{\pod\}}`  would be translated to `🥕 POD-NAME` <br />                                                                   | Metric default result key |          |
 | asciiGraphOptions      | `Dict`     | Graph options with `asciiGraph` data type                                                                                                          |                           | False    |
 | progressBarListOptions | `Dict`     | Graph options with `progressBarList` data type                                                                                                          |                           | False    |
 | simpleTableOptions     | `Dict`     | Graph options with `simpleTable` data type                                                                                                          |                           | False    |

diff --git a/docs/index.md b/docs/index.md
@@ -253,7 +253,7 @@ kafka-test-cruise-control-ui-569ccc5897-zl987      ?                  ?
 
 ---
 
-Logging
+# Logging
 
 Default log file location is "`/tmp/kptop.log`"