mirrors/ceph-csi
1
0
Fork 0
mirror of https://github.com/ceph/ceph-csi.git synced 2025-06-13 10:33:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

cleanup: stick to standards when using dollar-sign in md

Browse Source 
MD014 - Dollar signs used before commands without showing output
The dollar signs are unnecessary, it is easier to copy and paste and
less noisy if the dollar signs are omitted. Especially when the
command doesn't list the output, but if the command follows output
we can use `$ ` (dollar+space) mainly to differentiate between
command and its ouput.

scenario 1: when command doesn't follow output
```console
cd ~/work
```

scenario 2: when command follow output (use dollar+space)
```console
$ ls ~/work
file1 file2 dir1 dir2 ...
```

Signed-off-by: Prasanna Kumar Kalever <prasanna.kalever@redhat.com>
This commit is contained in:
Prasanna Kumar Kalever
2020-11-11 12:52:54 +05:30
committed by mergify[bot]
parent fcaa332921
commit 2945f7b669
10 changed files with 159 additions and 104 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
charts/ceph-csi-cephfs/README.md
View File

@ -15,7 +15,7 @@ helm repo add ceph-csi https://ceph.github.io/csi-charts
we need to enter into the directory where all charts are present
```console
[$]cd charts
cd charts
```
**Note:** charts directory is present in root of the ceph-csi project

2
charts/ceph-csi-rbd/README.md
View File

@ -15,7 +15,7 @@ helm repo add ceph-csi https://ceph.github.io/csi-charts
we need to enter into the directory where all charts are present
```console
[$]cd charts
cd charts
```
**Note:** charts directory is present in root of the ceph-csi project