Documentation for Shippable's Automated DevOps platform
JavaScript Python CSS PHP HTML Shell
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
algolia Fix algolia indexing Jul 7, 2018
sources updating integration tutorials Aug 16, 2018
theme removed some unreferenced files and added page_main_title Jul 13, 2018
.dockerignore Add Dockerfile, boot, and base scripts Apr 5, 2017
.gitignore Git ignore Algolia artifacts Aug 2, 2018
Dockerfile Use latest u16microbase image for onebox Jun 22, 2018
README.md corrects scriptname in README Oct 10, 2017
boot.sh Add Dockerfile, boot, and base scripts Apr 5, 2017
createredirect.sh update docs May 16, 2017
deployDocs.sh
dev-robots.txt Adds robots.txt file for prod and dev environments Jun 20, 2017
get-pip.py
mapping.txt
mkdocs.yml updating integration tutorials Aug 15, 2018
onebox Update sections Oct 5, 2017
prod-robots.txt Adds robots.txt file for prod and dev environments Jun 20, 2017
requirements.txt
shippable.yml tired of fixing broken links Jun 22, 2018
sitemap.xml updating integration tutorials Aug 14, 2018

README.md

docs

Documentation for Shippable's Automated DevOps platform

Using Local Installation

With Docker

$ git clone git@github.com:Shippable/docs.git shippable-docs
$ cd shippable-docs
$ ./onebox

Docs should be available at localhost:5555 once the onebox script finishes successfully.

Without Docker

To get started you have to have git and python3 with pip and virtualenv installed:

$ git clone git@github.com:Shippable/docs.git shippable-docs
$ cd shippable-docs
$ virtualenv venv
$ source venv/bin/activate
(venv)$ pip install -r requirements.txt
Server

To start documentation server at localhost:5555:

(venv)$ mkdocs serve --dev-addr=localhost:5555

This uses livereload to monitors changes to the files. Therefore as soon as you save a file, the browser is refreshed.