Merge pull request #485 from input-output-hk/jpraynaud/enhance-documentation-prerequisites

jpraynaud · web-flow · commit 3f9a99a8cff2 · 2022-09-07T12:58:04.000+02:00
Enhance documentation + Add dev blog in website
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -15,7 +15,7 @@ Should you have any questions or need some help in getting set up, you can use
 these communication channels to reach the Mithril team and get answers in a way
 where others can benefit from it as well:
 
-- #moria on the IOG [Discord server](https://discord.gg/beku2fg4)
+- #moria on the IOG [Discord server](https://discord.gg/5kaErDKDRq)
 - Github [Discussions](https://github.com/input-output-hk/mithril/discussions)
 - Cardano [StackExchange](https://cardano.stackexchange.com/) using the `mithril` tag
 
diff --git a/README.md b/README.md
@@ -74,7 +74,7 @@ The best way to contribute right now is to provide feedback. Start by giving a l
 
 Should you have any questions, ideas or issues, we would like to hear from you:
 
-* #moria on the IOG [Discord server](https://discord.gg/beku2fg4)
+* #moria on the IOG [Discord server](https://discord.gg/5kaErDKDRq)
 * Create a Github [Discussion](https://github.com/input-output-hk/mithril/discussions)
 * Create a Github [Issue](https://github.com/input-output-hk/mithril/issues/new)
 * Ask on Cardano [StackExchange](https://cardano.stackexchange.com/questions/tagged/mithril) using the `mithril` tag
diff --git a/demo/protocol-demo/README.md b/demo/protocol-demo/README.md
@@ -10,7 +10,7 @@ This cli implements a very simple version of the Mithril protocol for demonstrat
 
 **Install Rust**
 
-- Install a [correctly configured](https://www.rust-lang.org/learn/get-started) Rust toolchain (version 1.62.0+).
+- Install a [correctly configured](https://www.rust-lang.org/learn/get-started) Rust toolchain (latest stable version).
 
 ## Download source code
 
diff --git a/docs/blog/2022-09-07-genesis-certificate-feature.md b/docs/blog/2022-09-07-genesis-certificate-feature.md
@@ -0,0 +1,23 @@
+---
+title: Genesis Certificate support added
+authors:
+- name: Mithril Team
+tags: [genesis, breaking-change]
+---
+### This afternoon, we plan to merge the PR that activates the Genesis Certificate feature on the GCP Mithril Aggregator
+
+**PR**: `Implement Real Genesis Certificate` [#438](https://github.com/input-output-hk/mithril/pull/438)
+
+**Issue**: `Bootstrap Certificate Chain w/ Genesis Certificate` [#364](https://github.com/input-output-hk/mithril/issues/364)
+
+This will involve some manual operations that will prevent temporarily the service to be running:
+
+* We will have to reset the stores of the `Snapshots` and `Certificates`. This means that the [Mithril Explorer](https://mithril.network/explorer/) will display a `No snapshot available` message.
+
+* The Mithril Signers will have to wait until the next epoch `#30` to be able to sign. This means that we should see the first available `Snapshot` 1 hour after the epoch transition.
+
+The SPOs that are currently running a Mithril Signer will have to recompile their node in order ot take advantage of the latest improvements (such as the registration of the nodes that will take few minutes instead of few hours). However, the previously compiled node will be able to contribute to signatures.
+
+In order to restore a Mithril Snapshot, a Mithril Client will now need access to the `Genesis Verification Key` by adding an environment variable when running: `GENESIS_VERIFICATION_KEY=$(wget -q -O - https://raw.githubusercontent.com/input-output-hk/mithril/main/TEST_ONLY_genesis.vkey)`.
+
+Feel free to reach out to us on the [Discord channel](https://discord.gg/5kaErDKDRq) for questions and/or help.
diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
@@ -36,11 +36,11 @@ const config = {
           editUrl: 'https://github.com/input-output-hk/mithril/edit/main/docs',
         },
         blog: {
-          path: 'adr',
-          routeBasePath: 'adr/',
-          blogTitle: "ADR",
-          blogSidebarTitle: "ADR",
-          sortPosts: 'ascending',
+          path: 'blog/',
+          routeBasePath: 'dev-blog',
+          blogTitle: "Dev Blog",
+          blogSidebarTitle: "Dev blog",
+          sortPosts: 'descending',
           showReadingTime: true,
         },
         theme: {
@@ -68,6 +68,20 @@ const config = {
     ],
   ],
 
+  plugins: [
+    [
+      '@docusaurus/plugin-content-blog',
+      {
+        id: 'adr_blog',
+        path: 'adr',
+        routeBasePath: 'adr/',
+        blogTitle: "ADR",
+        blogSidebarTitle: "ADR",
+        sortPosts: 'descending',
+      }
+    ]
+  ],
+
   themeConfig:
     /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
     ({
@@ -109,6 +123,7 @@ const config = {
             label: 'Glossary',
             position: 'right',
           },
+          { to: '/dev-blog', label: 'Dev Blog', position: 'right' },
           { to: '/adr', label: 'ADRs', position: 'right' },
           {
             className: 'header-github-link',
@@ -142,7 +157,7 @@ const config = {
             items: [
               {
                 label: 'Discord (#moria)',
-                href: 'https://discord.gg/beku2fg4',
+                href: 'https://discord.gg/5kaErDKDRq',
               },
               {
                 label: 'Github Discussions',
diff --git a/docs/package.json b/docs/package.json
@@ -14,8 +14,8 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "^2.0.1",
-    "@docusaurus/preset-classic": "^2.0.1",
+    "@docusaurus/core": "^2.1.0",
+    "@docusaurus/preset-classic": "^2.1.0",
     "@mdx-js/react": "^1.6.22",
     "clsx": "^1.1.1",
     "react": "^17.0.2",
diff --git a/docs/root/manual/developer-docs/nodes/mithril-aggregator.md b/docs/root/manual/developer-docs/nodes/mithril-aggregator.md
@@ -26,7 +26,8 @@ This is the node of the **Mithril Network** responsible for collecting individua
 
 ## Pre-requisites
 
-* Install a [correctly configured](https://www.rust-lang.org/learn/get-started) Rust toolchain (version 1.62.0+).
+* Install a [correctly configured](https://www.rust-lang.org/learn/get-started) Rust toolchain (latest stable version)
+
 * Install OpenSSL development libraries, for example on Ubuntu/Debian/Mint run `apt install libssl-dev`
 
 ## Download source
diff --git a/docs/root/manual/developer-docs/nodes/mithril-client.md b/docs/root/manual/developer-docs/nodes/mithril-client.md
@@ -28,7 +28,9 @@ This is the node of the **Mithril Network** responsible for restoring the **Card
 
 ## Pre-requisites
 
-* Install a [correctly configured](https://www.rust-lang.org/learn/get-started) Rust toolchain (version 1.62.0+).
+* Install a [correctly configured](https://www.rust-lang.org/learn/get-started) Rust toolchain (latest stable version)
+
+* Install OpenSSL development libraries, for example on Ubuntu/Debian/Mint run `apt install libssl-dev`
 
 ## Download source
 
@@ -139,6 +141,16 @@ NETWORK=testnet AGGREGATOR_ENDPOINT=https://aggregator.api.mithril.network/aggre
 
 :::tip
 
+You can use the `--json` option in order to display results in `JSON` format for the `list` and `show` commands:
+
+```bash
+./mithril-client list --json
+```
+
+:::
+
+:::tip
+
 If you want to dig deeper, you can get access to several level of logs from the Mithril Client:
 
 * Add `-v` for some logs (WARN)
diff --git a/docs/root/manual/developer-docs/nodes/mithril-signer.md b/docs/root/manual/developer-docs/nodes/mithril-signer.md
@@ -28,7 +28,9 @@ This is the node of the **Mithril Network** responsible for producing individual
 
 ## Pre-requisites
 
-* Install a [correctly configured](https://www.rust-lang.org/learn/get-started) Rust toolchain (version 1.62.0+).
+* Install a [correctly configured](https://www.rust-lang.org/learn/get-started) Rust toolchain (latest stable version)
+
+* Install OpenSSL development libraries, for example on Ubuntu/Debian/Mint run `apt install libssl-dev`
 
 ## Download source
 
diff --git a/docs/root/manual/getting-started/bootstrap-cardano-node.md b/docs/root/manual/getting-started/bootstrap-cardano-node.md
@@ -22,6 +22,12 @@ In this documentation, we use the generic `testnet` identifier, but you need to
 
 :::
 
+## Pre-requisites
+
+* Install a [correctly configured](https://www.rust-lang.org/learn/get-started) Rust toolchain (latest stable version).
+
+* Install OpenSSL development libraries, for example on Ubuntu/Debian/Mint run `apt install libssl-dev`
+
 ## Download source
 
 Download from Github (HTTPS)
@@ -89,6 +95,16 @@ SUBCOMMANDS:
 
 :::tip
 
+You can use the `--json` option in order to display results in `JSON` format for the `list` and `show` commands:
+
+```bash
+./mithril-client list --json
+```
+
+:::
+
+:::tip
+
 If you want to dig deeper, you can get access to several level of logs from the Mithril Client:
 
 * Add `-v` for some logs (WARN)
diff --git a/docs/root/manual/getting-started/run-mithril-devnet.md b/docs/root/manual/getting-started/run-mithril-devnet.md
@@ -29,6 +29,12 @@ More information about this private Cardano/Mithril `devnet` is available [here]
 
 :::
 
+## Pre-requisites
+
+* Install a [correctly configured](https://www.rust-lang.org/learn/get-started) Rust toolchain (latest stable version).
+
+* Install OpenSSL development libraries, for example on Ubuntu/Debian/Mint run `apt install libssl-dev`
+
 ## Download source
 
 Download from Github (HTTPS)
diff --git a/docs/root/manual/getting-started/run-signer-node.md b/docs/root/manual/getting-started/run-signer-node.md
@@ -34,6 +34,8 @@ For more information about the **Mithril Protocol**, please refer to the [About
 
 :::
 
+## Pre-requisites
+
 ## What you'll need
 
 * Operating a **Cardano Node** as a **Stake Pool**:
@@ -43,7 +45,11 @@ For more information about the **Mithril Protocol**, please refer to the [About
   * Read rights on the `Database` folder (`--database-path` setting of the **Cardano Node**)
   * Read/Write rights on the `Inter Process Communication` file (usually `CARDANO_NODE_SOCKET_PATH` env var used to launch the **Cardano Node**)
 
-* An installed recent version of the [`cardano-cli`](https://hydra.iohk.io/job/Cardano/cardano-node/linux.native.cardano-cli)
+* Install a recent version of the [`cardano-cli`](https://hydra.iohk.io/job/Cardano/cardano-node/linux.native.cardano-cli) (version 1.35.3+)
+
+* Install a [correctly configured](https://www.rust-lang.org/learn/get-started) Rust toolchain (latest stable version).
+
+* Install OpenSSL development libraries, for example on Ubuntu/Debian/Mint run `apt install libssl-dev`
 
 :::danger
 
diff --git a/docs/root/manual/welcome.md b/docs/root/manual/welcome.md
@@ -35,7 +35,7 @@ For more information about the **Mithril Protocol**, please refer to the [About
 
 * A Linux (preferred) or a macOS computer.
 
-* A [correctly configured](https://www.rust-lang.org/learn/get-started) Rust toolchain (version 1.62.0+).
+* A [correctly configured](https://www.rust-lang.org/learn/get-started) Rust toolchain (latest stable version).
 
 * A recent version of [Docker Engine](https://docs.docker.com/engine/install/).
 
diff --git a/docs/root/mithril/mithril-protocol/simulation.md b/docs/root/mithril/mithril-protocol/simulation.md
@@ -21,7 +21,7 @@ sidebar_label: Simulation
 
 * A Linux (preferred) or a macOS computer.
 
-* A [correctly configured](https://www.rust-lang.org/learn/get-started) Rust toolchain (version 1.62.0+).
+* A [correctly configured](https://www.rust-lang.org/learn/get-started) Rust toolchain (latest stable version).
 
 ## Download source
 
diff --git a/docs/yarn.lock b/docs/yarn.lock
diff --git a/mithril-aggregator/README.md b/mithril-aggregator/README.md
diff --git a/mithril-client/README.md b/mithril-client/README.md
diff --git a/mithril-explorer/yarn.lock b/mithril-explorer/yarn.lock
diff --git a/mithril-signer/README.md b/mithril-signer/README.md
diff --git a/mithril-test-lab/mithril-end-to-end/README.md b/mithril-test-lab/mithril-end-to-end/README.md
