From 7a0ebc409b296934c88cbfc34cd1f08807eacf6c Mon Sep 17 00:00:00 2001 From: Sven Dowideit Date: Thu, 17 Aug 2017 06:01:19 +1000 Subject: [PATCH] update master to generate docs like rancher.github.io does Signed-off-by: Sven Dowideit --- .dockerignore | 1 + docs/Dockerfile | 5 + docs/Dockerfile.build | 21 +++ docs/Gemfile.lock | 4 +- docs/Makefile | 27 ++++ docs/README.md | 149 ++++++++++++++++-- docs/_config.yml | 38 ++++- docs/_includes/footer.html | 61 ++++--- docs/_includes/os-sidebar-v1.0.html | 101 ++++++++++++ docs/_includes/os-sidebar.html | 7 +- docs/_includes/rancher-header.html | 89 +++++------ docs/_includes/rancher-sidebar-v1.3.html | 3 +- docs/_includes/rancher-sidebar-v1.4.html | 5 +- docs/_includes/rancher-sidebar-v1.5.html | 9 +- docs/_includes/rancher-sidebar-v1.6.html | 22 ++- docs/_layouts/os-default-v1.0.html | 3 + docs/_layouts/os-default.html | 2 +- docs/_layouts/os-latest-en-redirect.html | 14 ++ docs/_layouts/os-latest-redirect.html | 14 ++ docs/_layouts/os-redirect.html | 15 ++ docs/_layouts/rancher-default-v1.5.html | 2 +- docs/os/amazon-ecs/index.md | 2 +- .../built-in-system-services/index.md | 2 +- docs/os/boot-process/cloud-init/index.md | 2 +- .../os/boot-process/image-preloading/index.md | 2 +- .../adding-kernel-parameters/index.md | 2 +- docs/os/configuration/custom-console/index.md | 2 +- docs/os/configuration/custom-kernels/index.md | 2 +- .../custom-rancheros-iso/index.md | 2 +- docs/os/configuration/docker/index.md | 2 +- docs/os/configuration/hostname/index.md | 2 +- docs/os/configuration/index.md | 2 +- .../kernel-modules-kernel-headers/index.md | 2 +- .../loading-kernel-modules/index.md | 2 +- .../configuration/private-registries/index.md | 2 +- .../resizing-device-partition/index.md | 2 +- .../configuration/running-commands/index.md | 2 +- .../setting-up-docker-tls/index.md | 2 +- docs/os/configuration/ssh-keys/index.md | 2 +- .../configuration/switching-consoles/index.md | 2 +- .../switching-docker-versions/index.md | 2 +- docs/os/configuration/sysctl/index.md | 2 +- docs/os/configuration/users/index.md | 2 +- docs/os/configuration/write-files/index.md | 2 +- docs/os/contributing/index.md | 2 +- docs/os/custom-builds/custom-kernels/index.md | 2 +- .../custom-rancheros-iso/index.md | 2 +- docs/os/faqs/amazon/index.md | 2 +- docs/os/faqs/index.md | 2 +- docs/os/index.md | 2 +- docs/os/networking/dns/index.md | 2 +- docs/os/networking/interfaces/index.md | 2 +- docs/os/networking/proxy-settings/index.md | 2 +- docs/os/quick-start-guide/index.md | 2 +- docs/os/running-rancher-on-rancheros/index.md | 2 +- docs/os/running-rancheros/cloud/aws/index.md | 2 +- .../os/running-rancheros/cloud/azure/index.md | 2 +- docs/os/running-rancheros/cloud/do/index.md | 2 +- docs/os/running-rancheros/cloud/gce/index.md | 2 +- .../cloud/openstack/index.md | 2 +- .../cloud/vmware-esxi/index.md | 2 +- docs/os/running-rancheros/index.md | 2 +- .../server/install-to-disk/index.md | 2 +- docs/os/running-rancheros/server/pxe/index.md | 2 +- .../server/raspberry-pi/index.md | 2 +- .../workstation/boot-from-iso/index.md | 2 +- .../workstation/docker-machine/index.md | 2 +- docs/os/security/index.md | 2 +- docs/os/storage/additional-mounts/index.md | 2 +- docs/os/storage/state-partition/index.md | 2 +- docs/os/storage/using-zfs/index.md | 2 +- .../adding-system-services/index.md | 2 +- .../custom-system-services/index.md | 2 +- docs/os/system-services/environment/index.md | 2 +- .../system-docker-volumes/index.md | 2 +- .../device-plug-and-unplug/index.md | 2 +- docs/os/under-the-hood/directories/index.md | 2 +- docs/os/under-the-hood/porting/index.md | 2 +- .../under-the-hood/startup-sequence/index.md | 2 +- .../zombie-process-management/index.md | 2 +- docs/os/upgrading/index.md | 2 +- 81 files changed, 538 insertions(+), 174 deletions(-) create mode 100644 docs/Dockerfile create mode 100644 docs/Dockerfile.build create mode 100644 docs/Makefile create mode 100644 docs/_includes/os-sidebar-v1.0.html create mode 100644 docs/_layouts/os-default-v1.0.html create mode 100644 docs/_layouts/os-latest-en-redirect.html create mode 100644 docs/_layouts/os-latest-redirect.html create mode 100644 docs/_layouts/os-redirect.html diff --git a/.dockerignore b/.dockerignore index 99e24dc8..7d4e8672 100644 --- a/.dockerignore +++ b/.dockerignore @@ -15,3 +15,4 @@ tests/integration/.tox #.dapper vendor/*/*/*/.git tmp +docs/_site diff --git a/docs/Dockerfile b/docs/Dockerfile new file mode 100644 index 00000000..1865f519 --- /dev/null +++ b/docs/Dockerfile @@ -0,0 +1,5 @@ +FROM rancher/rancher.github.io:build AS builder + +FROM nginx +COPY --from=builder /build/_site /usr/share/nginx/html/docs +COPY --from=builder /build/favicon.png /usr/share/nginx/html/favicon.png diff --git a/docs/Dockerfile.build b/docs/Dockerfile.build new file mode 100644 index 00000000..9be9637a --- /dev/null +++ b/docs/Dockerfile.build @@ -0,0 +1,21 @@ +FROM jekyll/jekyll:3.4 AS builder +WORKDIR /build +COPY Gemfile /build +COPY Gemfile.lock /build +COPY _config.yml /build +RUN jekyll build +COPY . /build + +# IMPORTANT: this line moves the development docs to where they would be in rancher/rancher.gihub.io +RUN mv os os-orig \ + && mkdir -p os/v1.0/en \ + && mv os-orig/* os/v1.0/en/ + +# Set up the latest pages that get converted into redirects +ENV OS_DOCS_LATEST v1.0 +RUN mkdir -p os/latest/en \ + && cp -r os/v1.0/en/* os/latest/en/ \ + && cp -r os/v1.0/en/* os/latest/ \ + && cp -r os/v1.0/en/* os/ + +RUN jekyll build diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock index 3ecbc351..3e36060d 100644 --- a/docs/Gemfile.lock +++ b/docs/Gemfile.lock @@ -86,7 +86,7 @@ GEM gemoji (~> 2.0) html-pipeline (~> 2.2) jekyll (>= 2.0) - json (1.8.1) + json (1.8.2) kramdown (1.9.0) liquid (3.0.6) listen (3.0.4) @@ -128,4 +128,4 @@ DEPENDENCIES json BUNDLED WITH - 1.11.2 + 1.15.3 diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 00000000..821c4429 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,27 @@ +.PHONY: default build build-nginx run live + +default: build build-nginx run + +# this target sets up Jekyll, and uses it to build html +build: + docker build -t rancher/rancher.github.io:build -f Dockerfile.build . + +# this target uses the Jekyll html image in a multistage Dockerfile to build a small nginx image +build-nginx: + docker build -t rancher/rancher.github.io . + +run: build-nginx + docker run --rm -p 80:80 rancher/rancher.github.io + +# this target will use the jekyll image and bind mount your local repo, when you modify a file, the html will be automatically rebuilt. (the redirects from latest won't work) +# You can also examine the output html in the _sites dir. +live: + docker run --rm -it -p 80:4000 \ + -v $(PWD)/os:/build/os/v1.0/en \ + -v $(PWD)/_site:/build/_site \ + rancher/rancher.github.io:build jekyll serve -w -P 4000 --incremental + +clean: + rm -rf _sites + docker rmi rancher/rancher.github.io + docker rmi rancher/rancher.github.io:build diff --git a/docs/README.md b/docs/README.md index 51258c6b..a7441798 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,20 +1,141 @@ -# Documentation for the `master` version of `rancher/os` +# Rancher Labs Documentation -This dir is _not_ the documentation for any released version of RancherOS. -You can find that at the [Rancher Labs Documentation site](https://docs.rancher.com) and -specifically for [RancherOS](https://docs.rancher.com/os/). +This README file includes information pertaining to the documentation project for both Rancher and Rancher OS. -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. +## Rancher -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. +Rancher is an open source project that provides a complete platform for operating Docker in production. It provides infrastructure services such as multi-host networking, global and local load balancing, and volume snapshots. It integrates native Docker management capabilities such as Docker Machine and Docker Swarm. It offers a rich user experience that enables devops admins to operate Docker in production at large scale. -## Previewing your changes +## Rancher OS -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`. +Operating system composed entirely of Docker containers. Everything in RancherOS is a container managed by Docker. This includes system services such as udev and syslog. RancherOS includes only the bare minimum amount of software needed to run Docker. -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. +## Rancher Labs Documentation website + +Rancher documentation is available at . + +As Rancher has gone GA, we've added in version control. The default Rancher docs site will always be referring to the latest release. We will branch off specific versions of Rancher that are deemed GA, which would also be tagged as `rancher/server:stable`. + +Currently, we've added support for Chinese version of the docs site per community request. Currently, Rancher will not be actively translating the docs site, but we welcome PRs. + +Rancher OS documentation is available at . + +## Contributing to Rancher Labs Documentation Project + +### About Rancher Labs Documentation Site + +Rancher Labs documentation is hosted on GitHub Pages and published online by using Jekyll, an easy blog-aware static website generator. For more details on how to set up Jekyll, we recommend you to read . If you are using Windows, we strongly advise you to follow the instruction given at . + +For information on editing `.md` files (Markdown), refer to . + +Or you can use the `make live` Makefile target (or run `docker run --rm -it -p 80:4000 -v $(PWD):/build rancher/rancher.github.io:build jekyll serve -w -P 4000 --incremental` by hand to use the Jekyll build image used for our production pipeline. + +### Setting up the Git Environment + +In your browser, navigate to . + +Fork this repository by clicking the Fork button on the upper right-hand side. A fork of the repository is generated for you. On the right-hand side of the page of your fork, under 'HTTPS clone URL', copy the URL by clicking the Copy to clipboard icon. + +On your computer, follow these steps to setup a local repository to start working on the documentation: + +```shell +git clone https://github.com/YOUR_ACCOUNT/rancher.github.io.git +cd rancher.github.io +git remote add upstream https://github.com/rancher/rancher.github.io +git checkout master +git fetch upstream +git merge upstream/master +``` + +### Updating the Files + +We recommend you to create a new branch to update the documentation files and that you do not disturb the master branch, other than pulling in changes from `upstream/master`. +For example, you create a branch, `dev`, on your computer to make changes locally to the documentation. This `dev` branch will be your local repository which then be pushed to your forked repository on GitHub where you will create a Pull Request for the changes to be committed into the official documentation. + +It is a healthy practice to create a new branch each time you want to contribute to the documentation and only track the changes for that pull request in this branch. + +```shell +git checkout -b dev +``` + +The argument `-b dev` creates a new branch named `dev`. Now you can make necessary changes to the documentation. + +```shell +git add . +git commit -a -m "commit message for your changes" +``` + +You can optionally run Jekyll locally on your computer to be able to see the final result of your modifications and you write them. For that, use the command below. You can refer to [Jekyll's official website](https://jekyllrb.com/) for more details. + +```shell +jekyll serve +``` + +Additionally, you can use the provided `Makefile` to build and test in a Docker container: + +```shell +make live +``` + +### Merging upstream/master into Your Local Branch (`dev`) + +Maintain an up-to-date master branch in your local repository. Merge the changes on a daily basis from the `upstream/master` (the official documentation repository) into your local repository. + +Ensure that you do complete this activity before you start working on a feature as well as right before you submit your changes as a pull request. + +You can also do this process periodically while you work on your changes to make sure that you are working off the most recent version of the documentation. + +```shell +# Checkout your local 'master' branch. +git checkout master + +# Synchronize your local repository with 'upstream/master', so that you have all the latest changes. +git fetch upstream + +# Merge the latest changes from the 'upstream/master' into your local 'master' branch to make it up-to-date. +git merge upstream/master + +# Checkout your local development branch (e.g.: 'dev'). +git checkout dev + +# Pull the latest changes into your local development branch. +git pull master +``` + +### Checklist for contributions + +Please check the following list before you submit a Pull Request to make sure we can approve it right away! + +* Check if your change applies to more than one version, and if so, please make the same change in other versions as well. (Rancher only) +* If your change only applies to a minor version, make sure it is specified in the text, i.e. `Available as of Rancher v1.6.6` or `Available as of RancherOS v1.1.0`. +* If your change is regarding an item in the `rancher-catalog`, make sure the change is also applied in the README there. + +### Making a Pull Request on GitHub + +**Important:** Ensure that you have merged `upstream/master` into your dev branch before you do the following. + +After you have made necessary changes to the documentation and are ready to contribute them, create a Pull Request on GitHub. You do it by pushing your changes to your forked repository (usually called `origin`) and then initiating a pull request. + +``` +git push origin master +git push origin dev +``` + +Now follow the steps below to initiate a Pull request on GitHub. + +1. Navigate your browser to your forked repository: . +1. Click the *Compare & pull request* button on the upper side of the forked repository. +1. Enter a clear description for the changes you have made. +1. Click *Send Pull Request*. + +If you are asked to make modifications to your proposed changes, make the changes locally on your `dev` branch and push the changes. The Pull Request will be automatically updated. + +### Cleaning up the Local Repository + +You no longer need the `dev` branch after the changes have been committed into `upstream/master`. If you want to make additional documentation changes, restart the process with a new branch. + +``` +git checkout master +git branch -D dev +git push origin :dev +``` diff --git a/docs/_config.yml b/docs/_config.yml index 8f4a584e..a30dbec2 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,12 +1,6 @@ name: Rancher Documentation description: Documentation for Rancher - -URL: http://rancher.github.io -baseurl: "" - -exclude: [] - markdown: kramdown highlighter: rouge kramdown: @@ -16,3 +10,35 @@ permalink: pretty gems: - jekyll-redirect-from + +URL: "http://rancher.com" +baseurl: "/docs" + +# RancherOS defaults +defaults: + - + # os/quick-start-guide/ should redirect to os/v1.0/en/quick-start-guide + scope: + path: "os" + values: + layout: "os-redirect" + version: v1.0 + lang: en + - + # os/latest/quick-start-guide/ should redirect to os/v1.0/en/quick-start-guide + scope: + path: "os/latest" + values: + layout: "os-latest-redirect" + - + # os/latest/en/quick-start-guide/ should redirect to os/v1.0/en/quick-start-guide + scope: + path: "os/latest/en" + values: + layout: "os-latest-en-redirect" + - + scope: + path: "os/v1.0" + values: + layout: "os-default-v1.0" + diff --git a/docs/_includes/footer.html b/docs/_includes/footer.html index 6cf06295..25ef8ffe 100644 --- a/docs/_includes/footer.html +++ b/docs/_includes/footer.html @@ -1,32 +1,41 @@ - + -
-
- - {{ content }} +
+
+ {{ content }} -
+
- -
- - - - - + + + - - - - + + + + + + + + diff --git a/docs/_includes/os-sidebar-v1.0.html b/docs/_includes/os-sidebar-v1.0.html new file mode 100644 index 00000000..55705426 --- /dev/null +++ b/docs/_includes/os-sidebar-v1.0.html @@ -0,0 +1,101 @@ + diff --git a/docs/_includes/os-sidebar.html b/docs/_includes/os-sidebar.html index 4eca4374..67adeec4 100644 --- a/docs/_includes/os-sidebar.html +++ b/docs/_includes/os-sidebar.html @@ -19,7 +19,6 @@
  • GCE
  • DigitalOcean
  • Openstack
    • -
  • VMware ESXi
  • PXE
    • @@ -67,14 +66,14 @@ Boot Process
  • Storage diff --git a/docs/_includes/rancher-header.html b/docs/_includes/rancher-header.html index cc38477f..a3eb95d7 100644 --- a/docs/_includes/rancher-header.html +++ b/docs/_includes/rancher-header.html @@ -1,50 +1,47 @@ - - - {{ page.title }} - - - - - - - - - - - -
    + + + {{ page.title }} + + + + + + + + + + + +
    + -
    + (function() { + var cx = '007896692384436596364:60akf3bfmxm'; + var gcse = document.createElement('script'); + gcse.type = 'text/javascript'; + gcse.async = true; + gcse.src = 'https://cse.google.com/cse.js?cx=' + cx; + var s = document.getElementsByTagName('script')[0]; + s.parentNode.insertBefore(gcse, s); + })(); + + +
    + + +
    diff --git a/docs/_includes/rancher-sidebar-v1.3.html b/docs/_includes/rancher-sidebar-v1.3.html index 3876ac82..5748a673 100644 --- a/docs/_includes/rancher-sidebar-v1.3.html +++ b/docs/_includes/rancher-sidebar-v1.3.html @@ -11,7 +11,6 @@
  • HA Requirements
  • Using an External DB
  • Bind Mounted MySQL Volume
    • -
  • Using an ALB in AWS
  • Using an ELB in AWS
  • Using LDAP/AD with TLS
  • Behind an HTTP Proxy
    • @@ -22,7 +21,7 @@
  • Example NGINX Configuration
  • Example Apache Configuration
  • Example HAProxy Configuration
    • -
  • Using an ALB in AWS with SSL
    • +
  • Example F5 BIG-IP Configuration
  • Using an ELB in AWS with SSL
  • Using Self Signed Certs
    • diff --git a/docs/_includes/rancher-sidebar-v1.4.html b/docs/_includes/rancher-sidebar-v1.4.html index 32988d6f..2659ebf9 100644 --- a/docs/_includes/rancher-sidebar-v1.4.html +++ b/docs/_includes/rancher-sidebar-v1.4.html @@ -12,7 +12,6 @@
  • HA Requirements
  • Using an External DB
  • Bind Mounted MySQL Volume
    • -
  • Using an ALB in AWS
  • Using an ELB in AWS
  • Using LDAP/AD with TLS
  • Behind an HTTP Proxy
    • @@ -23,7 +22,7 @@
  • Example NGINX Configuration
  • Example Apache Configuration
  • Example HAProxy Configuration
    • -
  • Using an ALB in AWS with SSL
    • +
  • Example F5 BIG-IP Configuration
  • Using an ELB in AWS with SSL
  • Using Self Signed Certs
    • @@ -131,7 +130,7 @@
  • Cattle @@ -109,6 +108,8 @@
  • Adding Private Registries
  • Insecure Registries
  • Self Signed Certificates
    • +
  • Using Amazon's ECR
    • +
  • Using Google Container Registry
  • Changing the Default Registry
  • Limiting Registries
    • @@ -140,7 +141,7 @@
  • Cattle
  • Rancher Site Access
    • +
  • Restricting Concurrent Sessions
  • Accounts
  • Host Registration
  • Enabling Catalogs
    • @@ -109,6 +110,8 @@
  • Adding Private Registries
  • Insecure Registries
  • Self Signed Certificates
    • +
  • Using Amazon's ECR
    • +
  • Using Google Container Registry
  • Changing the Default Registry
  • Limiting Registries
    • @@ -123,7 +126,14 @@
  • Load Balancer
  • DNS Service
  • Metadata Service
    • -
  • Persistent Storage Service
    • +
  • + Persistent Storage Service + +
  • External Scheduler
      @@ -140,8 +150,9 @@
    • Cattle
        -
      • Stacks
        • +
      • Stacks
      • Services
        • +
      • Volumes
      • Load Balancers
      • Load Balancer Options in the UI @@ -204,6 +215,8 @@
      • Launching Kubernetes
      • Resiliency Planes
      • Cloud Providers
        • +
      • Private Registry
        • +
      • RBAC
      • Disaster Recovery
      • Backups
      • Persistent Storage
        • @@ -211,7 +224,6 @@ Add-ons Support diff --git a/docs/_layouts/os-default-v1.0.html b/docs/_layouts/os-default-v1.0.html new file mode 100644 index 00000000..ca900366 --- /dev/null +++ b/docs/_layouts/os-default-v1.0.html @@ -0,0 +1,3 @@ +{% include os-header.html %} +{% include os-sidebar-v1.0.html %} +{% include footer.html %} diff --git a/docs/_layouts/os-default.html b/docs/_layouts/os-default.html index 410b80f1..ca900366 100644 --- a/docs/_layouts/os-default.html +++ b/docs/_layouts/os-default.html @@ -1,3 +1,3 @@ {% include os-header.html %} -{% include os-sidebar.html %} +{% include os-sidebar-v1.0.html %} {% include footer.html %} diff --git a/docs/_layouts/os-latest-en-redirect.html b/docs/_layouts/os-latest-en-redirect.html new file mode 100644 index 00000000..6ed578e1 --- /dev/null +++ b/docs/_layouts/os-latest-en-redirect.html @@ -0,0 +1,14 @@ +{% capture version %}/{{page.version}}/{% endcapture %} +{% capture redirectto %}{{site.baseurl}}/{{ page.path | replace: "/latest/", version | replace: "index.md", "" }}{% endcapture %} + + +Redirecting... + + +

        Redirecting...

        +version: {{version}} +from (os/latest/en) {{site.baseurl}}/{{page.path}} +to {{redirectto}} +Click here if you are not redirected. + + diff --git a/docs/_layouts/os-latest-redirect.html b/docs/_layouts/os-latest-redirect.html new file mode 100644 index 00000000..45e042ca --- /dev/null +++ b/docs/_layouts/os-latest-redirect.html @@ -0,0 +1,14 @@ +{% capture version %}/{{page.version}}/{% endcapture %} +{% capture redirectto %}{{site.baseurl}}/{{ page.path | replace: "/latest/", "/latest/en/" | replace: "/latest/", version | replace: "index.md", "" }}{% endcapture %} + + +Redirecting... + + +

        Redirecting...

        +version: {{version}} +from (os/latest) {{site.baseurl}}/{{page.path}} +to {{redirectto}} +Click here if you are not redirected. + + diff --git a/docs/_layouts/os-redirect.html b/docs/_layouts/os-redirect.html new file mode 100644 index 00000000..b92a807b --- /dev/null +++ b/docs/_layouts/os-redirect.html @@ -0,0 +1,15 @@ +{% capture version %}/{{page.version}}/{% endcapture %} +{% capture baseto %}os/{{page.version}}/en/{% endcapture %} +{% capture redirectto %}{{site.baseurl}}/{{ page.path | replace_first: "os/", baseto | replace: "index.md", "" }}{% endcapture %} + + +Redirecting... + + +

        Redirecting...

        +version: {{version}} +from (os) {{site.baseurl}}/{{page.path}} +to {{redirectto}} +Click here if you are not redirected. + + diff --git a/docs/_layouts/rancher-default-v1.5.html b/docs/_layouts/rancher-default-v1.5.html index 26867425..2ff4fcfe 100644 --- a/docs/_layouts/rancher-default-v1.5.html +++ b/docs/_layouts/rancher-default-v1.5.html @@ -1,3 +1,3 @@ {% include rancher-header.html %} {% include rancher-sidebar-v1.5.html %} -{% include footer.html %} +{% include footer-archive.html %} diff --git a/docs/os/amazon-ecs/index.md b/docs/os/amazon-ecs/index.md index e7bb6e4f..86e095b3 100644 --- a/docs/os/amazon-ecs/index.md +++ b/docs/os/amazon-ecs/index.md @@ -1,6 +1,6 @@ --- title: Amazon ECS on RancherOS -layout: os-default + --- diff --git a/docs/os/boot-process/built-in-system-services/index.md b/docs/os/boot-process/built-in-system-services/index.md index f8ef473b..96d7be63 100644 --- a/docs/os/boot-process/built-in-system-services/index.md +++ b/docs/os/boot-process/built-in-system-services/index.md @@ -1,6 +1,6 @@ --- title: Built-in System Services in RancherOS -layout: os-default + redirect_from: - os/system-services/built-in-system-services/ --- diff --git a/docs/os/boot-process/cloud-init/index.md b/docs/os/boot-process/cloud-init/index.md index 7a14e2bd..9c318ece 100644 --- a/docs/os/boot-process/cloud-init/index.md +++ b/docs/os/boot-process/cloud-init/index.md @@ -1,6 +1,6 @@ --- title: Cloud-init -layout: os-default + --- diff --git a/docs/os/boot-process/image-preloading/index.md b/docs/os/boot-process/image-preloading/index.md index 631dd860..ad431b0b 100644 --- a/docs/os/boot-process/image-preloading/index.md +++ b/docs/os/boot-process/image-preloading/index.md @@ -1,6 +1,6 @@ --- title: Image Preloading -layout: os-default + redirect_from: - os/configuration/prepacking-docker-images/ diff --git a/docs/os/configuration/adding-kernel-parameters/index.md b/docs/os/configuration/adding-kernel-parameters/index.md index 45eca997..a95a014a 100644 --- a/docs/os/configuration/adding-kernel-parameters/index.md +++ b/docs/os/configuration/adding-kernel-parameters/index.md @@ -1,6 +1,6 @@ --- title: Adding kernel parameters -layout: os-default + --- diff --git a/docs/os/configuration/custom-console/index.md b/docs/os/configuration/custom-console/index.md index 0102eec9..86d37bfd 100644 --- a/docs/os/configuration/custom-console/index.md +++ b/docs/os/configuration/custom-console/index.md @@ -1,6 +1,6 @@ --- title: Custom Console on RancherOS -layout: os-default + --- diff --git a/docs/os/configuration/custom-kernels/index.md b/docs/os/configuration/custom-kernels/index.md index 72dc3a27..1400ba71 100644 --- a/docs/os/configuration/custom-kernels/index.md +++ b/docs/os/configuration/custom-kernels/index.md @@ -1,6 +1,6 @@ --- title: Custom Kernels in RancherOS -layout: os-default + --- diff --git a/docs/os/configuration/custom-rancheros-iso/index.md b/docs/os/configuration/custom-rancheros-iso/index.md index 7db0276a..03c33204 100644 --- a/docs/os/configuration/custom-rancheros-iso/index.md +++ b/docs/os/configuration/custom-rancheros-iso/index.md @@ -1,6 +1,6 @@ --- title: Custom RancherOS ISO -layout: os-default + --- diff --git a/docs/os/configuration/docker/index.md b/docs/os/configuration/docker/index.md index 087de7d9..201508a2 100644 --- a/docs/os/configuration/docker/index.md +++ b/docs/os/configuration/docker/index.md @@ -1,6 +1,6 @@ --- title: Configuring Docker in RancherOS -layout: os-default + --- diff --git a/docs/os/configuration/hostname/index.md b/docs/os/configuration/hostname/index.md index 771fd294..f650cfa7 100644 --- a/docs/os/configuration/hostname/index.md +++ b/docs/os/configuration/hostname/index.md @@ -1,6 +1,6 @@ --- title: Setting the Hostname in RancherOS -layout: os-default + --- diff --git a/docs/os/configuration/index.md b/docs/os/configuration/index.md index d6588167..db3565f1 100644 --- a/docs/os/configuration/index.md +++ b/docs/os/configuration/index.md @@ -1,6 +1,6 @@ --- title: Configuring RancherOS -layout: os-default + redirect_from: - os/cloud-config/ --- diff --git a/docs/os/configuration/kernel-modules-kernel-headers/index.md b/docs/os/configuration/kernel-modules-kernel-headers/index.md index bd87c6d1..8a6dbd60 100644 --- a/docs/os/configuration/kernel-modules-kernel-headers/index.md +++ b/docs/os/configuration/kernel-modules-kernel-headers/index.md @@ -1,6 +1,6 @@ --- title: Installing Kernel Modules with Kernel Headers in RancherOS -layout: os-default + --- diff --git a/docs/os/configuration/loading-kernel-modules/index.md b/docs/os/configuration/loading-kernel-modules/index.md index 84790c38..390d5787 100644 --- a/docs/os/configuration/loading-kernel-modules/index.md +++ b/docs/os/configuration/loading-kernel-modules/index.md @@ -1,6 +1,6 @@ --- title: DKMS / Loadable Kernel Modules in RancherOS -layout: os-default + --- diff --git a/docs/os/configuration/private-registries/index.md b/docs/os/configuration/private-registries/index.md index 20ca4e8b..713051db 100644 --- a/docs/os/configuration/private-registries/index.md +++ b/docs/os/configuration/private-registries/index.md @@ -1,6 +1,6 @@ --- title: Private Registries in RancherOS -layout: os-default + --- diff --git a/docs/os/configuration/resizing-device-partition/index.md b/docs/os/configuration/resizing-device-partition/index.md index 92c70660..7b97f9b5 100644 --- a/docs/os/configuration/resizing-device-partition/index.md +++ b/docs/os/configuration/resizing-device-partition/index.md @@ -1,6 +1,6 @@ --- title: Resizing a Device Partition in RancherOS -layout: os-default + --- diff --git a/docs/os/configuration/running-commands/index.md b/docs/os/configuration/running-commands/index.md index b5e46134..fdcc89d1 100644 --- a/docs/os/configuration/running-commands/index.md +++ b/docs/os/configuration/running-commands/index.md @@ -1,6 +1,6 @@ --- title: Running Commands in RancherOS -layout: os-default + --- diff --git a/docs/os/configuration/setting-up-docker-tls/index.md b/docs/os/configuration/setting-up-docker-tls/index.md index dba5d69c..04465fd5 100644 --- a/docs/os/configuration/setting-up-docker-tls/index.md +++ b/docs/os/configuration/setting-up-docker-tls/index.md @@ -1,6 +1,6 @@ --- title: Configuring TLS in RancherOS -layout: os-default + --- diff --git a/docs/os/configuration/ssh-keys/index.md b/docs/os/configuration/ssh-keys/index.md index a6b7b269..e0696ef9 100644 --- a/docs/os/configuration/ssh-keys/index.md +++ b/docs/os/configuration/ssh-keys/index.md @@ -1,6 +1,6 @@ --- title: SSH Keys in RancherOS -layout: os-default + --- diff --git a/docs/os/configuration/switching-consoles/index.md b/docs/os/configuration/switching-consoles/index.md index e17773aa..0931bb0a 100644 --- a/docs/os/configuration/switching-consoles/index.md +++ b/docs/os/configuration/switching-consoles/index.md @@ -1,6 +1,6 @@ --- title: Switching Consoles in RancherOS -layout: os-default + redirect_from: - os/configuration/custom-console/ diff --git a/docs/os/configuration/switching-docker-versions/index.md b/docs/os/configuration/switching-docker-versions/index.md index 0fdcde34..fb3e98cd 100644 --- a/docs/os/configuration/switching-docker-versions/index.md +++ b/docs/os/configuration/switching-docker-versions/index.md @@ -1,6 +1,6 @@ --- title: Changing Docker Versions in RancherOS -layout: os-default + redirect_from: - os/configuration/custom-docker/ diff --git a/docs/os/configuration/sysctl/index.md b/docs/os/configuration/sysctl/index.md index 9265e64c..4a155e2c 100644 --- a/docs/os/configuration/sysctl/index.md +++ b/docs/os/configuration/sysctl/index.md @@ -1,6 +1,6 @@ --- title: sysctl Settings in RancherOS -layout: os-default + --- diff --git a/docs/os/configuration/users/index.md b/docs/os/configuration/users/index.md index 03f66b4c..186a9c62 100644 --- a/docs/os/configuration/users/index.md +++ b/docs/os/configuration/users/index.md @@ -1,6 +1,6 @@ --- title: Users in RancherOS -layout: os-default + --- diff --git a/docs/os/configuration/write-files/index.md b/docs/os/configuration/write-files/index.md index 684bca53..9837a22e 100644 --- a/docs/os/configuration/write-files/index.md +++ b/docs/os/configuration/write-files/index.md @@ -1,6 +1,6 @@ --- title: Writing Files in RancherOS -layout: os-default + --- diff --git a/docs/os/contributing/index.md b/docs/os/contributing/index.md index 0ce612d7..d9c695b3 100644 --- a/docs/os/contributing/index.md +++ b/docs/os/contributing/index.md @@ -1,6 +1,6 @@ --- title: Contributing to RancherOS -layout: os-default + --- diff --git a/docs/os/custom-builds/custom-kernels/index.md b/docs/os/custom-builds/custom-kernels/index.md index 9aba40cf..94d2815a 100644 --- a/docs/os/custom-builds/custom-kernels/index.md +++ b/docs/os/custom-builds/custom-kernels/index.md @@ -1,6 +1,6 @@ --- title: Custom Kernels in RancherOS -layout: os-default + redirect_from: - os/configuration/custom-kernels/ --- diff --git a/docs/os/custom-builds/custom-rancheros-iso/index.md b/docs/os/custom-builds/custom-rancheros-iso/index.md index 5636cef3..9d6419aa 100644 --- a/docs/os/custom-builds/custom-rancheros-iso/index.md +++ b/docs/os/custom-builds/custom-rancheros-iso/index.md @@ -1,6 +1,6 @@ --- title: Custom RancherOS ISO -layout: os-default + redirect_from: - os/configuration/custom-rancheros-iso/ --- diff --git a/docs/os/faqs/amazon/index.md b/docs/os/faqs/amazon/index.md index c2e99112..87fe70b8 100644 --- a/docs/os/faqs/amazon/index.md +++ b/docs/os/faqs/amazon/index.md @@ -1,6 +1,6 @@ --- title: Amazon FAQs -layout: os-default + --- diff --git a/docs/os/faqs/index.md b/docs/os/faqs/index.md index 86f74082..d9cae13a 100644 --- a/docs/os/faqs/index.md +++ b/docs/os/faqs/index.md @@ -1,6 +1,6 @@ --- title: FAQs -layout: os-default + --- diff --git a/docs/os/index.md b/docs/os/index.md index fae419c6..0e11365c 100644 --- a/docs/os/index.md +++ b/docs/os/index.md @@ -1,7 +1,7 @@ --- title: RancherOS Documentation description: RancherOS is a simplified Linux distribution built from containers, for containers. These documents describe how to install and use RancherOS. -layout: os-default + --- ## Overview of RancherOS diff --git a/docs/os/networking/dns/index.md b/docs/os/networking/dns/index.md index b903872e..f25f32e7 100644 --- a/docs/os/networking/dns/index.md +++ b/docs/os/networking/dns/index.md @@ -1,6 +1,6 @@ --- title: Configuring DNS in RancherOS -layout: os-default + redirect_from: - os/configuration/networking/#dns --- diff --git a/docs/os/networking/interfaces/index.md b/docs/os/networking/interfaces/index.md index 032ee3e4..9f73048a 100644 --- a/docs/os/networking/interfaces/index.md +++ b/docs/os/networking/interfaces/index.md @@ -1,6 +1,6 @@ --- title: Configuring Network Interfaces in RancherOS -layout: os-default + redirect_from: - os/configuration/networking/ --- diff --git a/docs/os/networking/proxy-settings/index.md b/docs/os/networking/proxy-settings/index.md index 6c7cef94..b43590a5 100644 --- a/docs/os/networking/proxy-settings/index.md +++ b/docs/os/networking/proxy-settings/index.md @@ -1,6 +1,6 @@ --- title: Configuring Proxy Settings in RancherOS -layout: os-default + --- diff --git a/docs/os/quick-start-guide/index.md b/docs/os/quick-start-guide/index.md index 8de58e8a..1b10eeb1 100644 --- a/docs/os/quick-start-guide/index.md +++ b/docs/os/quick-start-guide/index.md @@ -1,6 +1,6 @@ --- title: Quick Start Guide for RancherOS -layout: os-default + --- diff --git a/docs/os/running-rancher-on-rancheros/index.md b/docs/os/running-rancher-on-rancheros/index.md index 04808b99..afc1c1ff 100644 --- a/docs/os/running-rancher-on-rancheros/index.md +++ b/docs/os/running-rancher-on-rancheros/index.md @@ -1,6 +1,6 @@ --- title: Running Rancher on RancherOS -layout: os-default + --- diff --git a/docs/os/running-rancheros/cloud/aws/index.md b/docs/os/running-rancheros/cloud/aws/index.md index 24006da3..a013d4c3 100644 --- a/docs/os/running-rancheros/cloud/aws/index.md +++ b/docs/os/running-rancheros/cloud/aws/index.md @@ -1,6 +1,6 @@ --- title: Getting Started on Amazon EC2 -layout: os-default + --- diff --git a/docs/os/running-rancheros/cloud/azure/index.md b/docs/os/running-rancheros/cloud/azure/index.md index 2b851c68..043d4a9d 100644 --- a/docs/os/running-rancheros/cloud/azure/index.md +++ b/docs/os/running-rancheros/cloud/azure/index.md @@ -1,6 +1,6 @@ --- title: Running RancherOS on Azure -layout: os-default + --- diff --git a/docs/os/running-rancheros/cloud/do/index.md b/docs/os/running-rancheros/cloud/do/index.md index d6e289f8..c201d348 100644 --- a/docs/os/running-rancheros/cloud/do/index.md +++ b/docs/os/running-rancheros/cloud/do/index.md @@ -1,6 +1,6 @@ --- title: Running RancherOS on Digital Ocean -layout: os-default + --- diff --git a/docs/os/running-rancheros/cloud/gce/index.md b/docs/os/running-rancheros/cloud/gce/index.md index e27ee67d..e74bc763 100644 --- a/docs/os/running-rancheros/cloud/gce/index.md +++ b/docs/os/running-rancheros/cloud/gce/index.md @@ -1,6 +1,6 @@ --- title: Running RancherOS on GCE -layout: os-default + --- ## Running RancherOS on Google Compute Engine (GCE) diff --git a/docs/os/running-rancheros/cloud/openstack/index.md b/docs/os/running-rancheros/cloud/openstack/index.md index 8df605b2..863dbb49 100644 --- a/docs/os/running-rancheros/cloud/openstack/index.md +++ b/docs/os/running-rancheros/cloud/openstack/index.md @@ -1,6 +1,6 @@ --- title: Rancher RancherOS in Openstack -layout: os-default + --- ## Openstack diff --git a/docs/os/running-rancheros/cloud/vmware-esxi/index.md b/docs/os/running-rancheros/cloud/vmware-esxi/index.md index d1a6a800..7dbb6516 100644 --- a/docs/os/running-rancheros/cloud/vmware-esxi/index.md +++ b/docs/os/running-rancheros/cloud/vmware-esxi/index.md @@ -1,6 +1,6 @@ --- title: Rancher RancherOS in VMware OSXi -layout: os-default + --- ## VMware ESXi diff --git a/docs/os/running-rancheros/index.md b/docs/os/running-rancheros/index.md index 5c6e8472..30bea0b2 100644 --- a/docs/os/running-rancheros/index.md +++ b/docs/os/running-rancheros/index.md @@ -1,6 +1,6 @@ --- title: Running RancherOS -layout: os-default + --- diff --git a/docs/os/running-rancheros/server/install-to-disk/index.md b/docs/os/running-rancheros/server/install-to-disk/index.md index 34459874..344cc904 100644 --- a/docs/os/running-rancheros/server/install-to-disk/index.md +++ b/docs/os/running-rancheros/server/install-to-disk/index.md @@ -1,6 +1,6 @@ --- title: Installing RancherOS to Disk -layout: os-default + --- ## Installing RancherOS to Disk diff --git a/docs/os/running-rancheros/server/pxe/index.md b/docs/os/running-rancheros/server/pxe/index.md index 02c2b489..21750ee1 100644 --- a/docs/os/running-rancheros/server/pxe/index.md +++ b/docs/os/running-rancheros/server/pxe/index.md @@ -1,6 +1,6 @@ --- title: Booting RancherOS with iPXE -layout: os-default + --- ## Booting RancherOS via iPXE diff --git a/docs/os/running-rancheros/server/raspberry-pi/index.md b/docs/os/running-rancheros/server/raspberry-pi/index.md index 12935775..fdcef5bf 100644 --- a/docs/os/running-rancheros/server/raspberry-pi/index.md +++ b/docs/os/running-rancheros/server/raspberry-pi/index.md @@ -1,6 +1,6 @@ --- title: Running RancherOS on Raspberry Pi -layout: os-default + --- ## Raspberry Pi diff --git a/docs/os/running-rancheros/workstation/boot-from-iso/index.md b/docs/os/running-rancheros/workstation/boot-from-iso/index.md index d1726716..22553531 100644 --- a/docs/os/running-rancheros/workstation/boot-from-iso/index.md +++ b/docs/os/running-rancheros/workstation/boot-from-iso/index.md @@ -1,6 +1,6 @@ --- title: Booting from ISO -layout: os-default + --- ## Boot from ISO diff --git a/docs/os/running-rancheros/workstation/docker-machine/index.md b/docs/os/running-rancheros/workstation/docker-machine/index.md index d0bc4515..0d44378b 100644 --- a/docs/os/running-rancheros/workstation/docker-machine/index.md +++ b/docs/os/running-rancheros/workstation/docker-machine/index.md @@ -1,6 +1,6 @@ --- title: Using Docker Machine to run RancherOS -layout: os-default + --- diff --git a/docs/os/security/index.md b/docs/os/security/index.md index 7341d728..5c6712b5 100644 --- a/docs/os/security/index.md +++ b/docs/os/security/index.md @@ -1,6 +1,6 @@ --- title: RancherOS security -layout: os-default + --- diff --git a/docs/os/storage/additional-mounts/index.md b/docs/os/storage/additional-mounts/index.md index 324c0931..3b1100e1 100644 --- a/docs/os/storage/additional-mounts/index.md +++ b/docs/os/storage/additional-mounts/index.md @@ -1,6 +1,6 @@ --- title: Additional Mounts in RancherOS -layout: os-default + redirect_from: - os/configuration/additional-mounts/ --- diff --git a/docs/os/storage/state-partition/index.md b/docs/os/storage/state-partition/index.md index cacfe7cd..37cee84f 100644 --- a/docs/os/storage/state-partition/index.md +++ b/docs/os/storage/state-partition/index.md @@ -1,6 +1,6 @@ --- title: Persistent State Partition in RancherOS -layout: os-default + --- ## Persistent State Partition diff --git a/docs/os/storage/using-zfs/index.md b/docs/os/storage/using-zfs/index.md index 2b8ac5f1..7006a178 100644 --- a/docs/os/storage/using-zfs/index.md +++ b/docs/os/storage/using-zfs/index.md @@ -1,6 +1,6 @@ --- title: Using ZFS in RancherOS -layout: os-default + redirect_from: - os/configuration/storage/ --- diff --git a/docs/os/system-services/adding-system-services/index.md b/docs/os/system-services/adding-system-services/index.md index 2ad604bf..716be4ed 100644 --- a/docs/os/system-services/adding-system-services/index.md +++ b/docs/os/system-services/adding-system-services/index.md @@ -1,6 +1,6 @@ --- title: System Services in RancherOS -layout: os-default + redirect_from: - os/system-services/ - os/configuration/system-services/ diff --git a/docs/os/system-services/custom-system-services/index.md b/docs/os/system-services/custom-system-services/index.md index 1ba82d7c..c1fbcbb9 100644 --- a/docs/os/system-services/custom-system-services/index.md +++ b/docs/os/system-services/custom-system-services/index.md @@ -1,6 +1,6 @@ --- title: Custom System Services in RancherOS -layout: os-default + --- ## Custom System Services diff --git a/docs/os/system-services/environment/index.md b/docs/os/system-services/environment/index.md index ce8cf141..ce9a69af 100644 --- a/docs/os/system-services/environment/index.md +++ b/docs/os/system-services/environment/index.md @@ -1,6 +1,6 @@ --- title: Environment -layout: os-default + --- diff --git a/docs/os/system-services/system-docker-volumes/index.md b/docs/os/system-services/system-docker-volumes/index.md index d672057c..bc297304 100644 --- a/docs/os/system-services/system-docker-volumes/index.md +++ b/docs/os/system-services/system-docker-volumes/index.md @@ -1,6 +1,6 @@ --- title: System Docker Volumes -layout: os-default + --- diff --git a/docs/os/under-the-hood/device-plug-and-unplug/index.md b/docs/os/under-the-hood/device-plug-and-unplug/index.md index 1cf1428f..0e748389 100644 --- a/docs/os/under-the-hood/device-plug-and-unplug/index.md +++ b/docs/os/under-the-hood/device-plug-and-unplug/index.md @@ -1,6 +1,6 @@ --- title: Device Plug and Unplug -layout: os-default + --- diff --git a/docs/os/under-the-hood/directories/index.md b/docs/os/under-the-hood/directories/index.md index e13292e4..8ffa8e24 100644 --- a/docs/os/under-the-hood/directories/index.md +++ b/docs/os/under-the-hood/directories/index.md @@ -1,6 +1,6 @@ --- title: Directories -layout: os-default + --- ## How directories are mounted, Ram disk, etc. diff --git a/docs/os/under-the-hood/porting/index.md b/docs/os/under-the-hood/porting/index.md index 787aaff8..be08d5c2 100644 --- a/docs/os/under-the-hood/porting/index.md +++ b/docs/os/under-the-hood/porting/index.md @@ -1,6 +1,6 @@ --- title: Porting -layout: os-default + --- diff --git a/docs/os/under-the-hood/startup-sequence/index.md b/docs/os/under-the-hood/startup-sequence/index.md index 82c4332c..160893a7 100644 --- a/docs/os/under-the-hood/startup-sequence/index.md +++ b/docs/os/under-the-hood/startup-sequence/index.md @@ -1,6 +1,6 @@ --- title: Startup Sequence -layout: os-default + --- diff --git a/docs/os/under-the-hood/zombie-process-management/index.md b/docs/os/under-the-hood/zombie-process-management/index.md index c15662f3..15d0d12c 100644 --- a/docs/os/under-the-hood/zombie-process-management/index.md +++ b/docs/os/under-the-hood/zombie-process-management/index.md @@ -1,6 +1,6 @@ --- title: Zombie process management -layout: os-default + --- diff --git a/docs/os/upgrading/index.md b/docs/os/upgrading/index.md index b7e4c7d1..ae529826 100644 --- a/docs/os/upgrading/index.md +++ b/docs/os/upgrading/index.md @@ -1,6 +1,6 @@ --- title: Upgrading RancherOS -layout: os-default + ---