Versioning for Teku Docs. (#474)

* Versioning for Teku Docs. Signed-off-by: bgravenorst <[email protected]> * Update JS script. Signed-off-by: bgravenorst <[email protected]> * Fix prettier errors. Signed-off-by: bgravenorst <[email protected]> * Fix redirects. Signed-off-by: bgravenorst <[email protected]> * Fix prettier errors. Signed-off-by: bgravenorst <[email protected]> * Redirect error. Signed-off-by: bgravenorst <[email protected]> * Broken links. Signed-off-by: bgravenorst <[email protected]> * Broken links. Signed-off-by: bgravenorst <[email protected]> * Broken links. Signed-off-by: bgravenorst <[email protected]> * Update themes. Signed-off-by: bgravenorst <[email protected]> * Remove redocusaurus. Signed-off-by: bgravenorst <[email protected]> * test vercel redirect Signed-off-by: Eric Lin <[email protected]> * redirect fix 1 Signed-off-by: Eric Lin <[email protected]> * redirect fix 2 Signed-off-by: Eric Lin <[email protected]> * redirect fix 3 Signed-off-by: Eric Lin <[email protected]> * redirect fix 4 Signed-off-by: Eric Lin <[email protected]> * undo redirect due to infinite Signed-off-by: Eric Lin <[email protected]> * remove client redirect Signed-off-by: Eric Lin <[email protected]> * remove hardcode redirects Signed-off-by: Eric Lin <[email protected]> * revert changes Signed-off-by: Eric Lin <[email protected]> * omit stable path Signed-off-by: Eric Lin <[email protected]> * footer links Signed-off-by: Eric Lin <[email protected]> * adding in redirects back and fixing latest->next * test next-> development as path Signed-off-by: Joshua Fernandes <[email protected]> --------- Signed-off-by: bgravenorst <[email protected]> Signed-off-by: Eric Lin <[email protected]> Signed-off-by: Joshua Fernandes <[email protected]> Co-authored-by: Eric Lin <[email protected]> Co-authored-by: Joshua Fernandes <[email protected]>
Consensys · Jul 31, 2023 · 2ae92a2 · 2ae92a2 · vercel · Jul 31, 2023
1 parent 60e3b61
commit 2ae92a2
Show file tree

Hide file tree

Showing 71 changed files with 11,167 additions and 616 deletions.
diff --git a/docs/concepts/merge.md b/docs/concepts/merge.md
@@ -25,13 +25,13 @@ You can run Teku as a consensus client with:
 
 After The Merge, a full Ethereum Mainnet node is a combination of an execution client (previously called an [Ethereum 1.0](https://blog.ethereum.org/2022/01/24/the-great-eth2-renaming/) client) and a consensus client (previously called an [Ethereum 2.0](https://blog.ethereum.org/2022/01/24/the-great-eth2-renaming/) client).
 
-Execution and consensus clients communicate with each other using the [Engine API](https://besu.hyperledger.org/en/latest/HowTo/Interact/APIs/Engine-API/).
+Execution and consensus clients communicate with each other using the [Engine API](https://besu.hyperledger.org/development/public-networks/how-to/use-engine-api).
 
 ![Ethereum Merge node](../images/execution-consensus-clients.png)
 
 ### Execution clients
 
-Execution clients, such as [Besu](https://besu.hyperledger.org/en/stable/), manage the execution layer, including executing transactions and updating the world state. Execution clients serve [JSON-RPC API](https://besu.hyperledger.org/en/stable/Reference/API-Methods/) requests and communicate with each other in a peer-to-peer network.
+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 communicate with each other in a peer-to-peer network.
 
 ### Consensus clients
 

diff --git a/docs/how-to/configure/tls.md b/docs/how-to/configure/tls.md
@@ -76,6 +76,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
-[Hyperledger Besu]: https://besu.hyperledger.org/en/stable/HowTo/Get-Started/Installation-Options/Options/
+[Hyperledger Besu]: https://besu.hyperledger.org/stable/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/
diff --git a/docs/reference/rest.md b/docs/reference/rest.md
@@ -83,6 +83,6 @@ When enabling the API documentation endpoint, specify:
 
 <!-- Links -->
 
-[REST API documentation]: /api
+[REST API documentation]: https://consensys.github.io/teku/
 [Postman]: https://www.postman.com/
 [cURL]: https://curl.haxx.se/
diff --git a/docs/tutorials/configure-external-signer-tls.md b/docs/tutorials/configure-external-signer-tls.md
@@ -172,7 +172,7 @@ teku --network=goerli \
 <!-- links -->
 
 [Web3Signer]: https://docs.web3signer.consensys.net/en/latest/
-[Hyperledger Besu]: https://besu.hyperledger.org/en/stable/HowTo/Get-Started/Installation-Options/Options/
+[Hyperledger Besu]: https://besu.hyperledger.org/development/public-networks/get-started/install
 [Infura]: https://infura.io/
-[ETH1 Goerli node]: https://besu.hyperledger.org/en/stable/HowTo/Get-Started/Starting-node/#run-a-node-on-goerli-testnet
+[ETH1 Goerli node]: https://besu.hyperledger.org/development/public-networks/get-started/start-node#run-a-node-on-goerli-testnet
 [Web3Signer slashing protection]: https://docs.web3signer.consensys.net/en/latest/Concepts/Slashing-Protection/
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -4,40 +4,6 @@ const darkCodeTheme = require("prism-react-renderer/themes/dracula");
 const isDev = process.env.NODE_ENV === "development";
 const baseUrl = isDev ? "/" : "/";
 
-/**
- * @type {import('redocusaurus').PresetEntry}
- */
-const redocusaurus = [
-  "redocusaurus",
-  {
-    specs: [
-      {
-        id: "using-remote-url",
-        // Remote File
-        spec: "https://raw.githubusercontent.com/ConsenSys/teku/gh-pages/latest.json",
-        route: "/api/",
-      },
-    ],
-    theme: {
-      /**
-       * Highlight color for docs
-       */
-      primaryColor: "#ed774f",
-      primaryColorDark: "#ed774f",
-      /**
-       * Options to pass to redoc
-       * @see https://github.com/redocly/redoc#redoc-options-object
-       */
-      options: { disableSearch: true },
-      /**
-       * Options to pass to override RedocThemeObject
-       * @see https://github.com/Redocly/redoc#redoc-theme-object
-       */
-      theme: {},
-    },
-  },
-];
-
 /** @type {import('@docusaurus/types').Config} */
 const config = {
   title: "Teku documentation",
@@ -70,8 +36,22 @@ const config = {
           sidebarPath: require.resolve("./sidebars.js"),
           // Set a base path separate from default /docs
           editUrl: "https://github.com/ConsenSys/doc.teku/tree/master/",
-          path: "docs",
           routeBasePath: "/",
+          path: "./docs",
+          includeCurrentVersion: true,
+          lastVersion: "23.6.2",
+          versions: {
+            //defaults to the ./docs folder
+            // using 'development' instead of 'next' as path
+            current: {
+              label: "development",
+              path: "development",
+            },
+            //the last stable release in the versioned_docs/version-stable
+            "23.6.2": {
+              label: "stable (23.6.2)",
+            },
+          },
           // @ts-ignore
           // eslint-disable-next-line global-require
           remarkPlugins: [require("remark-docusaurus-tabs")],
@@ -84,14 +64,12 @@ const config = {
           ],
           showLastUpdateAuthor: false,
           showLastUpdateTime: true,
-          includeCurrentVersion: true,
         },
         theme: {
           customCss: require.resolve("./src/css/custom.css"),
         },
       },
     ],
-    redocusaurus,
   ],
 
   themeConfig:
@@ -168,7 +146,12 @@ const config = {
           },
           {
             label: "API",
-            to: "/api/",
+            to: "https://consensys.github.io/teku/",
+          },
+          {
+            type: "docsVersionDropdown",
+            position: "right",
+            dropdownActiveClassDisabled: true,
           },
           {
             href: "https://github.com/ConsenSys/teku",
@@ -190,19 +173,19 @@ const config = {
             items: [
               {
                 label: "Introduction",
-                to: "introduction",
+                to: "/introduction",
               },
               {
                 label: "Get started",
-                to: "/category/get-started",
+                to: "/get-started",
               },
               {
                 label: "How to guides",
-                to: "/category/how-to",
+                to: "/how-to",
               },
               {
                 label: "Tutorials",
-                to: "/category/tutorials",
+                to: "/tutorials",
               },
             ],
           },
@@ -211,7 +194,7 @@ const config = {
             items: [
               {
                 label: "Command line",
-                to: "reference/cli",
+                to: "/reference/cli",
               },
               {
                 label: "REST API",
@@ -424,10 +407,9 @@ const config = {
             from: "/category/connect-to-a-network",
             to: "/get-started/connect",
           },
-          // prettier-ignore
           {
-           from: "/category/how-to",
-           to: "/how-to",
+            from: "/category/how-to",
+            to: "/how-to",
           },
           {
             from: "/category/configure",