Fix markdown lint issues

Author: electrocucaracha

.markdown-lint.yml

@@ -0,0 +1,19 @@
+---
+# Copyright 2022 Samsung Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+default: true
+
+# MD013/line-length - Line length
+MD013: false

README-DEV.md

@@ -4,34 +4,42 @@ Please note, that the only officially supported platform now is Linux.
 It's recommended to develop and deploy the App on Ubuntu 18.04 or Ubuntu 20.04.
 
 ## Pre-requisites
-1. Install Go as described at https://golang.org/doc/install
+
+1. Install Go as described at <https://golang.org/doc/install>
     - Ensure that the following line has been appended to `/etc/profile`:
-        ```
+
+        ```bash
         export PATH=$PATH:/usr/local/go/bin
         ```
+
     - Ensure that the following line has been appended to `~/.profile`:
-        ```
+
+        ```bash
         export PATH=$PATH:~/go/bin
         ```
-2. Install Docker as described at https://docs.docker.com/engine/install/ubuntu/
+
+2. Install Docker as described at <https://docs.docker.com/engine/install/ubuntu/>
     - In `Installation methods` section follow `Install using the repository` method
     - Check whether your user of Ubuntu has been added to `docker` group using the following command:
-        ```
+
+        ```bash
         getent group docker | awk -F: '{print $4}'
         ```
-        - If it has not been added, add it using `Manage Docker as a non-root user` section from https://docs.docker.com/engine/install/linux-postinstall/
- 3. Install Docker Compose as described at https://docs.docker.com/compose/install/
+
+        - If it has not been added, add it using `Manage Docker as a non-root user` section from <https://docs.docker.com/engine/install/linux-postinstall/>
+3. Install Docker Compose as described at <https://docs.docker.com/compose/install/>
 
 ## Build and test
 
 1. Building
-    ```
+
+    ```bash
     make build
     make install
     ```
 
-
 2. Run unit tests
+
     ```bash
     make test
     ```
@@ -42,10 +50,13 @@ It's recommended to develop and deploy the App on Ubuntu 18.04 or Ubuntu 20.04.
     REST integration tests need to have a backend running (CLI in REST mode).
 
     The following script will start all necessary things and run all the tests:
+
     ```bash
     ./integration_tests/run-all.sh
     ```
+
     If you want to run a particular group of tests (cli, light, rest), you can
+
     ```bash
     ./integration_tests/run-all.sh cli
     ./integration_tests/run-all.sh light
@@ -62,38 +73,42 @@ It's recommended to develop and deploy the App on Ubuntu 18.04 or Ubuntu 20.04.
     # OR
     go test <path-to-go-test-file> # to run REST or gRPC go test
     ```
-   
+
 4. Run deployment test
-    
+
     The deployment test verifies deployment steps described in [docs/running-node.md](./docs/running-node.md).
 
     ```bash
     ./integration_tests/deploy/test_deploy.sh
     ```
 
-
 ## Run local pool
+
 The easiest way to run a local pool is to start it in Docker.
 
 Validator nodes only (no Observers):
+
 ```bash
 make install
 make localnet_init
 make localnet_start
 ```
 
 Validator and Observer nodes:
+
 ```bash
 make install
 DCL_OBSERVERS=1 make localnet_init
 make localnet_start
-```    
+```
 
 This will start a local pool of 4 validator nodes in Docker. The nodes will expose their RPC endpoints on ports `26657`, `26659`, `26661`, `26663` correspondingly.
 
- Stopping the network: 
+ Stopping the network:
 
-    make localnet_stop
+```bash
+make localnet_stop
+```
 
  Then you can start the network again with the existing data using `make localnet_start`
 
@@ -102,20 +117,25 @@ It will remove `.dcl` directories from your user home directory (`~`), remove `.
 and initialize a new network data using `make localnet_init`.
 
 ## CLI
+
 Start a local pool as described above, and then just execute
-```
+
+```bash
 dcld
 ```
+
 Have a look at [How To](docs/how-to.md) and [transactions](docs/transactions.md) for instructions how to configure and use the CLI.
 
 ## REST
+
 Start a local pool as described above.
 
-Every node exposes a REST API at `http://<node-host>:1317` (see https://docs.cosmos.network/master/core/grpc_rest.html).
+Every node exposes a REST API at `http://<node-host>:1317` (see <https://docs.cosmos.network/master/core/grpc_rest.html>).
 
 Have a look at [transactions](docs/transactions.md) for a full list of REST endpoints.
 
 ## Contributing
+
 Please take into account the following when sending a PR:
 
 1) Make sure the new functionality has unit tests added
@@ -131,6 +151,7 @@ Please take into account the following when sending a PR:
     - run integration tests
 
 ## How To Add a new Module
+
 - Use [starport](https://github.com/tendermint/starport) command to scaffold the module.
   Consider using a docker container built from the provided [Dockerfile](scripts/Dockerfile) to have a predictable version of starport. See [README.md](scripts/README.md).
 - Have a look at the scripts and commands used for generation of existing modules and do it in a similar way
@@ -141,55 +162,60 @@ Please take into account the following when sending a PR:
   - add message validation as annotations (`validate` tags) in `proto/<module>/tx.proto`
   - add `(cosmos_proto.scalar) = "cosmos.AddressString"` annotation for all fields with address/account type (such as `signer` or `owner`).
   - fix types if needed in `proto/<module>/<entity>.proto` files
-    - Note1: `unit64` will be returned as string if the output is a JSON format. So, it's better to use `uint64` only when it's really `uint64`. 
+    - Note1: `unit64` will be returned as string if the output is a JSON format. So, it's better to use `uint64` only when it's really `uint64`.
     - Note2: for `uint16` type: use `int32` during starport scaffolding, and add custom validation (annotations above) to check the lower and upper bounds.
     - Note3: for `uint32` type: use `int32` during starport scaffolding, then replace it by `uint32` in .proto files, re-generate the code and fix compilation errors.
   - build proto (for example `starport chain build`). Fix compilation errors if any.
   - generate openapi docs from proto using (`scripts/dcl-swagger-gen.sh`). recommended to run from container built from [Dockerfile](scripts/Dockerfile)
 
   - **Note1**: colons (`:`) are part of subject-id in PKI module, but colons are not allowed in gRPC REST URLs by default.
     `allow_colon_final_segments=true` should be used as a workaround.
-    So, make sure that `runtime.AssumeColonVerbOpt(false)` in `/x/pki/types/query.pb.gw.go`. 
+    So, make sure that `runtime.AssumeColonVerbOpt(false)` in `/x/pki/types/query.pb.gw.go`.
     It's usually sufficient to revert the generated changes in `/x/pki/types/query.pb.gw.go`.
 - Call `validator.Validate(msg)` in `ValidateBasic` methods for all generated messages
 - Implement business logic in `msg_server_xxx.go`
 - Improve `NotFound` error processing:
-    - replace `status.Error(codes.InvalidArgument, "not found")` to `status.Error(codes.NotFound, "not found")` in every generated `grpc_query_xxx.go` to return 404 error in REST.
+  - replace `status.Error(codes.InvalidArgument, "not found")` to `status.Error(codes.NotFound, "not found")` in every generated `grpc_query_xxx.go` to return 404 error in REST.
 - Support state proof for single value queries in CLI:
-    - use `cli.QueryWithProof` instead of cosmos queries that doesn't support state proofs
-    - add proper handling for list queries and write requests when used with a light client proxy 
+  - use `cli.QueryWithProof` instead of cosmos queries that doesn't support state proofs
+  - add proper handling for list queries and write requests when used with a light client proxy
       (see `IsWriteInsteadReadRpcError` and `IsKeyNotFoundRpcError`)
 - Add unit tests (see other modules for reference)
 - Add CLI-based integration tests to `integration_tests/cli/<module>` (see other modules for reference)
 - Add gRPC/REST-based integration tests to `integration_tests/grpc_rest/<module>` (see other modules for reference)
 
 ## How To Make Changes in Data Model for Existing Modules
+
 - Use [starport](https://github.com/tendermint/starport) command to scaffold the module.
   Consider using the provided [Dockerfile](scripts/Dockerfile) to have a predictable version of starport. See [README.md](scripts/README.md).
 - **Never change `.pb` files manually**. Do the changes in `.proto` files.
 - Every time `.proto` files change, re-generate the code (for example `starport chain build`) and fix compilation errors if any.
 - Update openapi docs from proto using (`scripts/dcl-swagger-gen.sh`). recommended to run from container built from [Dockerfile](scripts/Dockerfile)
 - **Note1**: colons (`:`) are part of subject-id in PKI module, but colons are not allowed in gRPC REST URLs by default.
   `allow_colon_final_segments=true` should be used as a workaround.
-  So, make sure that `runtime.AssumeColonVerbOpt(false)` in `/x/pki/types/query.pb.gw.go`. 
-  It's usually sufficient to revert the generated changes in `/x/pki/types/query.pb.gw.go`.   
+  So, make sure that `runtime.AssumeColonVerbOpt(false)` in `/x/pki/types/query.pb.gw.go`.
+  It's usually sufficient to revert the generated changes in `/x/pki/types/query.pb.gw.go`.
 
 ## Update Cosmos-sdk Version
+
 Re-generate cosmos base openapi (service API from cosmos exposed in DCL) using [cosmos-swagger-gen.sh](scripts/cosmos-swagger-gen.sh) from the project root:
+
 - Consider using a docker container built from the provided [Dockerfile](scripts/Dockerfile) to have a predictable version of swagger
-```
+
+```bash
 ./scripts/cosmos-swagger-gen.sh base
 ./scripts/cosmos-swagger-gen.sh tx
 ```
 
 ## Update Tendermint Version
-Please note, that we depend on the Tendermint fork https://github.com/zigbee-alliance/tendermint/releases/tag/v0.34.140 
-due to hotfixes for https://github.com/tendermint/tendermint/issues/7640 and https://github.com/tendermint/tendermint/issues/7641
+
+Please note, that we depend on the Tendermint fork <https://github.com/zigbee-alliance/tendermint/releases/tag/v0.34.140>
+due to hotfixes for <https://github.com/tendermint/tendermint/issues/7640> and <https://github.com/tendermint/tendermint/issues/7641>
 required for Light Client Proxy.
 Now that fixes are merged to Tendermint master, so check if we still need to depend on the fork.
 
 Also don't forget to update the link to the Tendermint RPC in [Swagger UI](docs/index.html).
 
 ## Other
-For more details, please have a look at [Cosmos SDK tutorial](https://tutorials.cosmos.network/).
 
+For more details, please have a look at [Cosmos SDK tutorial](https://tutorials.cosmos.network/).