Skip to content

Commit 0c0308e

Browse files
Fix markdown lint issues
1 parent 44d36cd commit 0c0308e

7 files changed

+27
-21
lines changed

.markdownlintignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
vue/src/store/generated/readme.md

docs/advanced/running-genesis-node.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ The following components will be needed:
3939
1. Put `cosmovisor` binary to `/usr/bin/`, set proper owner and execution permissions.
4040

4141
2. Locate the genesis app version to genesis application version directory:
42-
* Create `$HOME/.dcl/cosmovisor/genesis/bin` directory.
43-
* Copy `dcld` binary to it, set proper owner and execution permissions.
42+
- Create `$HOME/.dcl/cosmovisor/genesis/bin` directory.
43+
- Copy `dcld` binary to it, set proper owner and execution permissions.
4444
Please note that execution permissions on `dcld` should be granted to all (i.e. User, Group and Others classes)
4545
because cosmovisor requires execution permission on the application binary to be granted to Others class.
4646

docs/advanced/running-observer-node.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ and contains the genesis and persistent_peers files.
4949
1. Put `cosmovisor` binary to `/usr/bin/`, set proper owner and execution permissions.
5050

5151
2. Locate the genesis app version to genesis application version directory:
52-
* Create `$HOME/.dcl/cosmovisor/genesis/bin` directory.
53-
* Copy `dcld` binary to it, set proper owner and execution permissions.
52+
- Create `$HOME/.dcl/cosmovisor/genesis/bin` directory.
53+
- Copy `dcld` binary to it, set proper owner and execution permissions.
5454
Please note that execution permissions on `dcld` should be granted to all (i.e. User, Group and Others classes)
5555
because cosmovisor requires execution permission on the application binary to be granted to Others class.
5656

docs/advanced/running-validator-node.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ and contains the genesis and persistent_peers files.
4949
1. Put `cosmovisor` binary to `/usr/bin/`, set proper owner and execution permissions.
5050

5151
2. Locate the genesis app version to genesis application version directory:
52-
* Create `$HOME/.dcl/cosmovisor/genesis/bin` directory.
53-
* Copy `dcld` binary to it, set proper owner and execution permissions.
52+
- Create `$HOME/.dcl/cosmovisor/genesis/bin` directory.
53+
- Copy `dcld` binary to it, set proper owner and execution permissions.
5454
Please note that execution permissions on `dcld` should be granted to all (i.e. User, Group and Others classes)
5555
because cosmovisor requires execution permission on the application binary to be granted to Others class.
5656

docs/advanced/switch-to-cosmovisor-how-to.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,16 @@ of the store.
2424
```bash
2525
su - <USERNAME>
2626
```
27-
where `<USERNAME>` is the corresponding user name
27+
28+
where `<USERNAME>` is the corresponding username
2829

2930
The command will ask for the user's password. Enter it.
3031
3132
2. Download new `dcld`, `cosmovisor` and `cosmovisor.service` from GitHub
3233
[release page](https://github.com/zigbee-alliance/distributed-compliance-ledger/releases). *(To ensure that no old `dcld` binary remains in the current direcory, try to remove it at first.)*
3334
3435
Example using curl:
36+
3537
```bash
3638
sudo rm -f ./dcld
3739
curl -L -O https://github.com/zigbee-alliance/distributed-compliance-ledger/releases/download/<release>/dcld
@@ -42,6 +44,7 @@ of the store.
4244
3. Download `switch_to_cosmovisor` script from [repository](../../deployment/scripts/)
4345
4446
Example using curl:
47+
4548
```bash
4649
curl -L -O https://raw.githubusercontent.com/zigbee-alliance/distributed-compliance-ledger/master/deployment/scripts/switch_to_cosmovisor
4750
```
@@ -70,6 +73,7 @@ of the store.
7073
```
7174
7275
When it is done, it will print:
73-
```
76+
77+
```bash
7478
Done
7579
```

docs/pool-upgrade-how-to.md

+13-12
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ application version:
2020
1. Calculates SHA-256 or SHA-512 checksums of the new application version
2121
binaries (for the supported platforms) taken from the project release.
2222
This can be done using `sha256sum` or `sha512sum` tool.
23-
23+
2424
For example:
2525

2626
```bash
@@ -31,7 +31,7 @@ application version:
3131
with the name of the new upgrade handler, the chosen ledger height and the
3232
info containing URLs of the new application version binaries for supported
3333
platforms with the calculated checksums.
34-
34+
3535
For example:
3636

3737
```bash
@@ -46,7 +46,7 @@ application version:
4646
1. Re-calculates checksums of the new application version binaries (for the
4747
supported platforms) taken from the project release. This can be done
4848
using `sha256sum` / `sha512sum` tool.
49-
49+
5050
For example:
5151

5252
```bash
@@ -55,7 +55,7 @@ application version:
5555

5656
2. Ensures that the re-calculated values are equal to the checksums specified
5757
in the proposed upgrade plan `Info` field.
58-
58+
5959
Example how to view the proposed upgrade plan:
6060

6161
```bash
@@ -71,7 +71,7 @@ application version:
7171

7272
5. Sends [`ApproveUpgrade`](./transactions.md#approve_upgrade) transaction
7373
with the name of the proposed upgrade.
74-
74+
7575
For example:
7676

7777
```bash
@@ -80,7 +80,7 @@ application version:
8080

8181
5. **[Anyone] Ensure That Upgrade Has Been Scheduled**: It makes sense to ensure
8282
that the upgrade has been approved and scheduled.
83-
83+
8484
Example how to view the approved upgrade plan:
8585

8686
```bash
@@ -104,13 +104,14 @@ application version:
104104
```bash
105105
su - <USERNAME>
106106
```
107-
where `<USERNAME>` is the corresponding user name
107+
108+
where `<USERNAME>` is the corresponding username
108109

109110
The command will ask for the user's password. Enter it.
110111
111112
2. Downloads the application binary from the URL specified in the upgrade
112113
plan `Info` field and corresponding to the node platform.
113-
114+
114115
Command to view the current scheduled upgrade plan:
115116
116117
```bash
@@ -122,7 +123,7 @@ application version:
122123
previous step by [`go-getter`](https://github.com/hashicorp/go-getter)
123124
download tool (its executable binaries for various platforms can be
124125
downloaded from <https://github.com/hashicorp/go-getter/releases>).
125-
126+
126127
For example:
127128
128129
```bash
@@ -138,7 +139,7 @@ application version:
138139
`$HOME/.dcl/cosmovisor/upgrades`, creates `bin` sub-directory within the
139140
created directory, and puts the new application binary into `bin`
140141
sub-directory.
141-
142+
142143
For example:
143144
144145
```bash
@@ -153,9 +154,9 @@ application version:
153154
```
154155
155156
5. Sets proper owner and permissions for the new application binary.
156-
157+
157158
For example:
158-
159+
159160
```bash
160161
sudo chown $(whoami) $HOME/.dcl/cosmovisor/upgrades/vX.X.X/bin/dcld
161162
sudo chmod a+x $HOME/.dcl/cosmovisor/upgrades/vX.X.X/bin/dcld

docs/running-node.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ need or just comment out the corresponding line and manually add
122122

123123
* put `cosmovisor` binary in a folder listed in `$PATH` (e.g. `/usr/bin/`)
124124
* set owner of `cosmovisor` binary to the user who will be used for `cosmovisor` service to run as
125-
* set executable permission on `cosmovisor` binary for owner
125+
* set executable permission on `cosmovisor` binary for owner
126126

127127
<!-- markdownlint-disable MD033 -->
128128
<details>

0 commit comments

Comments
 (0)