Merge pull request #2185 from cosmos/greg/docs-deployment

Greg/docs deployment
cosmos · Aug 29, 2018 · f15139f · f15139f
2 parents 1c38c70 + 5cd17d0
commit f15139f
Show file tree

Hide file tree

Showing 2 changed files with 90 additions and 5 deletions.
diff --git a/docs/DOCS_README.md b/docs/DOCS_README.md
@@ -8,10 +8,9 @@ and built using [VuePress](https://vuepress.vuejs.org/) from the Cosmos website
 
 - https://github.com/cosmos/cosmos.network
 
-which has a [configuration file](https://github.com/cosmos/cosmos.network/blob/develop/docs/.vuepress/config.js) for displaying
-the Table of Contents that lists all the documentation. 
+Under the hood, Jenkins listens for changes (on develop or master) in ./docs then rebuilds
+either the staging or production site depending on which branch the changes were made.
 
-Under the hood, Jenkins listens for changes in ./docs then pushes a `docs-staging` branch to the cosmos.network repo with the latest documentation. That branch must be manually PR'd to `develop` then `master` for staging then production. This process should happen in synchrony with a release.
-
-The `README.md` in this directory is the landing page for
+To update the Table of Contents (layout of the documentation sidebar), edit the
+`config.js` in this directory, while the `README.md` is the landing page for the
 website documentation.
diff --git a/docs/config.js b/docs/config.js
@@ -0,0 +1,86 @@
+module.exports = {
+  title: "Cosmos Network",
+  description: "Documentation for the Cosmos Network.",
+  dest: "./dist/docs",
+  base: "/docs/",
+  markdown: {
+    lineNumbers: true
+  },
+  themeConfig: {
+    lastUpdated: "Last Updated",
+    nav: [{ text: "Back to Cosmos", link: "https://cosmos.network" }],
+    sidebar: [
+      {
+        title: "Introduction",
+        collapsable: false,
+        children: [
+          "/introduction/cosmos-hub",
+          "/introduction/tendermint",
+        ]
+      },
+      {
+        title: "Getting Started",
+        collapsable: false,
+        children: [
+          "/getting-started/voyager",
+          "/getting-started/installation",
+          "/getting-started/full-node",
+          "/getting-started/create-testnet"
+        ]
+      },
+      {
+        title: "Cosmos SDK",
+        collapsable: false,
+        children: [
+          ["/sdk/overview", "Overview"],
+          ["/sdk/core/intro", "Core"],
+          "/sdk/core/app1",
+          "/sdk/core/app2",
+          "/sdk/core/app3",
+          "/sdk/core/app4",
+          "/sdk/core/app5",
+          // "/sdk/modules",
+          "/sdk/clients"
+        ]
+      },
+      // {
+      //   title: "Specifications",
+      //   collapsable: false,
+      //   children: [
+      //     ["/specs/overview", "Overview"],
+      //     "/specs/governance",
+      //     "/specs/ibc",
+      //     "/specs/staking",
+      //     "/specs/icts",
+      //   ]
+      // },
+      {
+        title: "Lotion JS",
+        collapsable: false,
+        children: [["/lotion/overview", "Overview"], "/lotion/building-an-app"]
+      },
+      {
+        title: "Validators",
+        collapsable: false,
+        children: [
+          ["/validators/overview", "Overview"],
+          ["/validators/security", "Security"],
+          ["/validators/validator-setup", "Validator Setup"],
+          "/validators/validator-faq"
+        ]
+      },
+      {
+        title: "Resources",
+        collapsable: false,
+        children: [
+          // ["/resources/faq" "General"],
+          "/resources/delegator-faq",
+          ["/resources/whitepaper", "Whitepaper - English"],
+          ["/resources/whitepaper-ko", "Whitepaper - 한국어"],
+          ["/resources/whitepaper-zh-CN", "Whitepaper - 中文"],
+          ["/resources/whitepaper-pt", "Whitepaper - Português"]
+        ]
+      }
+    ]
+  }
+}