From 0c8ddee6681c4aefa33f10b3950d43fea220ae5f Mon Sep 17 00:00:00 2001 From: Piotr Parczewski Date: Thu, 21 Jan 2021 09:20:28 +0100 Subject: [PATCH] [docs] Update main documentation page * Important links moved to dedicated sections * OpenStack community project badge added Change-Id: I6ccf813b4eef68a7f574ff596d92d5bfefa874b0 --- README.rst | 35 ++++++++++++++++++++++++++++------- doc/source/index.rst | 4 ++++ 2 files changed, 32 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index f714a6338..b152aa035 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,9 @@ Kayobe ====== +.. image:: https://governance.openstack.org/tc/badges/kayobe.svg + :target: https://governance.openstack.org/tc/reference/projects/kolla.html + Kayobe enables deployment of containerised OpenStack to bare metal. Containers offer a compelling solution for isolating OpenStack services, but @@ -25,13 +28,6 @@ To this solid base, kayobe adds: All this and more, automated from top to bottom using Ansible. -* Free software: Apache license -* Documentation: https://docs.openstack.org/kayobe/latest/ -* Source: https://opendev.org/openstack/kayobe -* Bugs: https://storyboard.openstack.org/#!/project/openstack/kayobe -* Release Notes: https://docs.openstack.org/releasenotes/kayobe/ -* IRC: #openstack-kolla - Features -------- @@ -54,3 +50,28 @@ Features `_ * Control plane and workload monitoring and log aggregation using `OpenStack monasca `_ + +Documentation +------------- + +https://docs.openstack.org/kayobe/latest/ + +Release Notes +------------- + +https://docs.openstack.org/releasenotes/kayobe/ + +Bugs +---- + +https://storyboard.openstack.org/#!/project/openstack/kayobe + +Community +--------- + +Freenode's `IRC channel `_: #openstack-kolla + +License +------- + +Kayobe is distributed under the `Apache 2.0 License `__. diff --git a/doc/source/index.rst b/doc/source/index.rst index ef2007595..d2cf2aa1f 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -18,7 +18,11 @@ This documentation is maintained at opendev.org welcome, see :doc:`contributing ` for information on how. +Kayobe +====== + .. include:: ../../README.rst + :start-line: 6 Contents ========