summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOwen Jacobson <owen@grimoire.ca>2020-01-28 23:34:01 -0500
committerOwen Jacobson <owen@grimoire.ca>2020-01-28 23:34:01 -0500
commit6a7b97b436a5a20c172e6b04bf0caa37d544fde4 (patch)
tree0f4fd5c2c8d782885c5b821114b060e89fce1dcd
parent0d6f58c54a7af6c8b4e6cd98663eb36ec4e3accc (diff)
Add publish instructions.
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index dff9e02..2b5ea2d 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,7 @@ This repository contains the infrastructure for publishing a website, built from
You will need:
* [MkDocs](https://mkdocs.org) (`brew install mkdocs`)
+* The AWS CLI (`brew install awscli`), logged in on an account with access to the `grimoire.ca` S3 bucket.
## Building
@@ -25,3 +26,11 @@ mkdocs serve
```
This will automatically rebuild the site every time the files in `docs` change, and will serve them on a web server at <http://127.0.0.1:8000>.
+
+## Publishing
+
+Once the site is built, it can be published to s3:
+
+```bash
+aws s3 sync --delete site/ s3://grimoire.ca/
+```