Add the slightest taste of documentation on using GitHub Pages

This commit is contained in:
R. Tyler Croy 2016-12-02 06:58:02 -08:00
parent 8f868c41c2
commit 388c0ab308
No known key found for this signature in database
GPG Key ID: 1426C7DC3F51E16F
2 changed files with 16 additions and 0 deletions

View File

@ -1,3 +1,4 @@
# http://awestruct.org/auto-deploy-to-github-pages/#ignore-files
Gemfile
Gemfile.lock
Rakefile

View File

@ -240,3 +240,18 @@ execute: `./gradlew dev` and you'll have a live-reloading webserver running
on link:http://localhost:4242/[localhost:4242]
In order to get a *legacy* version of jenkinsci.org, `./gradlew dev-legacy`
== Deploying on GitHub pages
There is rudimentary (as in if it doesn't work, you're on your own) support for
publishing the static site to GitHub Pages for demonstration purposes using the
link:http://awestruct.org/auto-deploy-to-github-pages/#awestruct-deployer[Awestruct Deployer].
This requires adding a
link:http://awestruct.org/profiles/[profile]
to `content/_config/site.yml` for your fork, and manually operating
`awestruct`