From 524ea426542bb2ed66fa38de18d27a62117699e8 Mon Sep 17 00:00:00 2001 From: Yujun Zhang Date: Mon, 27 Mar 2017 14:57:20 +0800 Subject: Add overview in developer guide Change-Id: I491f921d87cf0cec3bbef5a78e9f3065b1e012a1 Signed-off-by: Yujun Zhang (cherry picked from commit cb8ec13d8981cea1dc5556d86ea01b45c29f1046) --- docs/testing/developer/devguide/index.rst | 1 + docs/testing/developer/devguide/overview.rst | 27 +++++++++++++++++++++++++++ 2 files changed, 28 insertions(+) create mode 100644 docs/testing/developer/devguide/overview.rst diff --git a/docs/testing/developer/devguide/index.rst b/docs/testing/developer/devguide/index.rst index 2b4bd9b0..89113e56 100644 --- a/docs/testing/developer/devguide/index.rst +++ b/docs/testing/developer/devguide/index.rst @@ -10,6 +10,7 @@ QTIP Design Specifications .. toctree:: :maxdepth: 2 + overview.rst arch.rst cli.rst api.rst diff --git a/docs/testing/developer/devguide/overview.rst b/docs/testing/developer/devguide/overview.rst new file mode 100644 index 00000000..4ccaae20 --- /dev/null +++ b/docs/testing/developer/devguide/overview.rst @@ -0,0 +1,27 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2017 ZTE Corp. + + +######## +Overview +######## + +QTIP uses Python as primary programming language. The structure of repository is based on the recommended sample in +`The Hitchhiker's Guide to Python`_ + +============== ========================================================================== +Path Content +============== ========================================================================== +./benchmarks/ builtin benchmark assets including plan, QPI and metrics +./contrib/ independent project/plugin/code contributed to QTIP +./docker/ configuration for building Docker image for QTIP deployment +./docs/ release notes, user and developer documentation, design proposals +./legacy/ legacy obsoleted code that is unmaintained but kept for reference +./opt/ optional component, e.g. scripts to setup infrastructure services for QTIP +./qtip/ the actual package +./tests/ package functional and unit tests +./third-party/ third part included in QTIP project +============== ========================================================================== + +.. _The Hitchhiker's Guide to Python: http://python-guide-pt-br.readthedocs.io/en/latest/writing/structure/ -- cgit 1.2.3-korg