Deleted use signing keys topic, updated links, and added redirect (#243)

* Deleted use signing keys topic, updated links, and added redirect Signed-off-by: madelinemurray <[email protected]> * Update docusaurus.config.js --------- Signed-off-by: madelinemurray <[email protected]> Co-authored-by: Alexandra Tran Carrillo <[email protected]>
Consensys · Dec 6, 2023 · 896afc3 · 896afc3 · vercel · Dec 6, 2023
1 parent cee6c73
commit 896afc3
Show file tree

Hide file tree

Showing 11 changed files with 20 additions and 285 deletions.
diff --git a/docs/get-started/start-web3signer.md b/docs/get-started/start-web3signer.md
@@ -109,9 +109,9 @@ Web3Signer by default also performs a health check on the
 
 <!-- Links -->
 
-[Signing key configuration files]: ../how-to/use-signing-keys.md
+[Signing key configuration files]: ../how-to/configure-access-keys.md#use-key-configuration-files
 [Teku]: https://docs.teku.consensys.net/how-to/use-external-signer/use-web3signer
 [subcommand]: ../reference/cli/subcommands.md
-[bulk load signing keys]: ../how-to/use-signing-keys.md#bulk-load-keys
+[bulk load signing keys]: ../how-to/configure-access-keys.md#bulk-load-keys
 [slashing protection]: ../concepts/slashing-protection.md
 [slashing protection database]: ../how-to/configure-slashing-protection.md
diff --git a/docs/how-to/monitor/metrics.md b/docs/how-to/monitor/metrics.md
@@ -118,7 +118,7 @@ The following Web3Signer metrics are available.
 | `<keytype>_signing_duration` | Duration of a signing event. |
 | `<keytype>_missing_identifier_count` | Number of signing requests for which no keys were available. |
 | `signers_loaded_count` | Total number of SECP256k1 and BLS12-381 keys loaded. |
-| `signing_private_key_retrieval_time` | Time taken to retrieve [BLS signing keys]. |
+| `signing_private_key_retrieval_time` | Time taken to retrieve BLS signing keys. |
 
 **Eth2 Slashing protection metrics:**
 
@@ -141,5 +141,4 @@ dashboard](https://grafana.com/grafana/dashboards/13687).
 <!-- Links -->
 
 [Start Teku]: https://docs.teku.consensys.net/how-to/use-external-signer/use-web3signer
-[BLS signing keys]: ../use-signing-keys.md
 [Grafana]: https://grafana.com/docs/grafana/latest/guides/getting_started/
diff --git a/docs/how-to/store-keys/hsm/usb-armory.md b/docs/how-to/store-keys/hsm/usb-armory.md
@@ -54,5 +54,5 @@ Alternatively you can manually create the file and add the certificate details i
 
 [USB Armory Mk II device]: https://www.f-secure.com/en/consulting/foundry/usb-armory
 [Interlock application]: https://github.com/f-secure-foundry/interlock/blob/master/README.md
-[Configure a signing key configuration file]: ../../use-signing-keys.md
+[Configure a signing key configuration file]: ../../configure-access-keys.md#use-key-configuration-files
 [key configuration file]: ../../../reference/key-config-file-params.md#usb-armory-mk-ii
diff --git a/docs/how-to/store-keys/hsm/yubihsm2.md b/docs/how-to/store-keys/hsm/yubihsm2.md
@@ -38,7 +38,7 @@ password must be specified in the [key configuration files] for a given device.
 [Store private keys in the device]: https://developers.yubico.com/YubiHSM2/Commands/Put_Opaque.html
 [YubiHSM 2 SDK]: https://developers.yubico.com/YubiHSM2/Releases/
 [Opaque Data algorithm]: https://developers.yubico.com/YubiHSM2/Concepts/Algorithms.html
-[Configure a signing key configuration file]: ../../use-signing-keys.md
+[Configure a signing key configuration file]: ../../configure-access-keys.md#use-key-configuration-files
 [YubiHSM connector]: https://developers.yubico.com/yubihsm-connector/
 [PKCS#11 module]: https://developers.yubico.com/YubiHSM2/Component_Reference/PKCS_11/
 [key configuration files]: ../../../reference/key-config-file-params.md#yubihsm-2
diff --git a/docs/how-to/store-keys/vaults/aws.md b/docs/how-to/store-keys/vaults/aws.md
@@ -36,7 +36,7 @@ secretsManagerClient.createSecret(secretRequest);
 ```
 
 You can also store multiple BLS private keys under same secret name when using
-[AWS bulk loading mode](../../use-signing-keys.md#aws-secrets-manager).
+[AWS bulk loading mode](../../configure-access-keys.md#aws-secrets-manager).
 
 The keys must be separated with a line terminating character such as `\n`.
 This saves cost when dealing with a large number of keys. Up to 200 keys can be stored under same
@@ -59,7 +59,7 @@ final CreateSecretRequest secretRequest =
 secretsManagerClient.createSecret(secretRequest);
 ```
 
-Specify the following when [configuring the signing key configuration file](../../use-signing-keys.md#use-key-configuration-files):
+Specify the following when [configuring the signing key configuration file](../../configure-access-keys.md#use-key-configuration-files):
 
 - Authentication mode.
   Valid options are `ENVIRONMENT` and `SPECIFIED`.

diff --git a/docs/how-to/store-keys/vaults/azure.md b/docs/how-to/store-keys/vaults/azure.md
@@ -45,8 +45,8 @@ Depending on the authentication mode, not all client credentials are available.
 
 <!-- links -->
 
-[configuring the signing key configuration file]: ../../use-signing-keys.md#azure-key-vault
-[bulk loading signing keys]: ../../use-signing-keys.md#bulk-load-keys
+[configuring the signing key configuration file]: ../../configure-access-keys.md#use-key-configuration-files
+[bulk loading signing keys]: ../../configure-access-keys.md#azure-key-vault
 [Register Web3Signer as an application]: https://docs.microsoft.com/en-us/azure/key-vault/general/authentication
 [add a signing key in Azure Key Vault]: https://docs.microsoft.com/en-us/azure/key-vault/secrets/quick-create-portal#add-a-secret-to-key-vault
 [Client secret]: https://docs.microsoft.com/en-us/azure/key-vault/secrets/about-secrets

diff --git a/docs/how-to/store-keys/vaults/hashicorp.md b/docs/how-to/store-keys/vaults/hashicorp.md
@@ -117,6 +117,6 @@ localhost:8200 7C:B3:3E:F9:98:43:5E:62:69:9F:A9:9D:41:14:03:BA:83:24:AC:04:CE:BD
 
 <!-- Links -->
 
-[signing key configuration file]: ../../use-signing-keys.md
+[signing key configuration file]: ../../configure-access-keys.md#use-key-configuration-files
 [Start Teku]: https://docs.teku.consensys.net/get-started/start-teku
 [Start Web3Signer and specify the location of the signing key configuration file]: ../../../get-started/start-web3signer.md
diff --git a/docs/how-to/use-signing-keys.md b/docs/how-to/use-signing-keys.md
diff --git a/docs/reference/cli/subcommands.md b/docs/reference/cli/subcommands.md
@@ -429,7 +429,7 @@ eth1.azure-vault-enabled: true
   </TabItem>
 </Tabs>
 
-Enables [bulk loading keys from Azure Key Vault](../../how-to/use-signing-keys.md#azure-key-vault).
+Enables [bulk loading keys from Azure Key Vault](../../how-to/configure-access-keys.md#azure-key-vault).
 The default is `false`.
 
 #### `azure-client-id`
@@ -1380,7 +1380,7 @@ eth2.aws-secrets-enabled: true
   </TabItem>
 </Tabs>
 
-Enables or disables [bulk loading keys from AWS Secrets Manager](../../how-to/use-signing-keys.md#aws-secrets-manager).
+Enables or disables [bulk loading keys from AWS Secrets Manager](../../how-to/configure-access-keys.md#aws-secrets-manager).
 The default is `false`.
 
 #### `aws-secrets-auth-mode`
@@ -1686,7 +1686,7 @@ eth2.azure-vault-enabled: true
   </TabItem>
 </Tabs>
 
-Enables [bulk loading keys from Azure Key Vault](../../how-to/use-signing-keys.md#azure-key-vault).
+Enables [bulk loading keys from Azure Key Vault](../../how-to/configure-access-keys.md#azure-key-vault).
 The default is `false`.
 
 #### `azure-client-id`
@@ -2083,7 +2083,7 @@ eth2.key-manager-api-enabled: true
   </TabItem>
 </Tabs>
 
-Enables the [key manager API](../../how-to/use-signing-keys.md#manage-keys).
+Enables the [key manager API](../../how-to/manage-keys.md).
 The default is `false`.
 
 #### `keystores-password-file`

diff --git a/docs/reference/key-config-file-params.md b/docs/reference/key-config-file-params.md
@@ -212,7 +212,7 @@ keyPath: /key1.txt
 
 <!-- Links -->
 
-[signing key configuration file]: ../how-to/use-signing-keys.md
+[signing key configuration file]: ../how-to/configure-access-keys.md#use-key-configuration-files
 [keystore file]: https://github.com/ethereum/EIPs/blob/master/EIPS/eip-2335.md
 [PKCS#11 module]: https://developers.yubico.com/YubiHSM2/Component_Reference/PKCS_11/
 [connector service]: https://developers.yubico.com/yubihsm-connector/