From 4fd8d79574bb444b9c7802e3700b955693a9c61d Mon Sep 17 00:00:00 2001 From: Bryan Strassner Date: Thu, 22 Mar 2018 17:00:45 -0500 Subject: [PATCH] [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 --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index dc6af8f0..e18b8896 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Shipyard Shipyard is the directed acyclic graph controller for Kubernetes and 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 control plane established by the UCP: @@ -33,7 +33,11 @@ control plane established by the UCP: -## 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) 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 - ## Getting Started: [Shipyard @ Gerrithub](https://review.gerrithub.io/#/q/project:att-comdev/shipyard)