fix file path urls and redirects

Signed-off-by: Alexandra Tran <[email protected]>
Consensys · Nov 30, 2023 · d13bedb · d13bedb
1 parent 7bb0b07
commit d13bedb
Show file tree

Hide file tree

Showing 13 changed files with 44 additions and 48 deletions.
diff --git a/docs/concepts/tls.md b/docs/concepts/tls.md
@@ -14,4 +14,4 @@ The server (in this example, [Hyperledger Besu](https://besu.hyperledger.org/))
 to accept TLS connections.
 
 Use the command line options to configure TLS on [HTTP JSON-RPC requests](../how-to/configure-tls.md)
-and [HashiCorp Vault](../how-to/store-keys/store-keys-vaults/hashicorp.md).
+and [HashiCorp Vault](../how-to/store-keys/vaults/hashicorp.md).
diff --git a/...store-keys/store-keys-hsm/_category_.json → docs/how-to/store-keys/hsm/_category_.json b/...store-keys/store-keys-hsm/_category_.json → docs/how-to/store-keys/hsm/_category_.json
@@ -3,6 +3,6 @@
   "position": 3,
   "link": {
     "type": "generated-index",
-    "slug": "/how-to/store-keys-hsm"
+    "slug": "/how-to/store-keys/hsm"
   }
 }
diff --git a/...o/store-keys/store-keys-hsm/usb-armory.md → docs/how-to/store-keys/hsm/usb-armory.md b/...o/store-keys/store-keys-hsm/usb-armory.md → docs/how-to/store-keys/hsm/usb-armory.md
diff --git a/...-to/store-keys/store-keys-hsm/yubihsm2.md → docs/how-to/store-keys/hsm/yubihsm2.md b/...-to/store-keys/store-keys-hsm/yubihsm2.md → docs/how-to/store-keys/hsm/yubihsm2.md
diff --git a/docs/how-to/store-keys/store-keys.md → docs/how-to/store-keys/index.md b/docs/how-to/store-keys/store-keys.md → docs/how-to/store-keys/index.md
@@ -13,11 +13,11 @@ Web3Signer supports BLS12-381 or secp256k1 signing keys stored in:
 - Raw unencrypted files
 - [Keystore files](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-2335.md)
 - Vaults:
-  - [HashiCorp Vault](../store-keys/store-keys-vaults/hashicorp.md)
-  - [Azure Key Vault](../store-keys/store-keys-vaults/azure.md)
-  - [AWS Secrets Manager](../store-keys/store-keys-vaults/aws.md)
+  - [HashiCorp Vault](vaults/hashicorp.md)
+  - [Azure Key Vault](vaults/azure.md)
+  - [AWS Secrets Manager](vaults/aws.md)
 - Hardware Security Modules (HSMs):
-  - [YubiHSM 2](../store-keys/store-keys-hsm/yubihsm2.md)
-  - [USB Armory Mk II](../store-keys/store-keys-hsm/usb-armory.md)
+  - [YubiHSM 2](hsm/yubihsm2.md)
+  - [USB Armory Mk II](hsm/usb-armory.md)
 
 
diff --git a/...re-keys/store-keys-vaults/_category_.json → .../how-to/store-keys/vaults/_category_.json b/...re-keys/store-keys-vaults/_category_.json → .../how-to/store-keys/vaults/_category_.json
@@ -3,6 +3,6 @@
   "position": 3,
   "link": {
     "type": "generated-index",
-    "slug": "/how-to/store-keys-vaults"
+    "slug": "/how-to/store-keys/vaults"
   }
 }
diff --git a/...ow-to/store-keys/store-keys-vaults/aws.md → docs/how-to/store-keys/vaults/aws.md b/...ow-to/store-keys/store-keys-vaults/aws.md → docs/how-to/store-keys/vaults/aws.md
diff --git a/...-to/store-keys/store-keys-vaults/azure.md → docs/how-to/store-keys/vaults/azure.md b/...-to/store-keys/store-keys-vaults/azure.md → docs/how-to/store-keys/vaults/azure.md
diff --git a/...store-keys/store-keys-vaults/hashicorp.md → docs/how-to/store-keys/vaults/hashicorp.md b/...store-keys/store-keys-vaults/hashicorp.md → docs/how-to/store-keys/vaults/hashicorp.md
diff --git a/docs/how-to/use-signing-keys.md b/docs/how-to/use-signing-keys.md
@@ -13,12 +13,12 @@ Web3Signer supports BLS12-381 or secp256k1 signing keys stored in:
 - Raw unencrypted files
 - [Keystore files](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-2335.md)
 - Vaults:
-  - [HashiCorp Vault](store-keys/store-keys-vaults/hashicorp.md)
-  - [Azure Key Vault](store-keys/store-keys-vaults/azure.md)
-  - [AWS Secrets Manager](store-keys/store-keys-vaults/aws.md)
+  - [HashiCorp Vault](store-keys/vaults/hashicorp.md)
+  - [Azure Key Vault](store-keys/vaults/azure.md)
+  - [AWS Secrets Manager](store-keys/vaults/aws.md)
 - Hardware Security Modules (HSMs):
-  - [YubiHSM 2](store-keys/store-keys-hsm/yubihsm2.md)
-  - [USB Armory Mk II](store-keys/store-keys-hsm/usb-armory.md)
+  - [YubiHSM 2](store-keys/hsm/yubihsm2.md)
+  - [USB Armory Mk II](store-keys/hsm/usb-armory.md)
 
 You can configure access to the signing key by:
 

diff --git a/docs/reference/cli/subcommands.md b/docs/reference/cli/subcommands.md
@@ -975,7 +975,7 @@ eth2.aws-connection-cache-size: 5
   </TabItem>
 </Tabs>
 
-When [loading multiple keys from AWS Secrets Manager](../../how-to/store-keys/store-keys-vaults/aws.md#cache-aws-secrets-manager-when-loading-multiple-keys),
+When [loading multiple keys from AWS Secrets Manager](../../how-to/store-keys/vaults/aws.md#cache-aws-secrets-manager-when-loading-multiple-keys),
 set to the maximum number of connections to cache.
 The default is 1.
 

diff --git a/docs/reference/key-config-file-params.md b/docs/reference/key-config-file-params.md
@@ -57,7 +57,7 @@ keystorePasswordFile: "95e57532ede3c1dd879061153f9cfdcdefa9dc5fb9c954a6677bc6641
 
 ## HashiCorp Vault
 
-Use the private key stored in [HashiCorp Vault](../how-to/store-keys/store-keys-vaults/hashicorp.md).
+Use the private key stored in [HashiCorp Vault](../how-to/store-keys/vaults/hashicorp.md).
 
 ```bash
 type: "hashicorp"
@@ -88,7 +88,7 @@ token: "s.MuZwBqZ0iE1HzvD64v3HMlhT”
 
 ## Azure Key Vault
 
-Use the private key stored in [Azure Key Vault](../how-to/store-keys/store-keys-vaults/azure.md).
+Use the private key stored in [Azure Key Vault](../how-to/store-keys/vaults/azure.md).
 Supports two signing options:
 
 - `azure-key` - Performs the signing in Azure Key Vault.
@@ -137,7 +137,7 @@ keyName: "KeyName"
 
 ## AWS Secrets Manager
 
-Use the private key stored in [AWS Secrets Manager](../how-to/store-keys/store-keys-vaults/aws.md).
+Use the private key stored in [AWS Secrets Manager](../how-to/store-keys/vaults/aws.md).
 
 ```bash
 type: "aws-secret"
@@ -161,7 +161,7 @@ region: "us-west-2"
 
 ## YubiHSM 2
 
-Use the private key stored in the [YubiHSM 2 hardware security module](../how-to/store-keys/store-keys-hsm/yubihsm2.md).
+Use the private key stored in the [YubiHSM 2 hardware security module](../how-to/store-keys/hsm/yubihsm2.md).
 
 ```yaml
 type: yubihsm2
@@ -187,7 +187,7 @@ additionalInitConfig: debug libdebug timeout=5
 
 ## USB Armory Mk II
 
-Use the private key stored in the [USB Armory Mk II hardware security module](../how-to/store-keys/store-keys-hsm/usb-armory.md).
+Use the private key stored in the [USB Armory Mk II hardware security module](../how-to/store-keys/hsm/usb-armory.md).
 Web3Signer requires access to the [Interlock application] which must be installed on the device in
 order to access the keys.
 
@@ -217,4 +217,4 @@ keyPath: /key1.txt
 [PKCS#11 module]: https://developers.yubico.com/YubiHSM2/Component_Reference/PKCS_11/
 [connector service]: https://developers.yubico.com/yubihsm-connector/
 [Interlock application]: https://github.com/f-secure-foundry/interlock/blob/master/README.md
-[File used by Web3Signer]: ../how-to/store-keys/store-keys-hsm/usb-armory.md#known-server-file
+[File used by Web3Signer]: ../how-to/store-keys/hsm/usb-armory.md#known-server-file
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -301,23 +301,23 @@ const config = {
           },
           {
             from: "/HowTo/Store-Keys-HSM/Use-USB-Armory",
-            to: "/how-to/store-keys-hsm/usb-armory",
+            to: "/how-to/store-keys/hsm/usb-armory",
           },
           {
             from: "/HowTo/Store-Keys-HSM/Use-YubiHSM2",
-            to: "/how-to/store-keys-hsm/yubihsm2",
+            to: "/how-to/store-keys/hsm/yubihsm2",
           },
           {
             from: "/HowTo/Store-Keys-Vaults/Use-AWS",
-            to: "/how-to/store-keys-vaults/aws",
+            to: "/how-to/store-keys/vaults/aws",
           },
           {
             from: "/HowTo/Store-Keys-Vaults/Use-Azure",
-            to: "/how-to/store-keys-vaults/azure",
+            to: "/how-to/store-keys/vaults/azure",
           },
           {
             from: "/HowTo/Store-Keys-Vaults/Use-Hashicorp",
-            to: "/how-to/store-keys-vaults/hashicorp",
+            to: "/how-to/store-keys/vaults/hashicorp",
           },
           {
             from: "/HowTo/Configure-Slashing-Protection",
@@ -333,7 +333,7 @@ const config = {
           },
           {
             from: "/HowTo/Use-Configuration-File",
-            to: "/how-to/use-configuration-file",
+            to: "/how-to/use-configuration-file-starting-web3signer",
           },
           {
             from: "/HowTo/Use-Signing-Keys",
@@ -381,11 +381,11 @@ const config = {
           },
           {
             from: "/category/store-keys-in-an-hsm-device",
-            to: "/how-to/store-keys-hsm",
+            to: "/how-to/store-keys/hsm",
           },
           {
             from: "/category/store-keys-in-an-external-vault",
-            to: "/how-to/store-keys-vaults",
+            to: "/how-to/store-keys/vaults",
           },
           {
             from: "/category/apis",
@@ -396,40 +396,36 @@ const config = {
             to: "/reference/cli",
           },
           {
-            from: "/how-to/store-keys-hsm/_category_.json",
-            to: "/how-to/store-keys/store-keys-hsm/_category_.json",
+            from: "/how-to/store-keys-hsm",
+            to: "/how-to/store-keys/hsm",
           },
           {
-            from: "/how-to/store-keys-hsm/usb-armory.md",
-            to: "/how-to/store-keys/store-keys-hsm/usb-armory.md",
+            from: "/how-to/store-keys-hsm/usb-armory",
+            to: "/how-to/store-keys/hsm/usb-armory",
           },
           {
-            from: "/how-to/store-keys-hsm/yubihsm2.md",
-            to: "/how-to/store-keys/store-keys-hsm/yubihsm2.md",
+            from: "/how-to/store-keys-hsm/yubihsm2",
+            to: "/how-to/store-keys/hsm/yubihsm2",
           },
           {
-            from: "/how-to/store-keys-vaults/_category_.json",
-            to: "/how-to/store-keys/store-keys-vaults/_category_.json",
+            from: "/how-to/store-keys-vaults",
+            to: "/how-to/store-keys/vaults",
           },
           {
-            from: "/how-to/store-keys-vaults/aws.md",
-            to: "/how-to/store-keys/store-keys-vaults/aws.md",
+            from: "/how-to/store-keys-vaults/aws",
+            to: "/how-to/store-keys/vaults/aws",
           },
           {
-            from: "/how-to/store-keys-vaults/azure.md",
-            to: "/how-to/store-keys/store-keys-vaults/azure.md",
+            from: "/how-to/store-keys-vaults/azure",
+            to: "/how-to/store-keys/vaults/azure",
           },
           {
-            from: "/how-to/store-keys-vaults/hashicorp.md",
-            to: "/how-to/store-keys/store-keys-vaults/hashicorp.md",
+            from: "/how-to/store-keys-vaults/hashicorp",
+            to: "/how-to/store-keys/vaults/hashicorp",
           },
           {
-            from: "/how-to/use-configuration-file.md",
-            to: "/how-to/use-configuration-file-starting-web3signer.md",
-          },
-          {
-            from: "/how-to/use-signing-keys.md",
-            to: "/how-to/store-keys.md",
+            from: "/how-to/use-configuration-file",
+            to: "/how-to/use-configuration-file-starting-web3signer",
           },
           {
             from: "/how-to/deploy-with-kubernetes",