certusone
/
cosmos-sdk
mirror of https://github.com/certusone/cosmos-sdk.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: how they're updated

This commit is contained in:
Zach Ramsay 2018-07-16 14:19:11 -04:00
parent 90ed178c2b
commit 4e1cbb7d51
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/DOCS_README.md Normal file
View File

@ -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.