... | ... | @@ -12,8 +12,24 @@ clearly and simply announce downtimes and recovery. |
|
|
|
|
|
<!-- more in-depth procedure that may require interpretation -->
|
|
|
|
|
|
## Signaling an issue
|
|
|
|
|
|
TODO: document how to push updates to the dashboard
|
|
|
|
|
|
Issues are in `content/issues`. Expand.
|
|
|
|
|
|
## Changing categories
|
|
|
|
|
|
cState relies on "systems" which live inside a "category" For example,
|
|
|
the "v3 onion services" are in the "Tor network" category. Those are
|
|
|
defined in the `config.yml` file, and each issue (in `content/issues`)
|
|
|
refers to one or more "system" that is affected by it.
|
|
|
|
|
|
## Theming
|
|
|
|
|
|
The logo lives in `static/logo.png`. Some colors are defined in
|
|
|
`config.yml`, search for `Colors throughout cState`.
|
|
|
|
|
|
## Pager playbook
|
|
|
|
|
|
<!-- information about common errors from the monitoring system and -->
|
... | ... | @@ -31,8 +47,18 @@ TODO: contingencies when/if the normal system is down |
|
|
# Reference
|
|
|
|
|
|
## Installation
|
|
|
<!-- how to setup the service from scratch -->
|
|
|
|
|
|
The basic setup for cstate is:
|
|
|
|
|
|
sudo apt install hugo
|
|
|
git clone --recursive -b master https://github.com/cstate/example.git
|
|
|
cd example
|
|
|
hugo serve
|
|
|
|
|
|
This will serve a copy of the example website on localhost. Obviously,
|
|
|
this will be a different URL for our repository. Most configuration
|
|
|
happens in `config.yaml`.
|
|
|
|
|
|
## SLA
|
|
|
|
|
|
This service should be highly available. It should support failure
|
... | ... | @@ -146,6 +172,10 @@ TPA, network team, network health team. |
|
|
|
|
|
## Proposed Solution
|
|
|
|
|
|
We're experimenting with [cstate](https://github.com/cstate/cstate) because it's the only static
|
|
|
website generator with such a nice template out of the box that we
|
|
|
could find.
|
|
|
|
|
|
## Cost
|
|
|
|
|
|
Just research and development time. Hosting costs are negligible.
|
... | ... | |