rancher/os
1
0
Fork 1
mirror of https://github.com/rancher/os.git synced 2025-07-06 03:26:12 +00:00
Code Issues Releases Wiki Activity

add a little docs

Browse Source 
Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
This commit is contained in:
Sven Dowideit 2016-11-02 15:25:43 +10:00
parent b344657d0f
commit 0fa7112e75
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/README.md
View File

@ -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.