From fa34d044204c4010e606ca8d0dba73bec17cc63b Mon Sep 17 00:00:00 2001 From: Kun Huang Date: Wed, 11 Nov 2015 00:46:48 +0800 Subject: [PATCH] mv readme.md to readme.rst Change-Id: Id48b6403fea09d01dde030aec8e25437df967fa7 --- README.md => README.rst | 18 ++++++++++++------ setup.cfg | 2 +- 2 files changed, 13 insertions(+), 7 deletions(-) rename README.md => README.rst (82%) diff --git a/README.md b/README.rst similarity index 82% rename from README.md rename to README.rst index 8c4ef13..7434202 100644 --- a/README.md +++ b/README.rst @@ -1,25 +1,31 @@ -# Scalpels +Scalpels +======== Scalpels is distributed tracing or digging system for OpenStack. -## Background +Background +========== OpenStack is made of multiple Python-based projects. Each project has similiar but different architecture. Scalpels gathers useful scripts or 3rd tools to help operator find what happen in your cloud. -## Contribute +Contribute +========== This project is prototype now and under development. If you have interests in this work, please contact @kun_huang, at #openstack-chinese channel. -## Single Node Architecture +Single Node Architecture +======================== This type of deployment is used as POC in OpenStack community CI. .. image:: doc/source/images/allinone.png :alt: All-in-One deployment -## Multiple Node Architecture +Multiple Node Architecture +========================== This is under Designing: .. image:: doc/source/images/multiple.png :alt: Multiple deployment -## Ideas +Ideas +===== Each project will have scripts working: * on python calls diff --git a/setup.cfg b/setup.cfg index 7f695cc..31cfa63 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,7 +1,7 @@ [metadata] name = scalpels summary = OpenStack digging system -description-file = README.md +description-file = README.rst author = Kun Huang author-email = academicgareth@gmail.com maintainer = Kun Huang