summaryrefslogtreecommitdiffstats
path: root/xci/docs
diff options
context:
space:
mode:
authorFatih Degirmenci <fatih.degirmenci@ericsson.com>2017-03-31 23:06:47 +0200
committerTrevor Bramwell <tbramwell@linuxfoundation.org>2017-08-11 12:56:12 -0700
commitf1379ff726a2d3fa322e121071b77cdecd39cc2c (patch)
treef32ec9fd28a5d53bd9468e8f4a1fcfbea19db047 /xci/docs
parent12ac3f7e09d6fc13d69eb9a4a744631c57eeb724 (diff)
xci: Start developer documentation
Change-Id: Ib5200372a44ee6a22b45c2105b3729d362eacb1d Signed-off-by: Fatih Degirmenci <fatih.degirmenci@ericsson.com>
Diffstat (limited to 'xci/docs')
-rw-r--r--xci/docs/developer-guide.rst31
1 files changed, 31 insertions, 0 deletions
diff --git a/xci/docs/developer-guide.rst b/xci/docs/developer-guide.rst
new file mode 100644
index 00000000..9a07b126
--- /dev/null
+++ b/xci/docs/developer-guide.rst
@@ -0,0 +1,31 @@
+#########################
+OPNFV XCI Developer Guide
+#########################
+
+This document will contain details about the XCI and how things are put
+together in order to support different flavors and different distros in future.
+
+Document is for anyone who will
+
+- do hands on development with XCI such as new features to XCI itself or
+ bugfixes
+- integrate new features
+- want to know what is going on behind the scenes
+
+It will also have guidance regarding how to develop for the sandbox.
+
+If you are looking for User's Guide, please check README.rst in the root of
+xci folder or take a look at
+`Wiki <https://wiki.opnfv.org/display/INF/OpenStack>`_.
+
+===================================
+Components of XCI Developer Sandbox
+===================================
+
+TBD
+
+=============
+Detailed Flow
+=============
+
+TBD