From 77d2025a5ac97247ce45cd060539bfc92774ac68 Mon Sep 17 00:00:00 2001
From: PaulJacobs-percona
 <63049452+PaulJacobs-percona@users.noreply.github.com>
Date: Thu, 7 Jan 2021 09:20:12 +0300
Subject: [PATCH] Update README.md

Formatting, spelling
---
 src/go/pt-k8s-debug-collector/README.md | 77 ++++++++++++++-----------
 1 file changed, 42 insertions(+), 35 deletions(-)

diff --git a/src/go/pt-k8s-debug-collector/README.md b/src/go/pt-k8s-debug-collector/README.md
index 508229e7..d39d8daf 100644
--- a/src/go/pt-k8s-debug-collector/README.md
+++ b/src/go/pt-k8s-debug-collector/README.md
@@ -1,44 +1,51 @@
 # Debug collector tool
 
-Collects debug data (logs, resource statuses etc.) from a k8s/opeshift cluster. Data packed into "cluster-dump.tar.gz" archive in the current working directory. 
+Collects debug data (logs, resource statuses etc.) from a k8s/OpenShift cluster. Data is packed into the `cluster-dump.tar.gz` archive in the current working directory. 
 
-### Data that will be collected
-        "pods",
-		"replicasets",
-		"deployments",
-		"statefulsets",
-		"replicationcontrollers",
-		"events",
-		"configmaps",
-		"secrets",
-		"cronjobs",
-		"jobs",
-		"podsecuritypolicies",
-		"poddisruptionbudgets",
-		"perconaxtradbbackups",
-		"perconaxtradbclusterbackups",
-		"perconaxtradbclusterrestores",
-		"perconaxtradbclusters",
-		"clusterrolebindings",
-		"clusterroles",
-		"rolebindings",
-		"roles",
-		"storageclasses",
-		"persistentvolumeclaims",
-		"persistentvolumes",
-        "modes",
-        "your-custom-resource" (depend on 'resource'  flag)
+## Data that will be collected
 
+```
+"pods",
+"replicasets",
+"deployments",
+"statefulsets",
+"replicationcontrollers",
+"events",
+"configmaps",
+"secrets",
+"cronjobs",
+"jobs",
+"podsecuritypolicies",
+"poddisruptionbudgets",
+"perconaxtradbbackups",
+"perconaxtradbclusterbackups",
+"perconaxtradbclusterrestores",
+"perconaxtradbclusters",
+"clusterrolebindings",
+"clusterroles",
+"rolebindings",
+"roles",
+"storageclasses",
+"persistentvolumeclaims",
+"persistentvolumes",
+"modes",
+"your-custom-resource" (depends on 'resource' flag)
+
+## Usage 
 
-### Usage 
 `pt-k8s-debug-collector <flags>`
+
 Flags:
-    `--resource` targeted custom resource name (default "pxc")
-    `--namespace` targeted namespace. By default data will be collected from all namespaces
-    `--cluster` targeted pxc/psmdb cluster. By default data from all available clusters to be collected 
 
-### Requirements
-Installed and configured 'kubectl'
-Installed and configured 'pt-mysql-summary'
-Installed and configured 'pt-mongodb-summary' 
+`--resource` targeted custom resource name (default "pxc")
+
+`--namespace` targeted namespace. By default data will be collected from all namespaces
+
+`--cluster` targeted pxc/psmdb cluster. By default data from all available clusters to be collected 
+
+## Requirements
+
+- Installed and configured 'kubectl'
+- Installed and configured 'pt-mysql-summary'
+- Installed and configured 'pt-mongodb-summary'