Skip to content

Commit

Permalink
docs: Fix Typos Across Various Documentation Files (#2310)
Browse files Browse the repository at this point in the history
  • Loading branch information
joaolago1113 authored Jan 8, 2024
1 parent e9d083b commit 3553fb4
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/contributors/continuous-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The CI setup exists on the Status.im Jenkins instance:

https://ci.infra.status.im/job/nim-waku/

It currently consists four jobs:
It currently consists of four jobs:

* [manual](https://ci.infra.status.im/job/nim-waku/job/manual/) - For manually executing builds using parameters.
* [deploy-wakuv1-test](https://ci.infra.status.im/job/nim-waku/job/deploy-wakuv1-test/) - Builds every new commit in `master` and deploys to `wakuv1.test` fleet.
Expand Down
2 changes: 1 addition & 1 deletion docs/contributors/release-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ How to do releases.

For more context, see https://trunkbaseddevelopment.com/branch-for-release/

## How to to do releases
## How to do releases

### Before release

Expand Down
4 changes: 2 additions & 2 deletions docs/operators/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Nwaku (formerly `nim-waku`) aims to be a lightweight and robust Waku v2 client.
It serves as the reference implementation for researchers,
who extend the client in parallel to spec development.
As such, it is first in line to support innovative and new Waku v2 protocols,
but configurable enough to serve the adaptive needs of a various operators.
but configurable enough to serve the adaptive needs of various operators.
We are also developing a set of operator-focused tools to monitor and maintain a running nwaku node.

This guide provides step-by-step tutorials covering how to build and configure your own nwaku node,
Expand All @@ -32,4 +32,4 @@ For bug reports, please [tag your issue with the `bug` label](https://github.com

If you believe the reported issue requires critical attention, please [use the `critical` label](https://github.com/waku-org/nwaku/issues/new?labels=critical,bug) to assist with triaging.

To get help, or participate in the conversation, join the [Vac Discord](https://discord.gg/KNj3ctuZvZ) server.
To get help, or participate in the conversation, join the [Vac Discord](https://discord.gg/KNj3ctuZvZ) server.
6 changes: 3 additions & 3 deletions docs/operators/how-to/configure-store.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,13 @@ There is a set of configuration options to customize the waku store protocol's m
+ The time retention policy,`time:<duration-in-seconds>` (e.g., `time:14400`)
+ The capacity retention policy,`capacity:<messages-count>` (e.g, `capacity:25000`)
+ The size retention policy,`size:<size-in-gb-mb>` (e.g, `size:25Gb`)
+ To disable the retention policy, explicitly, set this option to to `""`, an empty string.
+ To disable the retention policy, explicitly, set this option to `""`, an empty string.
* `--store-message-db-url`: The message store database url option controls the message storage engine. This option follows the [_SQLAlchemy_ database URL format](https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls).

+ SQLite engine: The only database engine supported by the nwaku node. The database URL has this shape: `sqlite://<database-file-path>`. If the `<database-file-path>` is not an absolute path (preceded by a `/` character), the file will be created in the current working directory. The SQLite engine also supports to select a non-persistent in-memory database by setting the `<database-file-path>` to `:memory:`.
+ In the case you don't want to use a persistent message store; set the `--store-message-db-url` to an empty string, `""`. This will instruct the node to use the fallback in-memory message store.

By default the node message store will be configured with a time retention policy set to `14400` seconds (4 hours). Additionaly, by default, the node message store will use the SQLite database engine to store historical messages in order to persist these between restarts.
By default the node message store will be configured with a time retention policy set to `14400` seconds (4 hours). Additionally, by default, the node message store will use the SQLite database engine to store historical messages in order to persist these between restarts.

> :warning: Note the 3 slashes, `///`, after the SQLite database URL schema. The third slash indicates that it is an absolute path: `/mnt/nwaku/data/db1/store.sqlite3`
Expand All @@ -55,4 +55,4 @@ wakunode2 \
### How much resources should I allocate?

Currently store service nodes use, by default, a message store backed by an in-disk SQLite database. Most Waku messages average a size of 1KB - 2KB, implying a minimum memory requirement of at least ~250MB
for a typical store capacity of 100k messages. Note, however, that the allowable maximum size for Waku messages is up to 1MB.
for a typical store capacity of 100k messages. Note, however, that the allowable maximum size for Waku messages is up to 1MB.
4 changes: 2 additions & 2 deletions docs/operators/how-to/configure.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ provided via environment variables.

### Configuration file

The third configuration mechanism in order of precedence is the configuration via a TOML file. The previous mechanims take precedence over this mechanism as explained above.
The third configuration mechanism in order of precedence is the configuration via a TOML file. The previous mechanisms take precedence over this mechanism as explained above.

The configuration file follows the [TOML](https://toml.io/en/) format:

Expand All @@ -90,7 +90,7 @@ log-level = "DEBUG"
tcp-port = 65000
```

The path to the TOML file can be specified usin one of the previous configuration mechanisms:
The path to the TOML file can be specified using one of the previous configuration mechanisms:

* By passing the `--config-file` command line option:
```shell
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial/rln-chat2-live-testnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sending more than one message per epoch.
At the time of this tutorial, the epoch duration is set to `10` seconds.
You can inspect the current epoch value by checking the following [constant variable](https://github.com/status-im/nim-waku/blob/21cac6d491a6d995a7a8ba84c85fecc7817b3d8b/waku/v2/protocol/waku_rln_relay/constants.nim#L245) in the nim-waku codebase.
Your messages will be routed via test fleets and will arrive at other live chat2 clients that are running in rate-limited mode over the same content topic i.e., `/toy-chat/3/mingde/proto`.
Your samp activity will be detected by them and a proper message will be shown on their console.
Your spam activity will be detected by them and a proper message will be shown on their console.

# Set up
## Build chat2
Expand Down
2 changes: 1 addition & 1 deletion waku/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ It is possible to configure an IPv4 DNS domain name that resolves to the node's
wakunode2 --dns4-domain-name=mynode.example.com
```

This allows for the node's publically announced `multiaddrs` to use the `/dns4` scheme.
This allows for the node's publicly announced `multiaddrs` to use the `/dns4` scheme.
In addition, nodes with domain name and [secure websocket configured](#enabling-websocket),
will generate a discoverable ENR containing the `/wss` multiaddr with `/dns4` domain name.
This is necessary to verify domain certificates when connecting to this node over secure websocket.
Expand Down

0 comments on commit 3553fb4

Please sign in to comment.