reworks following proof round

hyperledger · Jul 2, 2024 · c6c48c4 · c6c48c4
1 parent 112ea80
commit c6c48c4
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 58 deletions.
diff --git a/docs/public-networks/how-to/use-configuration-file/defaults.md b/docs/public-networks/how-to/use-configuration-file/defaults.md
@@ -4,33 +4,31 @@ sidebar_position: 1
 todo: For future maintenance, this page would be better setup to import single-sourced partials that also serve the cli/options page. However, for PoC, the duplication/poor maintainability is tollerated for now.
 ---
 
-While Besu is [highly-configurable](index.md#configuration-order-of-precedence), Besu's default configurations provide a viable boilerplate.
+# Default configurations 
 
+Besu is [highly-configurable](index.md#configuration-order-of-precedence), yet its default configurations provide a viable boilerplate.
 
-## Defaults overview
+This page provides a high level overview of the opinionated default configurations of vanilla Besu. By applying these defaults, a node is optimized for staking. These defaults may be used alongside a [pre-configured profile](profile.md) to support common use cases.
 
-The following provides a high level overview of the opinionated default configurations of vanilla Besu. By applying these defaults, a node is optimized for staking. These defaults may be used alongside a [pre-configured profile](profile.md) to support common use cases.
 
-:::note
-
-For example, applying the [staking profile](profile.md#staker-profile) with the boilerplate config directs Besu to use mainnet &mdash; instantiating a staking-optimized node ready to be run alongside a [validator](https://ethereum.org/en/developers/docs/nodes-and-clients/node-architecture/#validators) and [consensus client](https://ethereum.org/en/developers/docs/nodes-and-clients/node-architecture/#consensus-client).
+For example, using the [staking profile](profile.md#staker-profile) with the boilerplate config directs Besu to use mainnet &mdash; instantiating a staking-optimized node ready to be run alongside a [validator](https://ethereum.org/en/developers/docs/nodes-and-clients/node-architecture/#validators) and [consensus client](https://ethereum.org/en/developers/docs/nodes-and-clients/node-architecture/#consensus-client).
 
 :::
 
-### Configuration
+## Configuration
 
 |Command|Default|Notes|
 |---------------------------|--------------------|------------------------------------------|
 |[`config-file`](../../reference/cli/options/#config-file)|None|Vanilla Besu assumes no configuration file|
 
 
-### Storage
+## Storage
 
 |Command|Default|Notes|
 |---------------------------|--------------------|------------------------------------------|
 |[`data-storage-format`](../../reference/cli/options/#data-storage-format)|BONSAI|Besu applies the most space-effiecient storage method|
 
-### Peering
+## Peering
 
 |Command|Default|Notes|
 |---------------------------|--------------------|------------------------------------------|

diff --git a/docs/public-networks/how-to/use-configuration-file/profile.md b/docs/public-networks/how-to/use-configuration-file/profile.md
@@ -3,6 +3,8 @@ title: Use a profile
 sidebar_position: 2
 ---
 
+# Use a profile 
+
 Load a profile using the [`--profile` CLI option](../../reference/cli/options.md#profile).
 
 You can optionally use profiles to extend Besu's configuration. Combined with the [boilerplate configuration](defaults.md), profiles simplify the process of applying vaiable defaults. Besu's pre-configured profiles optimize for the following supported use cases:
@@ -19,65 +21,19 @@ A configuration explicitly set in the configuration file or command line will
 
 :::
 
-
-<!-- IMO this is all redundancy -- fully supported by the linked page above
-
-For example:
-
-```bash
-besu --config-file=config.toml --profile=staker
-```
-
-In this example, `config.toml` is the user-provided [configuration file](index.md), and `staker` is
-the pre-configured profile containing custom settings.
- -->
-
 ## Minimalist staker profile
 
-`--profile=minimalist_staker` is optimized for stakers who want to maximize their hardware value but don't want to serve full sets of data to their peers, See the
+[`--profile=minimalist_staker`](../../reference/cli/options.md#profile) is optimized for stakers who want to maximize their hardware value but don't want to serve full sets of data to their peers, See the
 [minimalist staker profile on GitHub](https://github.com/hyperledger/besu/blob/8b64023a121ea996ef60e4b7e2299c5807683f90/config/src/main/resources/profiles/minimalist-staker.toml)
 for the custom settings.
 
-<!-- IMO this is all redundancy -- fully supported by the linked page above
-
-To use the minimalist staker profile, run Besu with
-[`--profile`](../../reference/cli/options.md#profile) set to `minimalist_staker`:
-
-```bash
-besu --profile=minimalist_staker
-``` -->
-
 ## Staker profile
 
-`--profile=staker` is optimized for stakers who want to maximize their hardware value while also serving full sets of data to their peers. See the
+[`--profile=staker`](../../reference/cli/options.md#profile) is optimized for stakers who want to maximize their hardware value while also serving full sets of data to their peers. See the
 [staker profile on GitHub](https://github.com/hyperledger/besu/blob/8b64023a121ea996ef60e4b7e2299c5807683f90/config/src/main/resources/profiles/staker.toml)
 for the custom settings.
 
-<!-- IMO this is all redundancy -- fully supported by the linked page above
-
-To use the staker profile, run Besu with [`--profile`](../../reference/cli/options.md#profile) set to `staker`:
-
-```bash
-besu --profile=staker
-``` -->
-
 ## Enterprise/Private profile
 
-`--profile=private` / `--profile=enterprise` supports private network operators and enterprises by handling specific use cases that apply to private network operators. See the [enterprise/private profile on GitHub](https://github.com/hyperledger/besu/blob/8b64023a121ea996ef60e4b7e2299c5807683f90/config/src/main/resources/profiles/enterprise-private.toml)
+[`--profile=private` / `--profile=enterprise`](../../reference/cli/options.md#profile) supports private network operators and enterprises by handling specific use cases that apply to private network operators. See the [enterprise/private profile on GitHub](https://github.com/hyperledger/besu/blob/8b64023a121ea996ef60e4b7e2299c5807683f90/config/src/main/resources/profiles/enterprise-private.toml)
 for the custom settings.
-
-<!-- IMO this is all redundancy -- fully supported by the linked page above
-
-To use the enterprise/private profile, run Besu with
-[`--profile`](../../reference/cli/options.md#profile) set to `enterprise` or `private`:
-
-```bash
-besu --profile=enterprise
-```
-
-or
-
-```bash
-besu --profile=private
-```
- -->