Skip to content

Commit ed3d40b

Browse files
authored
chore(docs): fix minor typos (#12816)
1 parent 31c3a60 commit ed3d40b

File tree

6 files changed

+7
-7
lines changed

6 files changed

+7
-7
lines changed

LOTUS_RELEASE_FLOW.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ The specific steps executed for Lotus software releases are captured in the [Rel
9696
## Release Candidates (RCs)
9797

9898
- For regular (i.e., no critical security patch) releases with no accompanying network upgrade, the RC period is typically around 1 week.
99-
- For releases accompanying network upgrades, the release candiadte period is a lot longer to allow for more extensive testing, usually around 5 to 6 weeks.
99+
- For releases accompanying network upgrades, the release candidate period is a lot longer to allow for more extensive testing, usually around 5 to 6 weeks.
100100
- Releases rushing out a critical security patch will likely have an RC period on the order of hours or days, or may even forgo the RC phase. To compensate for the release speed, these releases will include the minimum delta necessary, meaning they'll be a patch on top of an existing release rather than taking the latest changes in the `master` branch.
101101

102102
## Security Fix Policy

chain/types/tipset_key.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ func init() {
3737
type TipSetKey struct {
3838
// The internal representation is a concatenation of the bytes of the CIDs, which are
3939
// self-describing, wrapped as a string.
40-
// These gymnastics make the a TipSetKey usable as a map key.
40+
// These gymnastics make a TipSetKey usable as a map key.
4141
// The empty key has value "".
4242
value string
4343
}

cli/backup.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ func BackupCmd(repoFlag string, rt repo.RepoType, getApi BackupApiFn) *cli.Comma
112112
Description: `The backup command writes a copy of node metadata under the specified path
113113
114114
Online backups:
115-
For security reasons, the daemon must be have LOTUS_BACKUP_BASE_PATH env var set
115+
For security reasons, the daemon must have LOTUS_BACKUP_BASE_PATH env var set
116116
to a path where backup files are supposed to be saved, and the path specified in
117117
this command must be within this base path`,
118118
Flags: []cli.Flag{

documentation/en/chain-indexer-overview-for-operators.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ There is no automated migration from [pre-ChainIndexer indices](#previous-indexi
212212

213213
### Backfill Timing
214214

215-
Backfilling the new `ChainIndexer` was [benchmarked to take approximately ~12 hours per month of epochs on a sample archival node doing no other work](https://github.com/filecoin-project/lotus/issues/12453#issuecomment-2405306468). Your results will vary depending on hardware, network, and competing processes. This means if one is upgrading a FEVM archival node, they should plan on the node being out of production service for ~10 days. Additional nodes to update don't need to go throuh the same time-intensive process though. They can get a `${LOTUS_PATH}/chainindex/chainindex.db` copied from a trusted node per the [upgrade steps](#upgrade).
215+
Backfilling the new `ChainIndexer` was [benchmarked to take approximately ~12 hours per month of epochs on a sample archival node doing no other work](https://github.com/filecoin-project/lotus/issues/12453#issuecomment-2405306468). Your results will vary depending on hardware, network, and competing processes. This means if one is upgrading a FEVM archival node, they should plan on the node being out of production service for ~10 days. Additional nodes to update don't need to go through the same time-intensive process though. They can get a `${LOTUS_PATH}/chainindex/chainindex.db` copied from a trusted node per the [upgrade steps](#upgrade).
216216

217217
### Backfill Disk Space Requirements
218218

@@ -318,7 +318,7 @@ In case you need to downgrade to the [previous indexing system](#previous-indexi
318318

319319
The decision to not invest here ultimately comes down to the development-time cost vs. benefit ratio.
320320

321-
For achival nodes, we don't have the confidence that the [previous indexing system](#previous-indexing-system) has the correct data to bootstrap from. In 2024, Lotus maintainers have fixed multiple bugs in the [previous indexing system](#previous-indexing-system), but they still see reports of missing data, mismatched event index counts, etc. Investing here in a migration isn't guaranteed to yield a correct index. As a result, one would still need to perform the [backfill steps](#backfill) to validate and correct the data anyway. While this should be faster having partially correct data than no data, it would still require an archival node to take an outage on the order of days which isn't good enough.
321+
For archival nodes, we don't have the confidence that the [previous indexing system](#previous-indexing-system) has the correct data to bootstrap from. In 2024, Lotus maintainers have fixed multiple bugs in the [previous indexing system](#previous-indexing-system), but they still see reports of missing data, mismatched event index counts, etc. Investing here in a migration isn't guaranteed to yield a correct index. As a result, one would still need to perform the [backfill steps](#backfill) to validate and correct the data anyway. While this should be faster having partially correct data than no data, it would still require an archival node to take an outage on the order of days which isn't good enough.
322322

323323
The schemas of [the old fragmented Indices](#previous-indexing-system) don't naturally map to the schema of the [ChainIndexer](#chainindexer-indexing-system). There would be additional data wrangling work to ultimately get this right.
324324

documentation/en/cli-lotus-miner.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ DESCRIPTION:
176176
The backup command writes a copy of node metadata under the specified path
177177
178178
Online backups:
179-
For security reasons, the daemon must be have LOTUS_BACKUP_BASE_PATH env var set
179+
For security reasons, the daemon must have LOTUS_BACKUP_BASE_PATH env var set
180180
to a path where backup files are supposed to be saved, and the path specified in
181181
this command must be within this base path
182182

documentation/en/cli-lotus.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ DESCRIPTION:
107107
The backup command writes a copy of node metadata under the specified path
108108
109109
Online backups:
110-
For security reasons, the daemon must be have LOTUS_BACKUP_BASE_PATH env var set
110+
For security reasons, the daemon must have LOTUS_BACKUP_BASE_PATH env var set
111111
to a path where backup files are supposed to be saved, and the path specified in
112112
this command must be within this base path
113113

0 commit comments

Comments
 (0)