From 4e1cbb7d516998be8c2e8585879ccc30fbac387d Mon Sep 17 00:00:00 2001 From: Zach Ramsay Date: Mon, 16 Jul 2018 14:19:11 -0400 Subject: [PATCH] docs: how they're updated --- docs/DOCS_README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 docs/DOCS_README.md diff --git a/docs/DOCS_README.md b/docs/DOCS_README.md new file mode 100644 index 000000000000..564a7e955873 --- /dev/null +++ b/docs/DOCS_README.md @@ -0,0 +1,17 @@ +# Documentation Maintenance Overview + +The documentation found in this directory is hosted at: + +- https://cosmos.network/docs/ + +and built using [VuePress](https://vuepress.vuejs.org/) from the Cosmos website repo: + +- 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 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 +website documentation.