Skip to content

Commit

Permalink
Grammar fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
hsoerensen committed Feb 1, 2024
1 parent 3eace64 commit 07f1de6
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/installation/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/operating/running-your-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
4 changes: 2 additions & 2 deletions docs/operating/setup-notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -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://<webhook_id>/<webhook_token>,pbul://<access_token>"
Expand All @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion docs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 07f1de6

Please sign in to comment.