Add make targets for serving docs locally
commit16734dbee82eca0a1b5cd51cad2839be042d0fe7
authorJoel Speed <Joel.speed@hotmail.co.uk>
dateFri 10 May 2019, 12:07 (7 years ago)
parentf262ec8
.gitignore+1
@@ -5,6 +5,7 @@ release
55.godeps
66*.exe
77.env
8+.bundle
89
910# Go.gitignore
1011# Compiled Object files, Static and Dynamic libs (Shared Objects)
docs/Makefilenew file+18
@@ -0,0 +1,18 @@
1+.PHONY: ruby
2+ruby:
3+ @ if [ ! $$(which ruby) ]; then \
4+ echo "Please install ruby version 2.1.0 or higher"; \
5+ fi
6+
7+.PHONY: bundle
8+bundle: ruby
9+ @ if [ ! $$(which bundle) ]; then \
10+ echo "Please install bundle: `gem install bundler`"; \
11+ fi
12+
13+vendor/bundle: bundle
14+ bundle install --path vendor/bundle
15+
16+.PHONY: serve
17+serve: vendor/bundle
18+ bundle exec jekyll serve
docs/README.mdnew file+13
@@ -0,0 +1,13 @@
1+# Docs
2+
3+This folder contains our Jekyll based docs site which is hosted at
4+https://pusher.github.io/oauth2_proxy.
5+
6+When making changes to this docs site, please test your changes locally:
7+
8+```bash
9+make serve
10+```
11+
12+To run the docs site locally you will need Ruby at version 2.1.0 or
13+higher and `bundle` (`gem install bundler` if you already have Ruby).