docusaurus3 upgrade

Consensys · Nov 29, 2023 · f8d0eb0 · f8d0eb0
1 parent e783934
commit f8d0eb0
Show file tree

Hide file tree

Showing 14 changed files with 5,314 additions and 3,891 deletions.
diff --git a/.stylelintrc.js b/.stylelintrc.js
@@ -1,18 +1,10 @@
 module.exports = {
-  extends: ["stylelint-config-standard", "stylelint-config-prettier"],
-  rules: {
-    "selector-pseudo-class-no-unknown": [
-      true,
-      {
-        // :global is a CSS modules feature to escape from class name hashing
-        ignorePseudoClasses: ["global"],
-      },
-    ],
+  "extends": "stylelint-config-standard",
+  "rules": {
     "selector-class-pattern": null,
-    "custom-property-empty-line-before": null,
-    "selector-id-pattern": null,
-    "declaration-empty-line-before": null,
-    "comment-empty-line-before": null,
-    "value-keyword-case": ["lower", { camelCaseSvgKeywords: true }],
-  },
-};
+    "comment-empty-line-before" : null,
+    "media-feature-range-notation": null,
+    "selector-anb-no-unmatchable": null,
+    "declaration-block-no-duplicate-properties": null
+  }
+}
diff --git a/babel.config.js b/babel.config.js
diff --git a/docs/HowTo/Configure/Database.md b/docs/HowTo/Configure/Database.md
@@ -4,6 +4,9 @@ description: Database configuration
 sidebar_position: 8
 ---
 
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
 # Database configuration
 
 You can configure the [`jdbc`](../../Reference/SampleConfiguration.md#jdbc) item in the Tessera [configuration file](Tessera.md) to connect to an external database. You can specify any valid JDBC URL. Refer to your provider's details to construct a valid JDBC URL.
@@ -46,32 +49,35 @@ Jasypt encryption is currently only available for the `jdbc.password` field.
 1. Download and unzip [Jasypt](https://github.com/jasypt/jasypt) and navigate to the `bin` directory.
 1. Encrypt the password using the following command:
 
-   <!--tabs-->
+<Tabs>
+
+<TabItem value="Command" label="Command" default>  
 
-   # Command
+```bash
+./encrypt.sh input=dbpassword password=quorum
+```
 
-   ```bash
-   ./encrypt.sh input=dbpassword password=quorum
-   ```
+</TabItem>
+<TabItem value="Output" label="Output">
 
-   # Output
+    ```bash
+    ----ENVIRONMENT-----------------
 
-   ```bash
-   ----ENVIRONMENT-----------------
+    Runtime: Oracle Corporation Java HotSpot(TM) 64-Bit Server VM 25.171-b11
 
-   Runtime: Oracle Corporation Java HotSpot(TM) 64-Bit Server VM 25.171-b11
+    ----ARGUMENTS-------------------
 
-   ----ARGUMENTS-------------------
+    input: dbpassword
+    password: quorum
 
-   input: dbpassword
-   password: quorum
+    ----OUTPUT----------------------
 
-   ----OUTPUT----------------------
+    rJ70hNidkrpkTwHoVn2sGSp3h3uBWxjb
+    ```
 
-   rJ70hNidkrpkTwHoVn2sGSp3h3uBWxjb
-   ```
 
-   <!--tabs-->
+</TabItem>
+</Tabs>
 
 1. Place the wrapped output, `ENC(rJ70hNidkrpkTwHoVn2sGSp3h3uBWxjb)`, in the configuration JSON file.
 

diff --git a/docs/HowTo/Configure/Keys/File-Based-Key-Pairs.md b/docs/HowTo/Configure/Keys/File-Based-Key-Pairs.md
@@ -4,6 +4,9 @@ description: Configure file-based key pairs.
 sidebar_position: 4
 ---
 
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
 # File-based key pairs
 
 To configure Tessera to use file-based [key pairs](Overview.md), provide the location of the files in the [configuration file](../../../Reference/SampleConfiguration.md#keydata). You can use Tessera to [generate file-based keys].
@@ -28,9 +31,9 @@ The contents of the public key file must contain the public key only.
 
 The contents of the private key file must contain the private key in the [inline key pair](Inline-Key-Pairs.md) format.
 
-<!--tabs-->
+<Tabs>
 
-# Password protected
+  <TabItem value="Password protected" label="Password protected" default>
 
 ```json
 {
@@ -50,6 +53,8 @@ The contents of the private key file must contain the private key in the [inline
 ```
 
 # Unprotected
+  </TabItem>
+  <TabItem value="Unprotected" label="Unprotected" >
 
 :::danger "Security warning"
 
@@ -65,8 +70,8 @@ Inline unprotected keys are not secure because the private key is exposed. Do no
   }
 }
 ```
-
-<!--/tabs-->
+  </TabItem>
+</Tabs>
 
 Provide passwords using the following methods to ensure Tessera can decrypt and use the private keys.
 

diff --git a/docs/HowTo/Configure/TesseraAPI.md b/docs/HowTo/Configure/TesseraAPI.md
@@ -4,6 +4,9 @@ description: Configure servers for Tessera API
 sidebar_position: 5
 ---
 
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
 # Configure servers for Tessera API
 
 You can configure the [servers for the Tessera API](../../Reference/TesseraAPI.md) in the Tessera [configuration file](Tessera.md).
@@ -29,112 +32,115 @@ You can also [configure CORS](#configure-cors) for the `ThirdParty` server type.
 
 ### HTTP server configuration
 
-<!--tabs-->
-
-# Syntax
+<Tabs>
 
-```json
-{
-  "app": "<app type>",
-  "serverAddress": "http://[host]:[port]/[path]",
-  "communicationType": "REST"
-}
-```
+  <TabItem value="Syntax" label="Syntax" default>
 
-# ThirdParty example
-
-```json
-{
-  "app": "ThirdParty",
-  "serverAddress": "http://localhost:9081",
-  "communicationType": "REST"
-}
-```
+    ```json
+    {
+      "app": "<app type>",
+      "serverAddress": "http://[host]:[port]/[path]",
+      "communicationType": "REST"
+    }
+    ```
+  </TabItem>
+  <TabItem value="ThirdParty example" label="ThirdParty example">
+
+    ```json
+    {
+      "app": "ThirdParty",
+      "serverAddress": "http://localhost:9081",
+      "communicationType": "REST"
+    }
+    ```
 
-<!--/tabs-->
+  </TabItem>
+</Tabs>
 
 ### HTTPS server configuration
 
-<!--tabs-->
+<Tabs>
 
-# Syntax
+  <TabItem value="Syntax" label="Syntax" default>
 
-```json
-{
-    "app": "<app type>",
-    "serverAddress": "https://[host]:[port]/[path]",
-    "communicationType" : "REST",
-    "sslConfig": {
-        <SSL settings>
+    ```json
+    {
+        "app": "<app type>",
+        "serverAddress": "https://[host]:[port]/[path]",
+        "communicationType" : "REST",
+        "sslConfig": {
+            <SSL settings>
+        }
     }
-}
-```
-
-# P2P example
-
-```json
-{
-  "app": "P2P",
-  "serverAddress": "http://localhost:9001",
-  "sslConfig": {
-    "tls": "enum STRICT,OFF",
-    "generateKeyStoreIfNotExisted": "boolean",
-    "serverKeyStore": "Path",
-    "serverTlsKeyPath": "Path",
-    "serverTlsCertificatePath": "Path",
-    "serverKeyStorePassword": "String",
-    "serverTrustStore": "Path",
-    "serverTrustCertificates": ["Path"],
-    "serverTrustStorePassword": "String",
-    "serverTrustMode": "TOFU",
-    "clientKeyStore": "Path",
-    "clientTlsKeyPath": "Path",
-    "clientTlsCertificatePath": "Path",
-    "clientKeyStorePassword": "String",
-    "clientTrustStore": "Path",
-    "clientTrustCertificates": ["Path"],
-    "clientTrustStorePassword": "String",
-    "clientTrustMode": "TOFU",
-    "knownClientsFile": "Path",
-    "knownServersFile": "Path"
-  },
-  "communicationType": "REST",
-  "properties": {
-    "partyInfoInterval": "Long",
-    "enclaveKeySyncInterval": "Long",
-    "syncInterval": "Long",
-    "resendWaitTime": "Long"
-  }
-}
-```
+    ```
+  </TabItem>
+  <TabItem value="P2P example" label="P2P example">
+
+    ```json
+    {
+      "app": "P2P",
+      "serverAddress": "http://localhost:9001",
+      "sslConfig": {
+        "tls": "enum STRICT,OFF",
+        "generateKeyStoreIfNotExisted": "boolean",
+        "serverKeyStore": "Path",
+        "serverTlsKeyPath": "Path",
+        "serverTlsCertificatePath": "Path",
+        "serverKeyStorePassword": "String",
+        "serverTrustStore": "Path",
+        "serverTrustCertificates": ["Path"],
+        "serverTrustStorePassword": "String",
+        "serverTrustMode": "TOFU",
+        "clientKeyStore": "Path",
+        "clientTlsKeyPath": "Path",
+        "clientTlsCertificatePath": "Path",
+        "clientKeyStorePassword": "String",
+        "clientTrustStore": "Path",
+        "clientTrustCertificates": ["Path"],
+        "clientTrustStorePassword": "String",
+        "clientTrustMode": "TOFU",
+        "knownClientsFile": "Path",
+        "knownServersFile": "Path"
+      },
+      "communicationType": "REST",
+      "properties": {
+        "partyInfoInterval": "Long",
+        "enclaveKeySyncInterval": "Long",
+        "syncInterval": "Long",
+        "resendWaitTime": "Long"
+      }
+    }
+    ```
 
-<!--/tabs-->
+  </TabItem>
+</Tabs>
 
 ### Unix socket server configuration
 
-<!--tabs-->
+<Tabs>
 
-# Syntax
+  <TabItem value="Syntax" label="Syntax" default>
 
-```json
-{
-  "app": "<app type>",
-  "serverAddress": "unix://[path]",
-  "communicationType": "REST"
-}
-```
-
-# Q2T Example
-
-```json
-{
-  "app": "Q2T",
-  "serverAddress": "unix:/tmp/tm.ipc",
-  "communicationType": "REST"
-}
-```
+    ```json
+    {
+      "app": "<app type>",
+      "serverAddress": "unix://[path]",
+      "communicationType": "REST"
+    }
+    ```
+  </TabItem>
+  <TabItem value="Q2T example" label="Q2T example">
+
+    ```json
+    {
+      "app": "Q2T",
+      "serverAddress": "unix:/tmp/tm.ipc",
+      "communicationType": "REST"
+    }
+    ```
 
-<!--/tabs-->
+  </TabItem>
+</Tabs>
 
 ### Configure CORS
 

diff --git a/docs/HowTo/Generate-Keys/File-Stored-Keys.md b/docs/HowTo/Generate-Keys/File-Stored-Keys.md
@@ -4,6 +4,9 @@ description: How to generate file-stored keys
 sidebar_position: 2
 ---
 
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
 # Store keys in files
 
 You can generate a private and public key pair and store it in files.
@@ -52,21 +55,23 @@ tessera -updatepassword --keys.keyData.privateKeyPath /path/to/.key
 
 - Change the password of a locked key. This requires providing the current password for the key (either inline or as a file):
 
-<!--tabs-->
+<Tabs>
 
-# Inline
+  <TabItem value="Inline" label="Inline" default>
 
 ```bash
 tessera -updatepassword --keys.keyData.privateKeyPath /path/to/.key --keys.passwords <password>
 ```
 
-# File
+  </TabItem>
+  <TabItem value="File" label="File" >
 
 ```bash
 tessera -updatepassword --keys.keyData.privateKeyPath /path/to/.key --keys.passwordFile /path/to/pwds
 ```
 
-<!--/tabs-->
+  </TabItem>
+</Tabs>
 
 - Use different Argon2 options from the defaults when updating the password. You only need to provide options if you wish to override their defaults: