Update site configuration (#460)

* Update site configuration * npm install * fix attempt * prettier-ignore * prettier-ignore * update readme
Consensys · Jun 23, 2023 · 0d45098 · 0d45098 · vercel · Jun 23, 2023
1 parent 645edce
commit 0d45098
Show file tree

Hide file tree

Showing 19 changed files with 747 additions and 886 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
diff --git a/.github/ISSUE_TEMPLATE/content_issue.md b/.github/ISSUE_TEMPLATE/content_issue.md
diff --git a/.github/ISSUE_TEMPLATE/tool_issue.md b/.github/ISSUE_TEMPLATE/tool_issue.md
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
diff --git a/.husky/commit-msg b/.husky/commit-msg
diff --git a/.husky/pre-commit b/.husky/pre-commit
diff --git a/.husky/prepare-commit-msg b/.husky/prepare-commit-msg
diff --git a/README.md b/README.md
@@ -1,21 +1,7 @@
-# ConsenSys Teku
+# Teku documentation
 
-This documentation repo is built using [Docusaurus 2](https://docusaurus.io/).
+This documentation repository is built using [Docusaurus](https://docusaurus.io/), and the doc
+site is published at [`docs.teku.consensys.net`](https://docs.teku.consensys.net/).
 
-See [more](https://docs-template.consensys.net/) information about using Docusaurus quickly.
-
-### Contributing & Local Development
-
-    $ npm install
-    $ npm run prepare
-    $ npm start
-    $ git commit
-
-This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
-
-### Build
-
-    $ npm run build
-    $ npm run serve
-
-This command generates static content into the `build` directory.
+View the [ConsenSys doc contribution guidelines](https://docs-template.consensys.net/) for
+information about submitting documentation changes and previewing the site locally.
diff --git a/docs/get-started/connect/_category_.json b/docs/get-started/connect/_category_.json
@@ -2,6 +2,7 @@
   "label": "Connect to a network",
   "position": 3,
   "link": {
-    "type": "generated-index"
+    "type": "generated-index",
+    "slug": "/get-started/connect"
   }
 }
diff --git a/docs/get-started/install/_category_.json b/docs/get-started/install/_category_.json
@@ -2,6 +2,7 @@
   "label": "Install Teku",
   "position": 1,
   "link": {
-    "type": "generated-index"
+    "type": "generated-index",
+    "slug": "/get-started/install"
   }
 }
diff --git a/docs/how-to/configure/_category_.json b/docs/how-to/configure/_category_.json
@@ -2,6 +2,7 @@
   "label": "Configure",
   "position": 1,
   "link": {
-    "type": "generated-index"
+    "type": "generated-index",
+    "slug": "/how-to/configure"
   }
 }
diff --git a/docs/how-to/find-and-connect/_category_.json b/docs/how-to/find-and-connect/_category_.json
@@ -2,6 +2,7 @@
   "label": "Find and connect to peers",
   "position": 3,
   "link": {
-    "type": "generated-index"
+    "type": "generated-index",
+    "slug": "how-to/find-and-connect"
   }
 }
diff --git a/docs/how-to/monitor/_category_.json b/docs/how-to/monitor/_category_.json
@@ -2,6 +2,7 @@
   "label": "Monitor nodes",
   "position": 4,
   "link": {
-    "type": "generated-index"
+    "type": "generated-index",
+    "slug": "/how-to/monitor"
   }
 }
diff --git a/docs/how-to/use-external-signer/_category_.json b/docs/how-to/use-external-signer/_category_.json
@@ -2,6 +2,7 @@
   "label": "Use an external signer",
   "position": 2,
   "link": {
-    "type": "generated-index"
+    "type": "generated-index",
+    "slug": "/how-to/use-external-signer"
   }
 }
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -180,16 +180,6 @@ const config = {
             className: "header-discord-link",
             position: "right",
           },
-          {
-            href: "https://twitter.com/consensys",
-            className: "header-twitter-link",
-            position: "right",
-          },
-          {
-            href: "https://hub.docker.com/r/consensys/teku",
-            className: "header-dockerhub-link",
-            position: "right",
-          },
         ],
       },
       footer: {
@@ -333,7 +323,7 @@ const config = {
           },
           {
             from: "/category/external-signing",
-            to: "/category/use-an-external-signer",
+            to: "/how-to/use-external-signer",
           },
           {
             from: "/HowTo/External-Signer/Use-External-Signer",
@@ -422,6 +412,47 @@ const config = {
             from: "/Reference/CLI/CLI-Syntax",
             to: "/reference/cli",
           },
+          {
+            from: "/category/get-started",
+            to: "/get-started",
+          },
+          {
+            from: "/category/install-teku",
+            to: "/get-started/install",
+          },
+          {
+            from: "/category/connect-to-a-network",
+            to: "/get-started/connect",
+          },
+          // prettier-ignore
+          {
+           from: "/category/how-to",
+           to: "/how-to",
+          },
+          {
+            from: "/category/configure",
+            to: "/how-to/configure",
+          },
+          {
+            from: "/category/use-an-external-signer",
+            to: "/how-to/use-external-signer",
+          },
+          {
+            from: "/category/find-and-connect-to-peers",
+            to: "/how-to/find-and-connect",
+          },
+          {
+            from: "/category/monitor-nodes",
+            to: "/how-to/monitor",
+          },
+          {
+            from: "/category/concepts",
+            to: "/concepts",
+          },
+          {
+            from: "/category/tutorials",
+            to: "/tutorials",
+          },
         ],
       },
     ],