Merge pull request #622 from input-output-hk/djo/555/doc_versioning

Documentation versioning

Author: Alenar

docs/Makefile

@@ -20,4 +20,14 @@ clean:
 	rm yarn.lock || true
 
 upgrade: clean install
-	yarn upgrade @docusaurus/core@latest @docusaurus/preset-classic@latest redocusaurus@latest
+	yarn upgrade @docusaurus/core@latest @docusaurus/preset-classic@latest redocusaurus@latest
+
+update-current:
+	# Use docusaurus command to create a new version using a temporary name
+	yarn run docusaurus docs:version updated
+	# cleanup previous file & replace it with the updated ones
+	rm -rf versioned_docs/version-maintained versioned_sidebars/version-maintained-sidebars.json
+	mv versioned_docs/version-updated versioned_docs/version-maintained
+	mv versioned_sidebars/version-updated-sidebars.json  versioned_sidebars/version-maintained-sidebars.json
+	# Remove the entry for the temporary version in the versions.json file
+	sed -i '/updated/d' versions.json

docs/docusaurus.config.js

@@ -33,7 +33,21 @@ const config = {
           path: 'root',
           routeBasePath: '/',
           sidebarPath: require.resolve('./sidebars.js'),
-          editUrl: 'https://github.com/input-output-hk/mithril/edit/main/docs',
+          editUrl: ({docPath}) => {
+            // We want users to submit doc updates to the upstream/next version!
+            // Otherwise we risk losing the update on the next release.
+            return `https://github.com/input-output-hk/mithril/edit/main/docs/root/${docPath}`;
+          },
+          lastVersion: 'maintained',
+          versions: {
+            current: {
+              label: 'Next 🚧',
+              banner: 'unreleased',
+            },
+            maintained: {
+              label: 'Current',
+            }
+          },
         },
         blog: {
           path: 'blog/',
@@ -113,6 +127,11 @@ const config = {
             label: 'About Mithril',
             position: 'left',
           },
+          {
+            type: 'docsVersionDropdown',
+            position: 'right',
+            dropdownActiveClassDisabled: true,
+          },
           {
             label: 'Explorer',
             to: 'https://mithril.network/explorer',

docs/root/manual/developer-docs/nodes/mithril-aggregator.md

@@ -2,7 +2,7 @@
 sidebar_position: 1
 ---
 
-import NetworksMatrix from '../../../../shared/networks-matrix.md';
+import NetworksMatrix from '../../../networks-matrix.md';
 
 # Mithril Aggregator Node
 

docs/root/manual/developer-docs/nodes/mithril-client.md

@@ -2,7 +2,7 @@
 sidebar_position: 3
 ---
 
-import NetworksMatrix from '../../../../shared/networks-matrix.md';
+import NetworksMatrix from '../../../networks-matrix.md';
 
 # Mithril Client Node
 

docs/root/manual/developer-docs/nodes/mithril-signer.md

@@ -2,7 +2,7 @@
 sidebar_position: 2
 ---
 
-import NetworksMatrix from '../../../../shared/networks-matrix.md';
+import NetworksMatrix from '../../../networks-matrix.md';
 
 # Mithril Signer Node
 

docs/root/manual/developer-docs/references.md

@@ -2,7 +2,7 @@
 sidebar_position: 2
 ---
 
-import NetworksMatrix from '../../../shared/networks-matrix.md';
+import NetworksMatrix from '../../networks-matrix.md';
 
 # API Reference
 

docs/root/manual/getting-started/bootstrap-cardano-node.md

@@ -2,7 +2,7 @@
 sidebar_position: 1
 ---
 
-import NetworksMatrix from '../../../shared/networks-matrix.md';
+import NetworksMatrix from '../../networks-matrix.md';
 
 # Bootstrap a Cardano Node
 

docs/root/manual/getting-started/run-signer-node.md

@@ -2,7 +2,7 @@
 sidebar_position: 2
 ---
 
-import NetworksMatrix from '../../../shared/networks-matrix.md';
+import NetworksMatrix from '../../networks-matrix.md';
 
 # Run a Mithril Signer node (SPO)
 

docs/shared/networks-matrix.md renamed to docs/root/networks-matrix.md

@@ -1,3 +1,9 @@
+---
+unlisted: true
+hide_title: true
+hide_table_of_contents: true
+---
+
 Here is an up to date list of all the **Mithril Networks**, their configurations and their status:
 
 > Last update: 11/14/2022

docs/sidebars.js

@@ -1,14 +1,3 @@
-/**
- * Creating a sidebar enables you to:
- - create an ordered group of docs
- - render a sidebar for each doc of that group
- - provide next/previous navigation
-
- The sidebars can be generated from the filesystem, or explicitly defined here.
-
- Create as many sidebars as you want.
- */
-
 // @ts-check
 
 /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */