Skip to content

Commit c457eee

Browse files
update link workflow (#335)
* update link workflow * fix links * more fixes * ignore hashicorp urls
1 parent 4a33148 commit c457eee

File tree

14 files changed

+42
-89
lines changed

14 files changed

+42
-89
lines changed

.github/workflows/link-check.json

Lines changed: 0 additions & 70 deletions
This file was deleted.

.github/workflows/links.yml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,9 @@ jobs:
1111
linkCheck:
1212
name: Link Checking
1313
runs-on: ubuntu-latest
14-
strategy:
15-
matrix:
16-
file-extensions: [".md", ".mdx"]
1714
steps:
1815
- uses: actions/checkout@v4
1916
- name: LinkCheck
2017
uses: ConsenSys/github-actions/docs-link-check@main
2118
with:
22-
FILE_EXTENSION: ${{ matrix.file-extensions }}
19+
CONFIG_FILE: .linkspector.yml

.linkspector.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
dirs:
2+
- ./docs
3+
excludedDirs:
4+
- ./build
5+
- ./.vercel
6+
- ./.docusaurus
7+
- ./node_modules
8+
- ./version_docs
9+
useGitIgnore: true
10+
11+
ignorePatterns:
12+
- pattern: '^http(s)?://localhost'
13+
- pattern: '^http(s)?://127.0.0.1'
14+
- pattern: '^http(s)?://gitlab.com/ConsenSys/'
15+
- pattern: '^http(s)?://consensys.net'
16+
- pattern: '^http(s)?://.+.zendesk.com'
17+
- pattern: '^http(s)?://.+.etherscan.io'
18+
- pattern: '^http(s)?://help.figma.com'
19+
- pattern: '^http(s)?://metamask.io'
20+
- pattern: '^http(s)?://.*\.hashicorp\.com'
21+
- pattern: '^/img/'
22+
aliveStatusCodes:
23+
- 200
24+
- 206
25+
- 400
26+
- 403

docs/get-started/start-web3signer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ web3signer --key-store-path=/Users/me/keyFiles/ eth1
4141

4242
In the command line:
4343

44-
- Use the [`--key-store-path`](../reference/cli/options.md#key-store-path) option to specify the
44+
- Use the [`--key-store-path`](../reference/cli/options.md#key-config-path-key-store-path) option to specify the
4545
location of the signing key configuration files.
4646
- Specify the [subcommand] to indicate which signing mode to use.
4747
Valid subcommands are `eth2` and `eth1`.

docs/how-to/configure-tls.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ web3signer --key-store-path=/Users/me/keyFiles/ \
7070
The command line:
7171

7272
- Specifies the location of the signing key configuration files using the
73-
[`--key-store-path`](../reference/cli/options.md#key-store-path) option.
73+
[`--key-store-path`](../reference/cli/options.md#key-config-path-key-store-path) option.
7474
- Specifies the Web3Signer keystore using the
7575
[`--tls-keystore-file`](../reference/cli/options.md#tls-keystore-file) option.
7676
- Specifies the file that contains the password to decrypt the keystore using the
@@ -133,9 +133,9 @@ The command line:
133133
- Enables TLS using the
134134
[`--downstream-http-tls-enabled`](../reference/cli/subcommands.md#downstream-http-tls-enabled) option.
135135
- Specifies the keystore to present during authentication using the
136-
[`--downstream-http-tls-keystore-file`](../reference/cli/subcommands.md#downstream-http-tls-keystore-file) option.
136+
`--downstream-http-tls-keystore-file` option.
137137
- Specifies the file that contains the password to decrypt the keystore using the
138-
[`--downstream-http-tls-keystore-password-file`](../reference/cli/subcommands.md#downstream-http-tls-keystore-password-file) option.
138+
`--downstream-http-tls-keystore-password-file` option.
139139
- [Specifies the servers](#create-the-known-servers-file) to connect to using the
140140
[`--downstream-http-tls-known-servers-file`](../reference/cli/subcommands.md#downstream-http-tls-known-servers-file) option.
141141

docs/how-to/load-keys.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ single file by adding a triple-dash separator (`---`) between configurations.
3838
The configuration file must be YAML-formatted, and can use any naming format, but must have the `.yaml` extension.
3939

4040
Place one or more key configuration files in a single directory which you specify when starting Web3Signer.
41-
Use the [`--key-store-path`](../reference/cli/options.md#key-store-path) option to specify the
41+
Use the [`--key-store-path`](../reference/cli/options.md#key-config-path-key-store-path) option to specify the
4242
location of the key configuration files.
4343

4444
```bash

docs/how-to/store-keys/vaults/hashicorp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ sidebar_position: 1
99
import Tabs from '@theme/Tabs';
1010
import TabItem from '@theme/TabItem';
1111

12-
Web3Signer supports storing the signing key in [HashiCorp Vault](https://www.hashicorp.com/products/vault/).
12+
Web3Signer supports storing the signing key in [HashiCorp Vault](https://www.hashicorp.com/en/products/vault).
1313

1414
## Store a private key in HashiCorp Vault
1515

docs/reference/api/json-rpc.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_sign","params":["0x78e6e2365
9696
## `eth_signTransaction`
9797

9898
Signs a transaction that you can submit to Besu at a later time using
99-
[`eth_sendRawTransaction`](https://besu.hyperledger.org/stable/public-networks/reference/api#eth_sendrawtransaction).
99+
[`eth_sendRawTransaction`](https://besu.hyperledger.org/public-networks/reference/api#eth_sendrawtransaction).
100100

101101
### Parameters
102102

@@ -226,7 +226,7 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"eth_signTypedData","params":["0x
226226
Creates and signs a transaction using the signing key.
227227

228228
Web3Signer submits the signed transaction to Besu using
229-
[`eth_sendRawTransaction`](https://besu.hyperledger.org/stable/public-networks/reference/api#eth_sendrawtransaction).
229+
[`eth_sendRawTransaction`](https://besu.hyperledger.org/public-networks/reference/api#eth_sendrawtransaction).
230230

231231
### Parameters
232232

docs/reference/cli/subcommands.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -727,7 +727,7 @@ eth1.chain-id: "2017"
727727
</Tabs>
728728

729729
ID of the chain to receive the signed transactions. The Besu documentation
730-
lists [chain IDs for public networks](https://besu.hyperledger.org/development/public-networks/concepts/network-and-chain-id).
730+
lists [chain IDs for public networks](https://besu.hyperledger.org/public-networks/concepts/network-and-chain-id).
731731

732732
#### `downstream-http-host`
733733

versioned_docs/version-25.3.0/get-started/start-web3signer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ web3signer --key-store-path=/Users/me/keyFiles/ eth1
4141

4242
In the command line:
4343

44-
- Use the [`--key-store-path`](../reference/cli/options.md#key-store-path) option to specify the
44+
- Use the [`--key-store-path`](../reference/cli/options.md#key-config-path-key-store-path) option to specify the
4545
location of the signing key configuration files.
4646
- Specify the [subcommand] to indicate which signing mode to use.
4747
Valid subcommands are `eth2` and `eth1`.

0 commit comments

Comments
 (0)