Fix markdown files styling issues

Commit contains fixes for various styling issues
found in all .md files.
Max line lenght configured to 120.

MD002 First header should be a top level header
MD013 Line length
MD022 Headers should be surrounded by blank lines
MD029 Ordered list item prefix
MD031 Fenced code blocks should be surrounded by blank lines
MD032 Lists should be surrounded by blank lines
MD034 Bare URL used
MD041 First line in file should be a top level header
MD047 File should end with a single newline character

Change-Id: Ieca2b4fdc28449fab31a1cb9afdde1e0644725b9
Signed-off-by: Karol Latecki <[email protected]>
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk-csi/+/7307
Reviewed-by: Yibo Cai <[email protected]>
Reviewed-by: Antti Kervinen <[email protected]>
Tested-by: SPDK CI Jenkins <[email protected]>
Reviewed-by: Kamil Godzwon <[email protected]>

Author: Karol Latecki

CONTRIBUTING.md

@@ -2,4 +2,4 @@
 
 Please see the [SPDK development guide](http://www.spdk.io/development/) for information on how to contribute to SPDK.
 
-The code repo for SPDK-CSI is https://review.spdk.io/spdk/spdk-csi.
+The code repo for SPDK-CSI is [https://review.spdk.io/spdk/spdk-csi](https://review.spdk.io/spdk/spdk-csi).

README.md

@@ -2,15 +2,19 @@
 
 ## About
 
-This repo contains SPDK CSI ([Container Storage Interface](https://github.com/container-storage-interface/)) plugin for Kubernetes.
+This repo contains SPDK CSI ([Container Storage Interface](https://github.com/container-storage-interface/))
+plugin for Kubernetes.
 
-SPDK CSI plugin brings SPDK to Kubernetes. It provisions SPDK logical volumes on storage node dynamically and enables Pods to access SPDK storage backend through NVMe-oF or iSCSI.
+SPDK CSI plugin brings SPDK to Kubernetes. It provisions SPDK logical volumes on storage node dynamically
+and enables Pods to access SPDK storage backend through NVMe-oF or iSCSI.
 
-Please see [SPDK CSI Design Document](https://docs.google.com/document/d/1aLi6SkNBp__wjG7YkrZu7DdhoftAquZiWiIOMy3hskY/) for detailed introduction.
+Please see [SPDK CSI Design Document](https://docs.google.com/document/d/1aLi6SkNBp__wjG7YkrZu7DdhoftAquZiWiIOMy3hskY/)
+for detailed introduction.
 
 ## Supported platforms
 
-This plugin conforms to [CSI Spec v1.6.0](https://github.com/container-storage-interface/spec/blob/v1.6.0/spec.md). It is currently developed and tested only on Kubernetes.
+This plugin conforms to [CSI Spec v1.6.0](https://github.com/container-storage-interface/spec/blob/v1.6.0/spec.md).
+It is currently developed and tested only on Kubernetes.
 
 This plugin supports `x86_64` and `Arm64` architectures.
 
@@ -29,25 +33,36 @@ Minimal requirement: Go 1.19+, Docker 18.03+ and Kubernetes 1.13+.
 ### Build
 
 - `$ make all`
+
 Build targets spdkcsi, lint, test.
 
 - `$ make spdkcsi`
+
 Build SPDK-CSI binary `_out/spdkcsi`.
 
 - `$ make lint`
+
 Lint code and scripts.
-  - `$ make golangci`
+
+- `$ make golangci`
+
 Install [golangci-lint](https://github.com/golangci/golangci-lint) and perform various go code static checks.
-  - `$ make yamllint`
+
+- `$ make yamllint`
+
 Lint yaml files if yamllint is installed. Requires yamllint 1.10+.
 
 - `$ make test`
-Verify go modules and run unit tests. Requires SPDK target and JsonRPC HTTP proxy running on localhost. See [deploy/spdk/README](deploy/spdk/README.md) for details.
+
+Verify go modules and run unit tests. Requires SPDK target and JsonRPC HTTP proxy running on localhost.
+See [deploy/spdk/README](deploy/spdk/README.md) for details.
 
 - `$ make e2e-test`
+
 Verify core features through Kubernetes end-to-end (e2e) test.
 
 - `$ make image`
+
 Build SPDK-CSI docker image.
 
 ### Parameters
@@ -81,8 +96,9 @@ Example deployment files can be found in deploy/kubernetes directory.
 ---
 **_NOTE:_**
 
-Below example is a simplest test system running in a single host or VM. No NVMe device is required, memory based bdev is used instead.
-[docs/multi-node.md](docs/multi-node.md) introduces how to deploy SPDKCSI on multiple nodes with NVMe devices.
+Below example is a simplest test system running in a single host or VM. No NVMe device is required, memory based bdev
+is used instead. [docs/multi-node.md](docs/multi-node.md) introduces how to deploy SPDKCSI on multiple nodes with NVMe
+devices.
 
 ---
 
@@ -92,104 +108,105 @@ Follow [deploy/spdk/README](deploy/spdk/README.md) to deploy SPDK storage servic
 
 ### Deploy SPDKCSI services
 
-1. Launch Minikube test cluster
+1. Launch Minikube test cluster.
   ```bash
-  $ cd scripts
-  $ sudo ./minikube.sh up
-
-  # Create kubectl shortcut (assume kubectl version 1.25.0)
-  $ sudo ln -s /var/lib/minikube/binaries/v1.25.0/kubectl /usr/local/bin/kubectl
-
-  # Wait for Kubernetes ready
-  $ kubectl get pods --all-namespaces
-  NAMESPACE     NAME                          READY   STATUS    RESTARTS   AGE
-  kube-system   coredns-6955765f44-dlb88      1/1     Running   0          81s
-  ......                                              ......
-  kube-system   kube-apiserver-spdkcsi-dev    1/1     Running   0          67s
-  ......                                              ......
+    $ cd scripts
+    $ sudo ./minikube.sh up
+
+    # Create kubectl shortcut (assume kubectl version 1.25.0)
+    $ sudo ln -s /var/lib/minikube/binaries/v1.25.0/kubectl /usr/local/bin/kubectl
+
+    # Wait for Kubernetes ready
+    $ kubectl get pods --all-namespaces
+    NAMESPACE     NAME                          READY   STATUS    RESTARTS   AGE
+    kube-system   coredns-6955765f44-dlb88      1/1     Running   0          81s
+    ......                                              ......
+    kube-system   kube-apiserver-spdkcsi-dev    1/1     Running   0          67s
+    ......                                              ......
   ```
 
 2. Install snapshot controller and CRD
+
   ```bash
-  SNAPSHOT_VERSION="v3.0.3" ./scripts/install-snapshot.sh install
+    SNAPSHOT_VERSION="v3.0.3" ./scripts/install-snapshot.sh install
 
-  # Check status
-  $ kubectl get pod snapshot-controller-0
-  NAME                    READY   STATUS    RESTARTS   AGE
-  snapshot-controller-0   1/1     Running   0          6m14s
+    # Check status
+    $ kubectl get pod snapshot-controller-0
+    NAME                    READY   STATUS    RESTARTS   AGE
+    snapshot-controller-0   1/1     Running   0          6m14s
   ```
 
 3. Deploy SPDK-CSI services
   ```bash
-  $ cd deploy/kubernetes
-  $ ./deploy.sh
-
-  # Check status
-  $ kubectl get pods
-  NAME                   READY   STATUS    RESTARTS   AGE
-  spdkcsi-controller-0   3/3     Running   0          3m16s
-  spdkcsi-node-lzvg5     2/2     Running   0          3m16s
+    $ cd deploy/kubernetes
+    $ ./deploy.sh
+
+    # Check status
+    $ kubectl get pods
+    NAME                   READY   STATUS    RESTARTS   AGE
+    spdkcsi-controller-0   3/3     Running   0          3m16s
+    spdkcsi-node-lzvg5     2/2     Running   0          3m16s
   ```
 
 4. Deploy test pod
   ```bash
-  $ cd deploy/kubernetes
-  $ kubectl apply -f testpod.yaml
+    $ cd deploy/kubernetes
+    $ kubectl apply -f testpod.yaml
 
-  # Check status
-  $ kubectl get pv
-  NAME                       CAPACITY   ...    STORAGECLASS   REASON   AGE
-  persistentvolume/pvc-...   256Mi      ...    spdkcsi-sc              43s
+    # Check status
+    $ kubectl get pv
+    NAME                       CAPACITY   ...    STORAGECLASS   REASON   AGE
+    persistentvolume/pvc-...   256Mi      ...    spdkcsi-sc              43s
 
-  $ kubectl get pvc
-  NAME                                ...   CAPACITY   ACCESS MODES   STORAGECLASS   AGE
-  persistentvolumeclaim/spdkcsi-pvc   ...   256Mi      RWO            spdkcsi-sc     44s
+    $ kubectl get pvc
+    NAME                                ...   CAPACITY   ACCESS MODES   STORAGECLASS   AGE
+    persistentvolumeclaim/spdkcsi-pvc   ...   256Mi      RWO            spdkcsi-sc     44s
 
-  $ kubectl get pods
-  NAME                   READY   STATUS    RESTARTS   AGE
-  spdkcsi-test           1/1     Running   0          1m31s
+    $ kubectl get pods
+    NAME                   READY   STATUS    RESTARTS   AGE
+    spdkcsi-test           1/1     Running   0          1m31s
 
-  # Check attached spdk volume in test pod
-  $ kubectl exec spdkcsi-test mount | grep spdkcsi
-  /dev/disk/by-id/nvme-..._spdkcsi-sn on /spdkvol type ext4 (rw,relatime)
+    # Check attached spdk volume in test pod
+    $ kubectl exec spdkcsi-test mount | grep spdkcsi
+    /dev/disk/by-id/nvme-..._spdkcsi-sn on /spdkvol type ext4 (rw,relatime)
   ```
 
 5. Deploy PVC snapshot
-```bash
-  # Create snapshot of the bound PVC
-  $ cd deploy/kubernetes
-  $ kubectl apply -f snapshot.yaml
-
-  # Get details about the snapshot
-  $ kubectl get volumesnapshot spdk-snapshot
-  NAME            READYTOUSE   SOURCEPVC   ... SNAPSHOTCLASS         AGE
-  spdk-snapshot   false        spdkcsi-pvc ... csi-spdk-snapclass    29s
-
-  # Get details about the volumesnapshotcontent
-  kubectl get volumesnapshotcontent
-  $ kubectl get volumesnapshotcontent
-  NAME        ...   READYTOUSE   RESTORESIZE   DELETIONPOLICY   DRIVER        VOLUMESNAPSHOTCLASS   VOLUMESNAPSHOT   AGE
-  snapcontent-...   true         268435456     Delete           csi.spdk.io   csi-spdk-snapclass    spdk-snapshot    29s
-```
+  ```bash
+    # Create snapshot of the bound PVC
+    $ cd deploy/kubernetes
+    $ kubectl apply -f snapshot.yaml
+
+    # Get details about the snapshot
+    $ kubectl get volumesnapshot spdk-snapshot
+    NAME            READYTOUSE   SOURCEPVC   ... SNAPSHOTCLASS         AGE
+    spdk-snapshot   false        spdkcsi-pvc ... csi-spdk-snapclass    29s
+
+    # Get details about the volumesnapshotcontent
+    kubectl get volumesnapshotcontent
+    $ kubectl get volumesnapshotcontent
+    NAME        ...   READYTOUSE   RESTORESIZE   DELETIONPOLICY   DRIVER        VOLUMESNAPSHOTCLASS   VOLUMESNAPSHOT   AGE
+    snapcontent-...   true         268435456     Delete           csi.spdk.io   csi-spdk-snapclass    spdk-snapshot    29s
+  ```
 
 ### Teardown
 
 1. Delete PVC snapshot
   ```bash
-  cd deploy/kubernetes
-  kubectl delete -f snapshot.yaml
+    cd deploy/kubernetes
+    kubectl delete -f snapshot.yaml
   ```
 
 2. Delete test pod
   ```bash
-  $ cd deploy/kubernetes
-  $ kubectl delete -f testpod.yaml
+    $ cd deploy/kubernetes
+    $ kubectl delete -f testpod.yaml
   ```
 
 3. Delete SPDK-CSI services
   ```bash
-  $ cd deploy/kubernetes
-  $ ./deploy.sh teardown
+    $ cd deploy/kubernetes
+    $ ./deploy.sh teardown
   ```
 
 4. Delete snapshot controller and CRD
@@ -199,8 +216,8 @@ Follow [deploy/spdk/README](deploy/spdk/README.md) to deploy SPDK storage servic
 
 5. Teardown Kubernetes test cluster
   ```bash
-  $ cd scripts
-  $ sudo ./minikube.sh clean
+    $ cd scripts
+    $ sudo ./minikube.sh clean
   ```
 
 ## Communication and Contribution

charts/spdk-csi/README.md

@@ -8,25 +8,26 @@ Follow this guide to install the SPDK-CSI Driver for Kubernetes.
 
 ### Build image
 
- ```console
- $ make image
- $ cd deploy/spdk
- $ sudo docker build -t spdkdev .
- ```
+```console
+make image
+cd deploy/spdk
+sudo docker build -t spdkdev .
+```
  **_NOTE:_**
-Kubernetes nodes must pre-allocate hugepages in order for the node to report its hugepage capacity. A node can pre-allocate huge pages for multiple sizes.
+Kubernetes nodes must pre-allocate hugepages in order for the node to report its hugepage capacity.
+A node can pre-allocate huge pages for multiple sizes.
 
 ## Install latest CSI Driver via `helm install`
 
 ```console
-$ cd charts
-$ helm install spdk-csi ./spdk-csi --namespace spdk-csi
+cd charts
+helm install spdk-csi ./spdk-csi --namespace spdk-csi
 ```
 
 ## After installation succeeds, you can get a status of Chart
 
 ```console
-$ helm status "spdk-csi"
+helm status "spdk-csi"
 ```
 
 ## Delete Chart

deploy/spdk/README.md

@@ -1,8 +1,9 @@
-### About
+# About
 
-To test SPDKCSI, we need a working SPDK environment. This document explains how to launch SPDK and JsonRPC HTTP proxy on localhost for function tests.
+To test SPDKCSI, we need a working SPDK environment. This document explains how to launch SPDK and JsonRPC HTTP proxy
+on localhost for function tests.
 
-### Step by step
+## Step by step
 
 ```bash
 # build spdk container image
@@ -13,7 +14,8 @@ sudo docker build -t spdkdev .
 sudo sh -c 'echo 1024 > /proc/sys/vm/nr_hugepages'
 
 # start spdk target
-sudo docker run -it --rm --name spdkdev --privileged --net host -v /dev/hugepages:/dev/hugepages -v /dev/shm:/dev/shm spdkdev /root/spdk/build/bin/spdk_tgt
+sudo docker run -it --rm --name spdkdev --privileged --net host \
+-v /dev/hugepages:/dev/hugepages -v /dev/shm:/dev/shm spdkdev /root/spdk/build/bin/spdk_tgt
 # run below commands in another console
 
 # create 1G malloc bdev
@@ -26,7 +28,7 @@ sudo docker exec -it spdkdev /root/spdk/scripts/rpc.py bdev_lvol_create_lvstore
 sudo docker exec -it spdkdev /root/spdk/scripts/rpc_http_proxy.py 127.0.0.1 9009 spdkcsiuser spdkcsipass
 ```
 
-### Single command
+## Single command
 
 Combine above steps to a single command can be convenient. But it's harder to debug if error happens.