smithers1221 / docs

Replicated Documentation

Replicated Documentation Site

Contributing

Contributions are welcome and encouraged! We have published a Contributing Guide to define a writing style to use.

Running locally

Via Docker on OSX

1. Install Docker for OSX.
2. Clone this repo into ~/docs (Important it's important to put this under your home directory somewhere when using Docker for OSX)
3. Run docker-compose up

The docs site will be available at http://localhost:5913/docs/getting-started/

Via Hugo on OSX

1. Install v0.16 of Hugo

cd /tmp
wget https://github.com/spf13/hugo/releases/download/v0.16/hugo_0.16_osx-64bit.tgz
tar xzf hugo_0.16_osx-64bit.tgz
rm -r hugo_0.16_osx-64bit.tgz
mv hugo /usr/local/bin/hugo16

1. Install asciidoctor

brew install git ruby
sudo gem install asciidoctor

1. Install Pygments pip install Pygments
2. Setup API docs

make setup
make SOURCE="https://api.staging.replicated.com/vendor" vendordocs

1. Run Hugo server

cd site/ && hugo16 server -w --config ../hugo-config/docs.toml --contentDir ../docs/