Skip to content

Commit 916756f

Browse files
committed
Auto-fix: Update breadcrumbs, spelling dictionary and other automated fixes
1 parent 7bbfb38 commit 916756f

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

pages/operators/chain-operators/management/best-practices.mdx

+19-19
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,21 @@ off-chain components.
1515

1616
Chain and node operators should always run the latest production releases of the OP Stack's off-chain components. The latest notes and changelogs can be found on GitHub:
1717

18-
- [OP monorepo releases](https://github.com/ethereum-optimism/optimism/releases) (includes `op-node` and other Go-based OP components)
19-
- [op-geth releases](https://github.com/ethereum-optimism/op-geth/releases) (standalone repository)
20-
- [op-contracts releases](https://github.com/ethereum-optimism/optimism/releases) (look for tags starting with `op-contracts/`)
18+
* [OP monorepo releases](https://github.com/ethereum-optimism/optimism/releases) (includes `op-node` and other Go-based OP components)
19+
* [op-geth releases](https://github.com/ethereum-optimism/op-geth/releases) (standalone repository)
20+
* [op-contracts releases](https://github.com/ethereum-optimism/optimism/releases) (look for tags starting with `op-contracts/`)
2121

2222
Some guidelines when picking versions:
2323

24-
* **Production releases** are always tagged with `<component-name>/v<semver>` for a specific OP component, for example:
25-
- `op-node/v1.7.5` for the `op-node`
26-
- `op-challenger/v1.0.0` for the `op-challenger`
24+
* **Production releases** are always tagged with `<component-name>/v<semver>` for a specific OP component, for example:
25+
* `op-node/v1.7.5` for the `op-node`
26+
* `op-challenger/v1.0.0` for the `op-challenger`
2727

28-
* **Monorepo releases** typically use a simple `v<semver>` format (e.g. `v1.7.7`) to indicate that all Go-based OP Stack components (in `op-*`) have been updated together. These do **not** include new L1 contract releases.
28+
* **Monorepo releases** typically use a simple `v<semver>` format (e.g. `v1.7.7`) to indicate that all Go-based OP Stack components (in `op-*`) have been updated together. These do **not** include new L1 contract releases.
2929

30-
* **Contracts releases** are tagged under `op-contracts/v<semver>` (e.g. `op-contracts/v1.6.0`) and contain updates to the Bedrock L1 contracts.
30+
* **Contracts releases** are tagged under `op-contracts/v<semver>` (e.g. `op-contracts/v1.6.0`) and contain updates to the Bedrock L1 contracts.
3131

32-
* **`op-geth` versioning** includes upstream geth's version within its semver. For example, if upstream geth is at `v1.12.0`, an `op-geth` release might be `v1.101200.0`. The geth major version is used as our minor version (left-padded if needed), and the patch version is appended.
32+
* **`op-geth` versioning** includes upstream geth's version within its semver. For example, if upstream geth is at `v1.12.0`, an `op-geth` release might be `v1.101200.0`. The geth major version is used as our minor version (left-padded if needed), and the patch version is appended.
3333

3434
Always consult release notes for additional details or upgrade instructions.
3535

@@ -40,27 +40,27 @@ deployment artifacts:
4040

4141
* Contract release tag and commit hash
4242
* Contract deployment configuration file. This is the JSON file you created
43-
and passed to the deployment script when you deployed the contracts.
43+
and passed to the deployment script when you deployed the contracts.
4444
* Contract deployment directory with smart contract artifacts. This is
45-
created in [packages/contracts-bedrock/deployments](https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts-bedrock/deployments)
45+
created in [packages/contracts-bedrock/deployments](https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts-bedrock/deployments)
4646
* The rollup configuration file that you generated after the contract
47-
deployment
47+
deployment
4848
* The genesis file that you generated after the contract deployment
4949

50-
## Incremental upgrade rollouts
50+
## Incremental upgrade rollouts
5151

5252
When upgrading your nodes, take a staggered approach. This means deploying the
5353
upgrade gradually across your infrastructure and ensuring things work as
5454
expected before making changes to every node.
5555

56-
## Isolate your sequencer
56+
## Isolate your sequencer
5757

5858
You can isolate your sequencer node, by not connecting it directly to the
59-
internet. Instead, you could handle your ingress traffic behind a proxy. Have
60-
the proxy forward traffic to replicas and have them gossip the transactions
59+
internet. Instead, you could handle your ingress traffic behind a proxy. Have
60+
the proxy forward traffic to replicas and have them gossip the transactions
6161
internally.
6262

63-
## Improve reliability of peer-to-peer transactions
63+
## Improve reliability of peer-to-peer transactions
6464

6565
These flags can improve the reliability of peer-to-peer transactions from internal replica nodes and the sequencer node.
6666

@@ -88,8 +88,8 @@ Create custom runbooks to prepare for operating an OP Stack chain. For a deeper
8888

8989
## Assumptions
9090

91-
### op-proposer assumes archive mode
91+
### op-proposer assumes archive mode
9292

9393
The `op-proposer` currently assumes that `op-geth` is being run in archive
94-
mode. This will likely be updated in a future network upgrade, but it is
94+
mode. This will likely be updated in a future network upgrade, but it is
9595
necessary for L2 withdrawals at the moment.

0 commit comments

Comments
 (0)