shipyard/docs/source/index.rst
Anthony Lin 77d962013f Move Shipyard Deployment Guide from .md to .rst
This patch set changes the shipyard deployment guide from
markdown to reStructuredText format. It also adds banners
to the other .rst document.

It seems that client set up using the current instructions with
Python 2.x was giving syntax errors when we try and execute the
Shipyard CLI. Hence, updates were also made to client_user_guide
to specify the usage of Python 3.x

Note that 'Drydock build' includes step that checks that the
nodes are deployed before starting 'Armada Build'. Hence we
are collapsing 'Drydock build' and 'Check deployed node status'
into a single step, i.e. 'Drydock build' instead.

Change-Id: Ie5f15b81d4dc89afb9c6800e7a181b02f2acabcc
2017-12-18 08:48:08 +00:00

40 lines
1.1 KiB
ReStructuredText

..
Copyright 2017 AT&T Intellectual Property.
All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
====================================
Welcome to Shipyard's documentation!
====================================
Shipyard is a directed acyclic graph controller for Kubernetes and OpenStack
control plane life-cycle management.
User's Guide
============
Shipyard Configuration Guide
----------------------------
.. toctree::
:maxdepth: 2
sampleconf
policy-enforcement
API
API_action_commands
CLI
client_user_guide
deployment_guide