Skip to content

Commit 41d64fc

Browse files
Fix natural laguague issues
1 parent 34bd0f4 commit 41d64fc

8 files changed

+20
-20
lines changed

bench/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Run (consider to use virtual environment):
1414
pip3 install -r bench/requirements.txt
1515
```
1616

17-
**Optional** If you need to monitor server side metrics please install [Prometheus](https://prometheus.io/docs/prometheus/latest/getting_started/).
17+
**Optional** If you need to monitor server-side metrics please install [Prometheus](https://prometheus.io/docs/prometheus/latest/getting_started/).
1818

1919
## Preparation
2020

@@ -59,7 +59,7 @@ Here the following (**optional**) inputs are considered:
5959
prometheus --config.file=bench/prometheus.yml
6060
```
6161

62-
And open `http://localhost:9090/` to query and monitor the server side metrics.
62+
And open `http://localhost:9090/` to query and monitor the server-side metrics.
6363

6464
### Headless
6565

dcl-ui/ansible/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Deploying DC Ledger UI
22

3-
1. Run `dclcli` rest service on the client machine. See `deployment/ansible` folder in the `dc-ledger` repo.
3+
1. Run `dclcli` rest service on the client machine. See `deployment/ansible` folder in the `dc-ledger` repository.
44
2. Build the app by running `ng build --prod`.
55
3. Execute playbooks in the following order: `content`, `nginx`, `config`, `reload`.
66
4. Use certbot to obtain a certificate and don't forger to open `443` port.

docs/advanced/running-genesis-node.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ must have a unique chain ID.
7575
* `sudo ufw allow 26656/tcp`
7676
* `sudo ufw allow 26657/tcp`
7777
* Edit `dcld.service`
78-
* Replace `ubuntu` with a user name you want to start service on behalf
78+
* Replace `ubuntu` with a username you want to start service on behalf
7979
* Copy service configuration.
8080
* `cp dcld.service /etc/systemd/system/`
8181
* Make your node public:

docs/advanced/running-observer-node.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ and contains the genesis and persistent_peers files.
6868
* `sudo ufw allow 26656/tcp`
6969
* `sudo ufw allow 26657/tcp`
7070
* Edit `dcld.service` (Only needed for Ubuntu).
71-
* Replace `ubuntu` with a user name you want to start service on behalf
71+
* Replace `ubuntu` with a username you want to start service on behalf
7272
* Copy service configuration. (Only needed for Ubuntu).
7373
* `cp dcld.service /etc/systemd/system/`
7474

docs/advanced/running-validator-node.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ and contains the genesis and persistent_peers files.
105105
* `sudo ufw allow 26656/tcp`
106106
* `sudo ufw allow 26657/tcp`
107107
* Edit `dcld.service`
108-
* Replace `ubuntu` with a user name you want to start service on behalf
108+
* Replace `ubuntu` with a username you want to start service on behalf
109109
* Copy service configuration.
110110
* `cp dcld.service /etc/systemd/system/`
111111

docs/design/benchmarking.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,16 @@
1414
- simulate deployment as close to production as possible
1515

1616

17-
## Client Side Metrics
17+
## Client-side Metrics
1818

1919
* `response time` (percentiles): the time between client's initial request and the last byte of a validator response
2020
* `requests per second (RPS)`: number of requests per second
2121
* `transactions per second (TPS)`: number of write requests (txns) per second
22-
* **Note** to measure that on a client side write requests should use `broadcast_tx_commit` requests
22+
* **Note** to measure that on a client-side write requests should use `broadcast_tx_commit` requests
2323
* `number of clients`: number of concurrent clients that ledger serves
2424
* (optional) `throughtput` (in/out): number of KB per second. Marked as optional since we don't expect much in/out data due to relatively small txns payloads.
2525

26-
## Server Side Metrics
26+
## Server-side Metrics
2727

2828
### Tendermint metrics
2929

@@ -43,7 +43,7 @@ The following ones makes sense to track:
4343

4444
### Cosmos SDK metrics
4545

46-
Starting from `v0.40.0` Cosmos SDK provides [telemetry](https://docs.cosmos.network/master/core/telemetry.html) package as a server side support for application performance and behavior explorations.
46+
Starting from `v0.40.0` Cosmos SDK provides [telemetry](https://docs.cosmos.network/master/core/telemetry.html) package as a server-side support for application performance and behavior explorations.
4747

4848
The following [metrics](https://docs.cosmos.network/master/core/telemetry.html#supported-metrics) make sense to track:
4949

docs/monitoring.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
As long as DCLedger is built on top of Cosmos SDK and Tendermint their monitoring abilities can be considered for DCLedger as well.
66

77
* Starting from `v0.21.0` Tendermint provides Prometheus compatible [metrics](https://docs.tendermint.com/master/nodes/metrics.html#metrics).
8-
* Starting from `v0.40.0` Cosmos SDK provides [telemetry](https://docs.cosmos.network/master/core/telemetry.html) package as a server side support for application performance and behavior explorations.
8+
* Starting from `v0.40.0` Cosmos SDK provides [telemetry](https://docs.cosmos.network/master/core/telemetry.html) package as a server-side support for application performance and behavior explorations.
99

1010
## Installation & Configuration
1111

@@ -31,4 +31,4 @@ Run
3131
prometheus --config.file=prometheus.yml
3232
```
3333

34-
And open `http://localhost:9090/` to query and monitor the server side metrics.
34+
And open `http://localhost:9090/` to query and monitor the server-side metrics.

docs/transactions.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ Not all fields can be edited (see `EDIT_MODEL`).
177177
- productName: `string` - model name
178178
- productLabel: `string` - model description (string or path to file containing data)
179179
- partNumber: `string` - stock keeping unit
180-
- commissioningCustomFlow: `optional(uint8)` - A value of 1 indicates that user interaction with the device (pressing a button, for example) is required before commissioning can take place. When CommissioningCustomflow is set to a value of 2, the commissioner SHOULD attempt to obtain a URL which MAY be used to provide an end-user with the necessary details for how to configure the product for initial commissioning
180+
- commissioningCustomFlow: `optional(uint8)` - A value of 1 indicates that user interaction with the device (pressing a button, for example) is required before commissioning can take place. When CommissioningCustomflow is set to a value of 2, the commissioner SHOULD attempt to obtain a URL which MAY be used to provide an end user with the necessary details for how to configure the product for initial commissioning
181181
- commissioningCustomFlowURL: `optional(string)` - commissioningCustomFlowURL SHALL identify a vendor specific commissioning URL for the device model when the commissioningCustomFlow field is set to '2'
182182
- commissioningModeInitialStepsHint: `optional(uint32)` - commissioningModeInitialStepsHint SHALL identify a hint for the steps that can be used to put into commissioning mode a device that has not yet been commissioned. This field is a bitmap with values defined in the Pairing Hint Table. For example, a value of 1 (bit 0 is set) indicates that a device that has not yet been commissioned will enter Commissioning Mode upon a power cycle.
183183
- commissioningModeInitialStepsInstruction: `optional(string)` - commissioningModeInitialStepsInstruction SHALL contain text which relates to specific values of CommissioningModeInitialStepsHint. Certain values of CommissioningModeInitialStepsHint, as defined in the Pairing Hint Table, indicate a Pairing Instruction (PI) dependency, and for these values the commissioningModeInitialStepsInstruction SHALL be set
@@ -769,7 +769,7 @@ The revocation is not applied until sufficient number of Trustees approve it.
769769
#### GET_X509_CERT
770770
**Status: Implemented**
771771
772-
Gets a certificate (either root, intermediate or leaf) by the given subject and subject key id attributes.
772+
Gets a certificate (either root, intermediate or leaf) by the given subject and subject key ID attributes.
773773
Revoked certificates are not returned.
774774
Use `GET_ALL_REVOKED_X509_CERTS` to get a list of all revoked certificates.
775775
@@ -813,7 +813,7 @@ Revoked certificates are not returned.
813813
#### GET_PROPOSED_X509_ROOT_CERT
814814
**Status: Implemented**
815815
816-
Gets a proposed but not approved root certificate with the given subject and subject key id attributes.
816+
Gets a proposed but not approved root certificate with the given subject and subject key ID attributes.
817817
818818
- Parameters:
819819
- subject: `string` - certificates's `Subject`
@@ -826,7 +826,7 @@ Gets a proposed but not approved root certificate with the given subject and sub
826826
#### GET_REVOKED_CERT
827827
**Status: Implemented**
828828
829-
Gets a revoked certificate (either root, intermediate or leaf) by the given subject and subject key id attributes.
829+
Gets a revoked certificate (either root, intermediate or leaf) by the given subject and subject key ID attributes.
830830
831831
- Parameters:
832832
- subject: `string` - certificates's `Subject`
@@ -949,7 +949,7 @@ will be in a pending state until sufficient number of approvals is received.
949949
- Parameters:
950950
- address: `string` - account address; Bench32 encoded
951951
- pub_key: `string` - account's Protobuf JSON encoded public key
952-
- vid: `optional(uint16)` - vendor id (only needed for vendor role)
952+
- vid: `optional(uint16)` - vendor ID (only needed for vendor role)
953953
- roles: `array<string>` - the list of roles, comma-separated, assigning to the account. Supported roles: `Vendor`, `TestHouse`, `CertificationCenter`, `Trustee`, `NodeAdmin`.
954954
- info: `optional(string)` - information/notes for the proposal
955955
- time: `optional(int64)` - proposal time (number of nanoseconds elapsed since January 1, 1970 UTC). CLI uses the current time for that field.
@@ -1116,7 +1116,7 @@ Adds a new Validator node.
11161116
- pubkey: `string` - The validator's Protobuf JSON encoded public key
11171117
- moniker: `string` - The validator's human-readable name
11181118
- identity: `optional(string)` - identity signature (ex. UPort or Keybase)
1119-
- website: `optional(string)` - The validator's website link
1119+
- website: `optional(string)` - The validator's site link
11201120
- details: `optional(string)` - The validator's details
11211121
- ip: `optional(string)` - The node's public IP
11221122
- node-id: `optional(string)` - The node's ID
@@ -1167,7 +1167,7 @@ Updates the Validator node by the owner.
11671167
- address: `string` - Bench32 encoded validator address or owner account
11681168
- moniker: `string` - The validator's human-readable name
11691169
- identity: `optional(string)` - identity signature (ex. UPort or Keybase)
1170-
- website: `optional(string)` - The validator's website link
1170+
- website: `optional(string)` - The validator's site link
11711171
- details: `optional(string)` - The validator's details
11721172
- ip: `optional(string)` - The node's public IP
11731173
- node-id: `optional(string)` - The node's ID
@@ -1240,7 +1240,7 @@ Sign transaction by the given key.
12401240
- `from` - name or address of private key to use to sign.
12411241
- `account-number` - (optional) the account number of the signing account.
12421242
- `sequence` - (optional) the sequence number of the signing account.
1243-
- `chain-id` - (optional) chain id.
1243+
- `chain-id` - (optional) chain ID.
12441244
- CLI command:
12451245
- `dcld tx sign [path-to-txn-file] --from [address]`
12461246
Note: if `account_number` and `sequence` are not specified they will be fetched from the ledger automatically.

0 commit comments

Comments
 (0)