From 658a24d9dcda158b451f5f21535ce2363eb188f8 Mon Sep 17 00:00:00 2001 From: Adam Scarr Date: Fri, 3 Aug 2018 11:39:47 +1000 Subject: [PATCH] Move doc site --- docs/publish.sh | 2 +- docs/readme.md | 23 +++++++++++++++++++++++ 2 files changed, 24 insertions(+), 1 deletion(-) create mode 100644 docs/readme.md diff --git a/docs/publish.sh b/docs/publish.sh index 9a8bef520f3..02a4b94a4fc 100755 --- 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 new file mode 100644 index 00000000000..a66df0e3b87 --- /dev/null +++ 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. + +