rancher/os
1
0
Fork 1
mirror of https://github.com/rancher/os.git synced 2025-05-07 07:36:20 +00:00
Code Issues Releases Wiki Activity
v0.8.x
os/docs
History
Tyler Tidman 283c4b7193 Update copyrights, fixes #1605
2017-02-21 20:19:10 -05:00
..
_includes Add some info about creating console images 2016-11-17 20:57:06 +10:00
_layouts Update copyrights, fixes #1605 2017-02-21 20:19:10 -05:00
css import the rancherOS docs so we can write docs for the next release 2016-11-02 12:17:17 +10:00
img import the rancherOS docs so we can write docs for the next release 2016-11-02 12:17:17 +10:00
js import the rancherOS docs so we can write docs for the next release 2016-11-02 12:17:17 +10:00
os ECS AMI's for 0.8.0 2017-02-15 00:57:59 +00:00
vendor import the rancherOS docs so we can write docs for the next release 2016-11-02 12:17:17 +10:00
volume import the rancherOS docs so we can write docs for the next release 2016-11-02 12:17:17 +10:00
_config.yml remove the CNAME - this is dev docs 2016-11-02 12:17:17 +10:00
favicon.png import the rancherOS docs so we can write docs for the next release 2016-11-02 12:17:17 +10:00
Gemfile import the rancherOS docs so we can write docs for the next release 2016-11-02 12:17:17 +10:00
Gemfile.lock import the rancherOS docs so we can write docs for the next release 2016-11-02 12:17:17 +10:00
index.html add 'make docs' to build locally 2016-11-02 15:19:14 +10:00
rancheros.png updating readme doc 2016-08-02 15:50:17 -07:00
README.md add a little docs 2016-11-02 15:25:43 +10:00

README.md

Documentation for the master version of rancher/os

This dir is not the documentation for any released version of RancherOS. You can find that at the Rancher Labs Documentation site and specifically for RancherOS.

When there are Pull Requests to the rancher/os repository that affect the user (or developer), 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.