Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Move doc site #252

Merged
merged 1 commit into from
Aug 3, 2018
Merged

Move doc site #252

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/publish.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
23 changes: 23 additions & 0 deletions docs/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.