From 51d9b967364650001f0ffa3d1008b6129dc041b8 Mon Sep 17 00:00:00 2001 From: Henrik Soerensen Date: Thu, 1 Feb 2024 17:47:30 -0500 Subject: [PATCH] Grammar fixes --- README.md | 2 +- docs/index.md | 2 +- docs/installation/installation.md | 4 ++-- docs/operating/running-your-node.md | 2 +- docs/operating/setup-notifications.md | 6 +++--- docs/troubleshooting.md | 2 +- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 68973b0..ad92bdd 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Success criteria for the installation script are: > 2. Provide a simple and easy way to onboard new participants. > 3. The package should be as cheap as possible to run for individual participants. -To achieve the above the package is an opinionated way to join the network, and may thus not be suitable for +To achieve this, the package is an opinionated way to join the network, and may thus not be suitable for all use cases. ## Documentation diff --git a/docs/index.md b/docs/index.md index 8d7c6de..e2d0dae 100644 --- a/docs/index.md +++ b/docs/index.md @@ -15,7 +15,7 @@ Tenets for the Voi Swarm package are: > 2. Provide a simple and easy way to onboard new participants. > 3. The package should be as cheap as possible to run for individual participants. -To achieve the above the package is an opinionated way to join the network, and may thus not be suitable for +To achieve this, the package is an opinionated way to join the network, and may thus not be suitable for all use cases. ## Features diff --git a/docs/installation/installation.md b/docs/installation/installation.md index 0ced605..29a59c2 100644 --- a/docs/installation/installation.md +++ b/docs/installation/installation.md @@ -4,7 +4,7 @@ !!! tip Start here if you are new to Voi and want to set up a new Voi node. - During the process you will be asked for a few details to set up your node, and where we have automated as much as possible. + During the process, you will be asked for a few details to set up your node, and where we have automated as much as possible. To set up a new Voi node, run the following command: @@ -38,7 +38,7 @@ export VOINETWORK_SKIP_WALLET_SETUP=1 This is an advanced feature and is not required to have telemetry configured. During installation, you will be prompted to set a custom telemetry name, if however you prefer to set a name through -the environment you can do so by setting the **VOINETWORK_TELEMETRY_NAME** environment variable to your desired name. +the environment, you can do so by setting the **VOINETWORK_TELEMETRY_NAME** environment variable to your desired name. This would typically be done if you are automating the installation process. diff --git a/docs/operating/running-your-node.md b/docs/operating/running-your-node.md index 7bc539a..d0b1a95 100644 --- a/docs/operating/running-your-node.md +++ b/docs/operating/running-your-node.md @@ -6,7 +6,7 @@ To operate your node and manage your accounts, you can use the Voi CLI tools. The Voi CLI tools are a set of scripts that allow you to manage common blockchain actions. The Voi CLI tools are installed with the Voi Swarm package. -As a participant it's important that you continuously monitor the health of your node, this includes monitoring system +As a participant, it's important that you continuously monitor the health of your node, this includes monitoring system metrics, node health as well as ensuring participation keys are up-to-date. | Metrics | Description | How to Monitor | Feature in Voi Swarm | diff --git a/docs/operating/setup-notifications.md b/docs/operating/setup-notifications.md index 378a83d..3bfd6f5 100644 --- a/docs/operating/setup-notifications.md +++ b/docs/operating/setup-notifications.md @@ -12,7 +12,7 @@ Start by copying the example `~/voi/docker/notification.yml.example` file to the without the .example extension ```bash -cp ~/voi/docker/notification.yml.example ~/voi/docker/notification.yml` +cp ~/voi/docker/notification.yml.example ~/voi/docker/notification.yml ``` ## Adding Your Notification Choices @@ -22,7 +22,7 @@ environment variable. The notification mechanism can be a webhook, email, push, is available via [Apprise notifications](https://github.com/caronc/apprise?tab=readme-ov-file#supported-notifications) If you want to use multiple mechanisms, separate them with a comma. For example, to use both Discord and Pushbullet for -notification, you would set the **NOTIFICATION_URLS** value in the **notification.yml** file to: +notification, you would set the **NOTIFICATION_URLS** value in the **notification.yml** file to: ```yaml NOTIFICATION_URLS="discord:///,pbul://" @@ -37,7 +37,7 @@ To modify the participation key notification schedule, adjust the labels in the | `swarm.cronjob.schedule` | `0 16 * * *` (default) | This is by default set to run daily at 4 PM UTC. Adjust this to your preferred time, accounting for your -timezone's UTC offset. Use a resource like [dateful.com](https://dateful.com/time-zone-converter) for timezone conversion. +timezones UTC offset. Use a resource like [dateful.com](https://dateful.com/time-zone-converter) for timezone conversion. The format of the schedule is following the [CRON format](https://pkg.go.dev/github.com/robfig/cron#hdr-CRON_Expression_Format). diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 7d3ae72..b02e3be 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -26,7 +26,7 @@ docker inspect voinetwork_algod ## Testing Notifications -To test notifications execute the following command: +To test notifications, execute the following command: ```bash ~/voi/bin/notification-test