Merge pull request #65 from eslam-gomaa/feat/document-new-kptop-funct…

…ionalities refactor KPtop docs
eslam-gomaa · Jun 30, 2024 · c8cfd12 · c8cfd12
2 parents 32ee661 + a01c376
commit c8cfd12
Show file tree

Hide file tree

Showing 16 changed files with 6 additions and 5 deletions.
diff --git a/docs/images/avoid-idle-consumers.png b/docs/images/avoid-idle-consumers.png
diff --git a/docs/images/choose-number-of-partitions.png b/docs/images/choose-number-of-partitions.png
diff --git a/docs/images/consume-sample-code.png b/docs/images/consume-sample-code.png
diff --git a/docs/images/consumer-client-id.png b/docs/images/consumer-client-id.png
diff --git a/docs/images/consumer-group-rebalancing.png b/docs/images/consumer-group-rebalancing.png
diff --git a/docs/images/dashboard-pods.png b/docs/images/dashboard-pods.png
diff --git a/docs/images/dashboard-pvcs.png b/docs/images/dashboard-pvcs.png
diff --git a/docs/images/g-sheet.png b/docs/images/g-sheet.png
diff --git a/docs/images/migration-1.png b/docs/images/migration-1.png
diff --git a/docs/images/migration-2.png b/docs/images/migration-2.png
diff --git a/docs/images/migration-3.png b/docs/images/migration-3.png
diff --git a/docs/images/mm2.png b/docs/images/mm2.png
diff --git a/docs/images/partitions-assignment-process.png b/docs/images/partitions-assignment-process.png
diff --git a/docs/images/scale-consumers.png b/docs/images/scale-consumers.png
diff --git a/docs/images/sync-with-prune.png b/docs/images/sync-with-prune.png
diff --git a/docs/index.md b/docs/index.md
@@ -13,9 +13,10 @@ kramdown:
   syntax_highlighter: coderay
 ---
 
-# Kube-Prometheus-Top [ kptop ]
+# Kube-Prometheus-Top [ KPtop ]
 {: .fs-9 }
 
+<br>
 
 A Python tool that offers beautiful CLI monitoring based on Prometheus metrics, with Kubernetes integration through PodPortForward
 
@@ -38,7 +39,7 @@ Prometheus is widely used with different kinds of metrics - Let's make CLI monit
 
 | ENV | Description                                                                          | Default | Required |
 | ----- | -------------------------------------------------------------------------------------- | --------- | ---------- |
-| `KPTOP_CONNECTION_METHOD`    | The way to connect to Prometheus server<br />**options:** ['prometheus_endpoint', 'pod_portForward'] | <br />      | Yes      |
+| `KPTOP_CONNECTION_METHOD`    | The way to connect to Prometheus server<br />**options:** ['`prometheus_endpoint`', '`pod_portForward`'] | <br />      | Yes      |
 
 There are 2 options to connect KPtop to Prometheus:
 1. With a Prometheus server endpoint
@@ -47,7 +48,7 @@ There are 2 options to connect KPtop to Prometheus:
     - Suitable if Prometheus is Not exposed (Only rechable with K8s cluster access)
 
 
-#### `prometheus_endpoint` ENVs
+### `prometheus_endpoint` ENVs
 
 | ENV | Description                                                     | Default | Required |
 | ----- | ----------------------------------------------------------------- | --------- | ---------- |
@@ -60,7 +61,7 @@ There are 2 options to connect KPtop to Prometheus:
 
 <br>
 
-#### `pod_portForward` ENVs
+### `pod_portForward` ENVs
 
 | ENV | Description                                            | Default | Required |
 | ----- | -------------------------------------------------------- | --------- | ---------- |
@@ -72,7 +73,7 @@ There are 2 options to connect KPtop to Prometheus:
 
 <br>
 
-#### General ENVs
+### General ENVs
 
 | ENV                                  | Description                                                  | Default               | Required |
 | ------------------------------------ | ------------------------------------------------------------ | --------------------- | -------- |