From 0fa7112e75d0a6d57dd596cc172174498a83773c Mon Sep 17 00:00:00 2001 From: Sven Dowideit Date: Wed, 2 Nov 2016 15:25:43 +1000 Subject: [PATCH] add a little docs Signed-off-by: Sven Dowideit --- docs/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/README.md b/docs/README.md index 9d2e17da..51258c6b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -10,3 +10,11 @@ then it should include changes to the documenation in this directory. When we make a new release of RancherOS, the `docs/os` dir will be copied into the `rancher/rancher.github.io` repository to be accessible by users. +## Previewing your changes + +You can either build and view your docs locally by running `make docs`, or you can +set your fork of the `rancher/os` repository to render your `master` using `GitHub Pages`. + +To set up `GitHub Pages`, browse to your fork, then to the `Settings` - under `GitHub Pages`, set the `Source` +to `master branch /docs folder` and hit the `Save` button. GitHub will tell you the URL at which the +documenation can be read.