summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFatih Degirmenci <fatih.degirmenci@ericsson.com>2017-03-31 23:06:47 +0200
committerFatih Degirmenci <fatih.degirmenci@ericsson.com>2017-03-31 23:06:47 +0200
commitaf6c4a595ae49709a07e0bdb7cc9357d92793b20 (patch)
tree2fc2a61426b3669a314a72d24eaf923e2c2156ac
parentac3f798b30ba5d8dcd13b41b309c530dd68ff520 (diff)
xci: Start developer documentation
Change-Id: Ib5200372a44ee6a22b45c2105b3729d362eacb1d Signed-off-by: Fatih Degirmenci <fatih.degirmenci@ericsson.com>
-rw-r--r--prototypes/xci/docs/developer-guide.rst31
1 files changed, 31 insertions, 0 deletions
diff --git a/prototypes/xci/docs/developer-guide.rst b/prototypes/xci/docs/developer-guide.rst
new file mode 100644
index 000000000..9a07b1267
--- /dev/null
+++ b/prototypes/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