diff --git a/README.md b/README.md index 876bc568824..fa19ebf5349 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ by receiving pre-constructed files from the network, validating those, populatin expose the data. This approach provides the following advantages: - Lower compute and bandwidth requirements -- It allows users to only save what they care about, and discard what they don’t (lower storage requirement) +- Allows users to only save the data that they care about (lower storage requirement) - Easy searchable database so the users can add value quickly - Easy to consume APIs to make integrations faster @@ -84,8 +84,8 @@ Ensure these tools are installed (note minimum versions) prior to running the mi ### Running For production use, we recommend using Kubernetes and to deploy using our Helm [chart](charts). Hedera managed mirror -nodes use Kubernetes and Helm for its deployments and is considered the most production-ready. As an alternative for -local development, Docker Compose can be used to run the mirror node. See +nodes use Kubernetes and Helm for their deployments, and this process is considered the most production-ready. As an +alternative for local development, Docker Compose can be used to run the mirror node. See the [installation](docs/installation.md#running-via-docker-compose) document for more details on configuring and running with Docker Compose. To get up and running quickly with Docker Compose execute the following commands in your terminal: diff --git a/docs/installation.md b/docs/installation.md index 8553b4180d7..e7f22c14140 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -4,8 +4,8 @@ The Mirror Node can be run [locally](#running-locally) or via [Docker](#running- ## Building -To run locally, it'll first need to be built using Java. Ensure you have OpenJDK 11 installed, then run the following -command from the top level directory. This will compile a runnable mirror node JAR file in the `target` directory. +To run locally, first build the project using Java. Ensure you have OpenJDK 11 installed, then run the following command +from the top level directory. This will compile a runnable mirror node JAR file in the `target` directory. ```console ./mvnw clean package -DskipTests @@ -19,7 +19,7 @@ In addition to OpenJDK 11, you will need to install a [PostgreSQL](https://postg Since [Flyway](https://flywaydb.org) will manage the database schema, the only required step is to run the database initialization script. Locate the SQL script at `hedera-mirror-importer/src/main/resources/db/scripts/init.sh` and edit -the file to change the name and password variables at the top of the file as appropriate. Then make sure the +the file to change the name and password variables at the top of the file to the desired values. Then make sure the application [configuration](configuration.md) matches the values in the script. Run the SQL script as a super user and check the output carefully to ensure no errors occurred. @@ -207,7 +207,7 @@ volumes: Before starting, [configure](configuration.md) the application by updating the [application.yml](/application.yml) file with the desired custom values. This file is passed to Docker Compose and allows customized configuration for each of the mirror node components. The `application.yml` file contents represent the minimal set of fields required to -configure requester pays and must all be uncommented and filled in. +configure requester pays and must be uncommented and filled in. ### Starting diff --git a/docs/operations.md b/docs/operations.md index aa88bca935d..31704c6a4ad 100644 --- a/docs/operations.md +++ b/docs/operations.md @@ -257,7 +257,7 @@ Verify all ports: for port in {6551..6560}; do curl -s "http://127.0.0.1:${port}/api/v1/transactions?limit=1" && echo; done ``` -To setup live monitoring, see [monitoring](/hedera-mirror-rest/monitoring/README.md) documentation. +To set up live monitoring, see [monitoring](/hedera-mirror-rest/monitoring/README.md) documentation. ### Open API Spec