Merge pull request 99designs#252 from 99designs/move-doc-site

Move doc site
cgxxv · Aug 3, 2018 · d352800 · d352800
2 parents cfa87a8 + ddd7c46
commit d352800
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 1 deletion.
diff --git a/docs/publish.sh b/docs/publish.sh
@@ -3,4 +3,4 @@
 set -euo pipefail
 
 hugo
-gsutil -m rsync -dr public gs://gqlgen.com
+aws-vault exec platform -- aws s3 sync public s3://gqlgen-docs
diff --git a/docs/readme.md b/docs/readme.md
@@ -0,0 +1,23 @@
+Documentation
+====
+
+This directory contains the markdown source files for the static doc site hosted at [gqlgen.com](https://gqlgen.com) 
+
+
+## Install hugo
+
+Before working with these docs you will need to install hugo, see [Quickstart](https://gohugo.io/getting-started/quick-start/) for instructions.
+
+
+## Editing docs
+
+When editing docs run `hugo serve` and a live reload server will start, then navigate to http://localhost:1313 in your browser. Any changes made will be updated in the browser.
+
+
+## Publishing docs
+
+**Requires 99designs aws-vault access**
+
+run `./publish.sh` to make the docs live.
+
+