update link workflow (#681)

* update link workflow

* add fail_level: any

* revert change

* add config file

* remove unrelated / regex that exceeds max length

* remove versioned docs, fix anchor links

* fix links

* try removing complex ignorePatterns

* debug logs

* remove bad configs

* fix some links

* update config file path

* update config path and more link fixes

* move config file, exclude versioned docs, other fixes

* fix more links, test new action config

* fix links

* fix lint errors

* lint fixes

Author: alexandratran

.github/workflows/link-check.json

@@ -11,12 +11,9 @@ jobs:
   linkCheck:
     name: Link Checking
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        file-extensions: [".md", ".mdx"]
     steps:
       - uses: actions/checkout@v4
       - name: LinkCheck
         uses: ConsenSys/github-actions/docs-link-check@main
         with:
-          FILE_EXTENSION: ${{ matrix.file-extensions }}
+          CONFIG_FILE: .linkspector.yml

.github/workflows/links.yml

@@ -0,0 +1,24 @@
+dirs:
+  - ./docs
+excludedDirs:
+  - ./build
+  - ./.vercel
+  - ./.docusaurus
+  - ./node_modules
+  - ./versioned_docs
+useGitIgnore: true
+
+ignorePatterns:
+- pattern: '^http(s)?://localhost'
+- pattern: '^http(s)?://127.0.0.1'
+- pattern: '^http(s)?://gitlab.com/ConsenSys/'
+- pattern: '^http(s)?://consensys.net'
+- pattern: '^http(s)?://.+.zendesk.com'
+- pattern: '^http(s)?://.+.etherscan.io'
+- pattern: '^http(s)?://help.figma.com'
+- pattern: '^http(s)?://metamask.io'
+aliveStatusCodes:
+- 200
+- 206
+- 400
+- 403

.linkspector.yml

@@ -20,15 +20,15 @@ proof of work to [proof of stake consensus](proof-of-stake.md).
 
 :::
 
-Execution and consensus clients communicate with each other using the [Engine API](https://besu.hyperledger.org/development/public-networks/how-to/use-engine-api).
+Execution and consensus clients communicate with each other using the [Engine API](https://besu.hyperledger.org/public-networks/how-to/use-engine-api).
 
 ![Ethereum node](../images/execution-consensus-clients.png)
 
 ### Execution clients
 
 Execution clients, such as [Besu](https://besu.hyperledger.org/), manage the execution layer, including
 executing transactions and updating the world state. Execution clients serve
-[JSON-RPC API](https://besu.hyperledger.org/development/public-networks/reference/api) requests and
+[JSON-RPC API](https://besu.hyperledger.org/public-networks/reference/api) requests and
 communicate with each other in a peer-to-peer network.
 
 ### Consensus clients
@@ -42,4 +42,4 @@ clients serve [REST API](../reference/rest.md) requests and communicate with eac
 
 To become a validator, you must also run a validator client (either [in the same process as the beacon node](../get-started/start-teku.md#start-the-clients-in-a-single-process) or [separately](../get-started/start-teku.md#run-the-clients-separately)).
 
-:::
+:::

docs/concepts/node-types.md

@@ -7,7 +7,7 @@ sidebar_position: 3
 # Proof of stake
 
 In Ethereum's [proof of stake (PoS)](https://ethereum.org/en/developers/docs/consensus-mechanisms/pos/), you
-must run a [full node](node-types.md#execution-and-consensus-clients) and
+must run a [full node](node-types.md) and
 [stake 32 ETH](https://ethereum.org/en/staking/) to become a validator.
 
 :::note
@@ -19,11 +19,14 @@ must also run a validator client either [in the same process as the beacon node]
 
 The PoS mechanism randomly chooses validators to propose or validate blocks on the [Beacon Chain](https://ethereum.org/en/upgrades/beacon-chain/) in defined time frames.
 
-Proposers are responsible for proposing new consensus blocks, and non-proposing validators are responsible for validating (attesting to) proposed blocks. Validators are rewarded for proposing and attesting to consensus blocks eventually included in the Beacon Chain, and penalized for malicious behavior. Validators also receive transaction fees for included blocks.
+Proposers are responsible for proposing new consensus blocks, and non-proposing validators are responsible for validating (attesting to) proposed blocks.
+Validators are rewarded for proposing and attesting to consensus blocks eventually included in the Beacon Chain, and penalized for malicious behavior.
+Validators also receive transaction fees for included blocks.
 
 Each consensus block contains an execution payload, which contains a list of transactions and other data required to execute and validate the payload.
 
-When a node validates a consensus block, its [consensus client](node-types.md#execution-and-consensus-clients) processes the block and sends the execution payload to the [execution client](node-types.md#execution-and-consensus-clients), which:
+When a node validates a consensus block, its [consensus client](node-types.md#consensus-clients) processes the block
+and sends the execution payload to the [execution client](node-types.md#execution-clients), which:
 
 1. Assembles a block on the execution layer.
 1. Verifies pre-conditions.

docs/concepts/proof-of-stake.md

@@ -22,7 +22,7 @@ One [YAML file is stored per validator] in the format `<validator-pubkey>.yml` (
 
 :::note
 
-Set `<data-path>` using the [`--data-path`](../reference/cli/index.md#data-path) command line option.
+Set `<data-path>` using the [`--data-path`](../reference/cli/index.md#data-base-path-data-path) command line option.
 
 :::
 

docs/concepts/slashing-protection.md

@@ -9,7 +9,7 @@ sidebar_position: 1
 :::info
 
 Ethereum is a [proof-of-stake](../../concepts/proof-of-stake.md) network, and a full Ethereum node requires
-both [an execution client and a consensus client](../../concepts/node-types.md#execution-and-consensus-clients).
+both [an execution client and a consensus client](../../concepts/node-types.md).
 
 :::
 
@@ -132,9 +132,10 @@ Specify:
 - The URL of a checkpoint sync endpoint using the
   [`--checkpoint-sync-url`](../../reference/cli/index.md#checkpoint-sync-url) option.
 - An Ethereum address you own as the default fee recipient using the [`--validators-proposer-default-fee-recipient`](../../reference/cli/index.md#validators-proposer-default-fee-recipient) option.
-- The paths to the keystore `.json` file and password `.txt` file created in [step 2](#create-a-password-file-for-each-validator-key) for each validator using the [`--validator-keys`](../../reference/cli/index.md#validator-keys) option.
-Separate the `.json` and `.txt` files with a colon, and separate entries for multiple validators with commas.
-Alternatively, specify paths to directories to load multiple keys and passwords from.
+- The paths to the keystore `.json` file and password `.txt` file created in [step 2](#create-a-password-file-for-each-validator-key)
+  for each validator using the [`--validator-keys`](../../reference/cli/index.md#validator-keys) option.
+  Separate the `.json` and `.txt` files with a colon, and separate entries for multiple validators with commas.
+  Alternatively, specify paths to directories to load multiple keys and passwords from.
 
 Also, in the command:
 
@@ -158,10 +159,12 @@ teku validator-client \
 
 Specify:
 
-- The location of one or more beacon node API endpoints using the [`--beacon-node-api-endpoint`](../../reference/cli/subcommands/validator-client.md#beacon-node-api-endpoint-beacon-node-api-endpoints) option.
-- The paths to the keystore `.json` file and password `.txt` file created in [step 2](#create-a-password-file-for-each-validator-key) for each validator using the [`--validator-keys`](../../reference/cli/index.md#validator-keys) option. 
-Separate the `.json` and `.txt` files with a colon, and separate entries for multiple validators with commas. 
-Alternatively, specify paths to directories to load multiple keys and passwords from.
+- The location of one or more beacon node API endpoints using the
+  [`--beacon-node-api-endpoint`](../../reference/cli/subcommands/validator-client.md#beacon-node-api-endpoint-beacon-node-api-endpoints) option.
+- The paths to the keystore `.json` file and password `.txt` file created in [step 2](#create-a-password-file-for-each-validator-key)
+  for each validator using the [`--validator-keys`](../../reference/cli/index.md#validator-keys) option.
+  Separate the `.json` and `.txt` files with a colon, and separate entries for multiple validators with commas.
+  Alternatively, specify paths to directories to load multiple keys and passwords from.
 
 ## 5. Wait for the clients to sync
 

docs/get-started/connect/mainnet.md

@@ -23,16 +23,27 @@ Display the Teku command line help using the Docker image
 docker run consensys/teku:latest --help
 ```
 
-You can specify [Teku environment variables](../../reference/cli/index.md#teku-environment-variables) with the docker image instead of the command line options.
+You can specify [Teku environment variables](../../reference/cli/index.md#specify-options) with the docker image instead of the command line options.
 
 ```bash title="Example using Environment variables and CLI options"
-docker run -d -p 9000:9000/tcp -p 9000:9000/udp -p 5051:5051 -e TEKU_REST_API_ENABLED=true -e TEKU_P2P_PORT=9000 --mount type=bind,source=/Users/user1/teku/,target=/var/lib/teku consensys/teku:latest --network=holesky --eth1-endpoint=http://102.10.10.1:8545 --validator-keys=/var/lib/teku/validator/keys:/var/lib/teku/validator/passwords --data-path=/var/lib/teku --log-destination=CONSOLE
+docker run -d                             \
+  -p 9000:9000/tcp                        \
+  -p 9000:9000/udp                        \
+  -p 5051:5051                            \
+  -e TEKU_REST_API_ENABLED=true           \
+  -e TEKU_P2P_PORT=9000                   \
+  --mount type=bind,source=/Users/user1/teku/,target=/var/lib/teku consensys/teku:latest \
+  --network=holesky                       \
+  --eth1-endpoint=http://102.10.10.1:8545 \
+  --validator-keys=/var/lib/teku/validator/keys:/var/lib/teku/validator/passwords \
+  --data-path=/var/lib/teku               \
+  --log-destination=CONSOLE
 ```
 
 :::tip
 
 - If running Docker in the background, set [`--log-destination`](../../reference/cli/index.md#log-destination) to `console` to send all logs to the console and appear in Docker's log output.
-- Set [`--data-path`](../../reference/cli/index.md#data-path) to a mount point to ensure Teku data is not lost in the Docker filesystem.
+- Set [`--data-path`](../../reference/cli/index.md#data-base-path-data-path) to a mount point to ensure Teku data is not lost in the Docker filesystem.
 - [Set the Docker user to the UID of the normal user](#allow-multiple-users-to-run-the-docker-image) to ensure read/write access to the required files.
 
 :::
@@ -41,10 +52,19 @@ docker run -d -p 9000:9000/tcp -p 9000:9000/udp -p 5051:5051 -e TEKU_REST_API_EN
 
 If using a local volume to mount data, ensure the permissions on the directory allow other users and groups to read/write.
 
-Use the Docker [`--user`](https://docs.docker.com/engine/reference/commandline/run/) option to run the container for the specified user. Use the UID because the username may not exist inside the docker container.
+Use the Docker [`--user`](https://docs.docker.com/engine/reference/commandline/run/) option to run the container for the specified user.
+Use the UID because the username may not exist inside the docker container.
 
 ```bash title="Example"
-docker run -p 9000:9000/tcp -p 9000:9000/udp --user 1001:1001 --mount type=bind,source=/Users/user1/teku/,target=/var/lib/teku consensys/teku:latest --data-base-path=/var/lib/teku --network=holesky --eth1-endpoint=http://102.10.10.1:8545 --validator-keys=/var/lib/teku/validator/keys:/var/lib/teku/validator/passwords
+docker run                                \
+  -p 9000:9000/tcp                        \
+  -p 9000:9000/udp                        \
+  --user 1001:1001                        \
+  --mount type=bind,source=/Users/user1/teku/,target=/var/lib/teku consensys/teku:latest \
+  --data-base-path=/var/lib/teku          \
+  --network=holesky                       \
+  --eth1-endpoint=http://102.10.10.1:8545 \
+  --validator-keys=/var/lib/teku/validator/keys:/var/lib/teku/validator/passwords
 ```
 
 ## Exposing ports
@@ -59,11 +79,28 @@ Expose ports for P2P peer discovery, metrics, and REST APIs. Expose the default
 To run Teku exposing local ports for access:
 
 ```bash
-docker run -p <localportP2P>:30303/tcp -p <localportP2P>:30303/udp -p <localportREST>:5051 consensys/teku:latest --network=<NETWORK> --data-base-path=<DATA_DIR> --eth1-endpoint=<URL> --validator-keys=<KEY_DIR>:<PASS_DIR> --rest-api-enabled=true
+docker run                                      \
+  -p <localportP2P>:30303/tcp                   \
+  -p <localportP2P>:30303/udp                   \
+  -p <localportREST>:5051 consensys/teku:latest \
+  --network=<NETWORK>                           \
+  --data-base-path=<DATA_DIR>                   \
+  --eth1-endpoint=<URL>                         \
+  --validator-keys=<KEY_DIR>:<PASS_DIR>         \
+  --rest-api-enabled=true
 ```
 
 ```bash title="Example"
-docker run -p 30303:30303/tcp -p 30303:30303/udp -p 5051:5051 --mount type=bind,source=/Users/user1/teku/,target=/var/lib/teku consensys/teku:latest --network=holesky --data-base-path=/var/lib/teku --eth1-endpoint=http://102.10.10.1:8545 --validator-keys=/var/lib/teku/validator/keys:/var/lib/teku/validator/passwords --rest-api-enabled=true
+docker run                                \
+  -p 30303:30303/tcp                      \
+  -p 30303:30303/udp                      \
+  -p 5051:5051                            \
+  --mount type=bind,source=/Users/user1/teku/,target=/var/lib/teku consensys/teku:latest \
+  --network=holesky                       \
+  --data-base-path=/var/lib/teku          \
+  --eth1-endpoint=http://102.10.10.1:8545 \
+  --validator-keys=/var/lib/teku/validator/keys:/var/lib/teku/validator/passwords \
+  --rest-api-enabled=true
 ```
 
 ## Run Teku using Docker Compose

docs/get-started/install/run-docker-image.md

@@ -22,8 +22,8 @@ By default, Teku connects to `mainnet`. Use the [`--network`](../reference/cli/i
 ## Prerequisites
 
 - [Teku installed](install/install-binaries.md).
-- [An execution client synced](connect/mainnet.md#2-start-the-execution-client).
-- [Validator keystores and password files](connect/mainnet.md#3-generate-validator-keys-and-stake-eth).
+- [An execution client synced](connect/mainnet.md#3-start-the-execution-client).
+- [Validator keystores and password files](connect/mainnet.md#2-generate-validator-keys).
 
 ## Start the clients in a single process
 

docs/get-started/start-teku.md

@@ -80,6 +80,6 @@ In the command:
 [Known clients file]: ../../tutorials/configure-external-signer-tls.md#3-create-the-known-clients-file
 [Teku's password-protected PKCS12 or JKS keystore and password file]: ../../tutorials/configure-external-signer-tls.md#teku-keystore-and-password-file
 [Web3Signer's password-protected PKCS12 or JKS truststore and password file]: ../../tutorials/configure-external-signer-tls.md#2-create-the-truststore-and-password-file
-[Besu]: https://besu.hyperledger.org/stable/public-networks/get-started/install
+[Besu]: https://besu.hyperledger.org/public-networks/get-started/install
 [Slashing protection]: https://docs.web3signer.consensys.net/en/latest/concepts/slashing-protection/
 [configure your slashing protection database]: https://docs.web3signer.consensys.net/en/latest/HowTo/Configure-Slashing-Protection/