airship
/
shipyard
Code Issues Proposed changes

[docs] Include Read the Docs link in README 

Updates the base README.md to include the link to the full
documentation at Read the Docs.

Change-Id: I8e53700aebff8af2b1f51c7e2767a25af2e6c18e
This commit is contained in:
Bryan Strassner 2018-03-22 17:00:45 -05:00
parent 8db6e6e7b5
commit 4fd8d79574
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -1,7 +1,7 @@
# Shipyard # Shipyard
Shipyard is the directed acyclic graph controller for Kubernetes and Shipyard is the directed acyclic graph controller for Kubernetes and
OpenStack control plane life cycle management, and a component of the OpenStack control plane life cycle management, and a component of the
Undercloud Platform (UCP) Undercloud Platform (UCP).
Shipyard provides the entrypoint for the following aspects of the Shipyard provides the entrypoint for the following aspects of the
control plane established by the UCP: control plane established by the UCP:
@ -33,7 +33,11 @@ control plane established by the UCP:
</dd> </dd>
</dl> </dl>
## Intgration Points: Find more documentation for Shipyard on
[Read the Docs](http://shipyard.readthedocs.io/en/latest/)
## Integration Points:
[OpenStack Identity (Keystone)](https://github.com/openstack/keystone) [OpenStack Identity (Keystone)](https://github.com/openstack/keystone)
provides authentication and support for role based authorization provides authentication and support for role based authorization
\ \
@ -57,7 +61,6 @@ orchestrated by Shipyard to configure and join Kubernetes nodes
Shipyard to deploy and test Kubernetes workloads Shipyard to deploy and test Kubernetes workloads
## Getting Started: ## Getting Started:
[Shipyard @ Gerrithub](https://review.gerrithub.io/#/q/project:att-comdev/shipyard) [Shipyard @ Gerrithub](https://review.gerrithub.io/#/q/project:att-comdev/shipyard)