From 84fc6ea5a733c35a14df3bdf81e2b1c8d4820f98 Mon Sep 17 00:00:00 2001 From: Zach Ramsay Date: Wed, 15 Aug 2018 19:06:37 -0400 Subject: [PATCH 1/3] docs: add config.js for ToC sidebar --- docs/DOCS_README.md | 9 +++-- docs/config.js | 86 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 90 insertions(+), 5 deletions(-) create mode 100644 docs/config.js diff --git a/docs/DOCS_README.md b/docs/DOCS_README.md index 564a7e955873..da11b2c01e2e 100644 --- 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 new file mode 100644 index 000000000000..61607b1b08e2 --- /dev/null +++ b/docs/config.js @@ -0,0 +1,86 @@ +module.exports = { + title: "Cosmos Network", + description: "Documentation for the Cosmos Network.", + dest: "./site-docs", + base: "/", + 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"] + ] + } + ] + } +} From 4928c1950be248f7ddcc6199d508e57c7466627f Mon Sep 17 00:00:00 2001 From: Greg Szabo <16846635+greg-szabo@users.noreply.github.com> Date: Mon, 27 Aug 2018 12:34:16 -0400 Subject: [PATCH 2/3] Updating config.js for docs website build process This change will put the documentation to the right folder for website deployment. --- docs/config.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/config.js b/docs/config.js index 61607b1b08e2..42df9de92de2 100644 --- a/docs/config.js +++ b/docs/config.js @@ -1,7 +1,7 @@ module.exports = { title: "Cosmos Network", description: "Documentation for the Cosmos Network.", - dest: "./site-docs", + dest: "./dist/docs", base: "/", markdown: { lineNumbers: true From 5cd17d07f103ca0ef6dc64c6b8abdb177fe08cda Mon Sep 17 00:00:00 2001 From: Fabian Date: Tue, 28 Aug 2018 16:18:06 +0200 Subject: [PATCH 3/3] Update config.js --- docs/config.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/config.js b/docs/config.js index 42df9de92de2..93426bcc5f88 100644 --- a/docs/config.js +++ b/docs/config.js @@ -2,7 +2,7 @@ module.exports = { title: "Cosmos Network", description: "Documentation for the Cosmos Network.", dest: "./dist/docs", - base: "/", + base: "/docs/", markdown: { lineNumbers: true },