Usage docs (#501)

* Add setup and usage docs

Signed-off-by: lucperkins <lucperkins@gmail.com>

* Finish initial version of setup doc

* Add YAML config file for CLI docs

* Finish CLI shortcode

Signed-off-by: lucperkins <lucperkins@gmail.com>

* Fix scrolling on mobile

Signed-off-by: lucperkins <lucperkins@gmail.com>

* Finish first version of usage doc

Signed-off-by: lucperkins <lucperkins@gmail.com>

* Remove go install section, modify CSS for CLI docs, and fix typo

Signed-off-by: lucperkins <lucperkins@gmail.com>
This commit is contained in:
Luc Perkins
2019-01-24 11:01:42 -08:00
committed by Brian Goff
parent 48127bfcf5
commit 318edee630
13 changed files with 252 additions and 8 deletions

View File

@@ -0,0 +1,24 @@
---
title: Setup
description: Install Virtual Kubelet using one of several methods
weight: 1
---
You can install Virtual Kubelet by building it [from source](#source). First, make sure that you have a [`GOPATH`](https://github.com/golang/go/wiki/GOPATH) set. Then clone the Virtual Kubelet repository and run `make build`:
```bash
mkdir -p ${GOPATH}/src/github.com/virtual-kubelet
cd ${GOPATH}/src/github.com/virtual-kubelet
git clone https://github.com/virtual-kubelet/virtual-kubelet
make build
```
This method adds a `virtual-kubelet` executable to the `bin` folder. To run it:
```bash
bin/virtual-kubelet
```
## Using Virtual Kubelet
Once you have Virtual Kubelet installed, you can move on to the [Usage](../usage) documentation.