website/README.md

56 lines
732 B
Markdown

# [caution.co](https://caution.co)
Web page source.
## Instructions
0. If the repo was not cloned with submodules:
```shell
$ git submodule update --init --recursive
```
1. Install `make`.
2. Install `docker`
3. Build (export) site to `_site` directory:
```shell
$ make build
```
4. Serve site at `0.0.0.0:4000`:
```shell
$ make serve
```
### Generate Static Files
1. Output static files in `_site` directory:
```shell
$ make _site
```
### Cleanup
1. Remove all build artifacts:
```shell
$ make fullclean
```
### Releasing
1. Build and publish the image
```shell
make publish
```
2. Restart the `caution` deployment in the Kubernetes cluster
```shell
kubectl -n website rollout restart deploy/website-caution
```