fluencelabs/tendermint
1
0
Fork 0
mirror of https://github.com/fluencelabs/tendermint synced 2025-06-14 22:01:20 +00:00
Code Issues Projects Releases Wiki Activity

docs: update DOCS_README (#3019)

Browse Source 
Co-Authored-By: zramsay <zach.ramsay@gmail.com>
This commit is contained in:
Zach
2018-12-15 14:01:28 -05:00
committed by Anton Kaliaev
parent 3fbe9f235a
commit f5cca9f121
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/DOCS_README.md
View File

@ -12,10 +12,10 @@ respectively.
## How It Works ## How It Works
There is a Jenkins job listening for changes in the `/docs` directory, on both There is a CircleCI job listening for changes in the `/docs` directory, on both
the `master` and `develop` branches. Any updates to files in this directory the `master` and `develop` branches. Any updates to files in this directory
on those branches will automatically trigger a website deployment. Under the hood, on those branches will automatically trigger a website deployment. Under the hood,
a private website repository has make targets consumed by a standard Jenkins task. the private website repository has a `make build-docs` target consumed by a CircleCI job in that repo.
## README ## README
@ -93,6 +93,10 @@ python -m SimpleHTTPServer 8080
then navigate to localhost:8080 in your browser. then navigate to localhost:8080 in your browser.
## Search
We are using [Algolia](https://www.algolia.com) to power full-text search. This uses a public API search-only key in the `config.js` as well as a [tendermint.json](https://github.com/algolia/docsearch-configs/blob/master/configs/tendermint.json) configuration file that we can update with PRs.
## Consistency ## Consistency
Because the build processes are identical (as is the information contained herein), this file should be kept in sync as Because the build processes are identical (as is the information contained herein), this file should be kept in sync as