slate.github.io

This repository contains the source code for the slateci.io web site. It is modeled after the istio.io website.

How to contribute

You can contribute to the website simply by modifying the markdown in the places.

How to modify a page that already exists

Each page on the website as a link "Edit This Page on GitHub". This will open the corresponding markdown page in the repository. Edit and commit.

How to add a post on the blog

Blog posts are in the directory posts. Add a file there following the format of the others.

Technical details

The website uses Jekyll templates and is hosted on GitHub Pages.

To run the site locally with Docker, use the following command:

docker run --rm --label=jekyll --volume=$(pwd):/srv/jekyll  -it -p 127.0.0.1:4000:4000 jekyll/jekyll jekyll serve

Make sure you are not introducing html errors or bad links:

docker run --rm --label=jekyll --volume=$(pwd):/srv/jekyll  -it  jekyll/jekyll sh -c "bundle install && rake test"

HTML-Proofer finished successfully.

Side note for those on non-linux machines

If you're developing locally but not on a Linux machine, you have a couple options. You can opt to use Docker for Mac / Docker for Windows. This will give you a docker environment from which to run the above docker container (which has all the of the correct Jekyll dependencies and Ruby versions installed). Alternatively, you could use minikube.

If doing SLATE development on Kubernetes locally with minikube and native virtualization (for example, on Mac OS X withxhyve driver, then bootstrap like this:

minikube start --vm-driver=xhyve

You can see more about this command and how to install the xhyve drivers by taking a look at the xhyve driver documentation

Then build and run the website with minikube and bind to your minikube ip like this:

docker run --rm --label=jekyll  --volume=$(pwd):/srv/jekyll  -it -p $(minikube ip):4000:4000 jekyll/jekyll jekyll serve 

To see the web page locally on localhost:4000, you can port-forward the minikube port 4000 to your local machine. Run this command in a separate tab/window:

minikube ssh -- -vnNTL *:4000:$(minikube ip):4000 

Alternatively, if you just want to develop locally w/o Docker/Kubernetes/Minikube, you can try installing Jekyll locally. You may need to install other prerequisites manually (which is where using the docker image shines). Here's an example of doing so for Mac OS X:

$ xcode-select --install
$ brew install ruby
$ sudo gem install bundler
$ sudo gem install jekyll
$ cd slateci.github.io
$ bundle install
$ bundle exec jekyll build
$ bundle exec jekyll serve