setup_local_env: Fix README markdown lint warnings
Fix the problems flagged by markdownlint [1,2] in this README.md file.
These fixes are for the lists, blank lines around them, and indentation.
[1] https://github.com/DavidAnson/vscode-markdownlint
[2] https://github.com/markdownlint/markdownlint
Use this change also to fix a minor word spelling typo ('deployment').
Change-Id: I45f04076a42ca783aca1edda8e21dd420999ab8d
diff --git a/setup_local_env/README.md b/setup_local_env/README.md
index 2df0c2b..441f98d 100644
--- a/setup_local_env/README.md
+++ b/setup_local_env/README.md
@@ -2,27 +2,35 @@
This script configures a full environment to simulate a Gerrit Multi-Site setup.
The environment is composed by:
- - 2 gerrit instances deployed by default in /tmp
- - 1 kafka node and 1 zookeeper node
- - 1 HA-PROXY
+
+- 2 gerrit instances deployed by default in /tmp
+- 1 kafka node and 1 zookeeper node
+- 1 HA-PROXY
## Requirements
- - java
- - docker and docker-compose
- - wget
- - envsubst
- - haproxy
+
+- java
+- docker and docker-compose
+- wget
+- envsubst
+- haproxy
## Examples
+
Simplest setup with all default values and cleanup previous deployment
+
```bash
sh setup_local_env/setup.sh --release-war-file /path/to/release.war --multisite-plugin-file /path/to/multi-site.jar
```
+
Cleanup the previous deployments
+
```bash
sh setup_local_env/setup.sh --just-cleanup-env true
```
+
Help
+
```bash
Usage: sh setup.sh [--option ]
@@ -52,6 +60,7 @@
```
## Limitations
- - Assumes the ssh replication is done always on port 22 on both instances
- - When cloning projects via ssh, public keys entries are added to `known_hosts`
- - Clean up the old entries when doing a new deploymet, otherwise just use HTTP
\ No newline at end of file
+
+- Assumes the ssh replication is done always on port 22 on both instances
+- When cloning projects via ssh, public keys entries are added to `known_hosts`
+ - Clean up the old entries when doing a new deployment, otherwise just use HTTP
