istio
/
istio.io
mirror of https://github.com/istio/istio.io.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

added some instructions to help non-linux users build the website (#206)

This commit is contained in:
Christian Posta 2017-05-19 09:07:49 -07:00 committed by Shriram Rajagopalan
parent 6d294d01e3
commit 6ee1907d89
1 changed files with 37 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@ -24,3 +24,40 @@ docker run --rm --label=jekyll --volume=$(pwd):/srv/jekyll -it jekyll/jekyll s
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](https://docs.docker.com/docker-for-mac/) / [Docker for Windows](https://docs.docker.com/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 Istio development on Kubernetes locally with [minikube](https://kubernetes.io/docs/getting-started-guides/minikube/) and native virtualization (for example, on Mac OS X with[xhyve driver](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#xhyve-driver), then bootstrap like this:
```bash
minikube start --vm-driver=xhyve
```
You can see more about this command and how to install the [xhyve](https://github.com/kubernetes/minikube/blob/master/docs/drivers.md#xhyve-driver) drivers by [taking a look at the xhyve driver documentation](https://github.com/zchee/docker-machine-driver-xhyve#install)
Then build and run the website with minikube and bind to your `minikube ip` like this:
```bash
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:
```bash
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 istio.github.io
$ bundle install
$ bundle exec jekyll build
$ bundle exec jekyll serve