sunnycmf / guide

Screwdriver Documentation

Screwdriver Guide

Installation of MkDocs

In order to install MkDocs you'll need Python installed on your system, as well as the Python package manager, pip. You can check if you have these already installed like so:

$ python --version
Python 2.7.2
$ pip --version
pip 1.5.2

MkDocs supports Python 2.6, 2.7, 3.3, 3.4 and 3.5.

Standard

Install the mkdocs package and our theme using pip:

pip install -r requirements.txt

You should now have the mkdocs command installed on your system. Run mkdocs --version to check that everything worked okay.

$ mkdocs --version
mkdocs, version 0.15.3

Virtualenv

If you prefer to develop the Screwdriver guide in an isolated Python environment, you can use virtualenv.

$ virtualenv --version
15.0.2

With virtualenv, you can simply run a Makefile target to configure a virtual environment with all the necessary dependencies.

$ make venv

Viewing docs locally

There's a single configuration file named mkdocs.yml, and a folder named docs that will contain our documentation source files.

MkDocs comes with a built-in webserver that lets you preview your documentation as you work on it. You can start the webserver locally either with MkDocs directly or with virtualenv.

Standard

MkDocs comes with a built-in webserver that lets you preview your documentation as you work on it. We start the webserver by making sure we're in the same directory as the mkdocs.yml config file, and then running the mkdocs serve command:

$ mkdocs serve
Running at: http://127.0.0.1:8000/

Virtualenv

# This will also run the "venv" Makefile target
$ make local

Browse your local guide

Once you successfully start the webserver, open up http://127.0.0.1:8000/ in your browser. You'll be able to see the index page being displayed.

Adding docs

Simply add a new markdown document to the folder hierarchy in docs, and add an entry to the tree in mkdocs.yml

Documentation Structure

• Homepage
  • What are the sections for
• Cluster Management (for SD owners)
  • Overall architecture
  • Running locally
  • Configuring API
    • Scm plugins
    • Datastore plugins
  • Configuring UI
  • Configuring Store
    • Logging plugins
  • Examples
    • Setting up Kubernetes
  • Debugging
• User Guide
  • Quickstart
  • Configuration
    • Overall YAML
    • Secrets
  • API
  • Authentication and Authorization
• About
  • What is SD?
  • Appendix
    • Execution engines
    • Domain model
  • Contributing
  • Support