summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorIdan Amit <ia096e@intl.att.com>2017-11-02 19:20:23 +0200
committerIdan Amit <ia096e@intl.att.com>2017-11-05 06:43:38 +0000
commitcd53dc5b978d25652535b5b4a33d6165239ec660 (patch)
treee32a0b98a4ebff917c62f4fc0d7c3f871e8ab1b6 /docs
parent120584659bfa2e96af3b5dd445b5c60b64b96b1b (diff)
Added SDC SDKs section to Read the Docs
Added a section describing all the SDC SDKs Change-Id: I223f569353b8382856811afd9fd9bf8e13253639 Issue-Id: SDC-579 Signed-off-by: Idan Amit <ia096e@intl.att.com> (cherry picked from commit a4a1e1fdf20d274e047a8f92dab4872172520167)
Diffstat (limited to 'docs')
-rw-r--r--docs/index.rst1
-rw-r--r--docs/sdcsdks.rst41
2 files changed, 42 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
index cc71b4572b..193734d26d 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -16,3 +16,4 @@ SDC Documentation
installation.rst
logging.rst
release-notes.rst
+ sdcsdks.rst \ No newline at end of file
diff --git a/docs/sdcsdks.rst b/docs/sdcsdks.rst
new file mode 100644
index 0000000000..4cb40e83b7
--- /dev/null
+++ b/docs/sdcsdks.rst
@@ -0,0 +1,41 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+========
+SDC SDKs
+========
+
+
+SDC SDKs List
+=============
+
+The sdc projects consists of a few additional sub projects listed below:
+
+- sdc-tosca
+- sdc-jtosca
+- sdc-distribution-client
+- sdc-titan-cassandra
+
+SDC SDKs guide
+==============
+
+SDC-TOSCA and SDC-DISTRIBUTION-CLIENT
+-------------------------------------
+| This is a link to a document describing the usage for the sdc-tosca, sdc-jtosca and sdc-distribution-client projects: `SDC Sub Projects <https://wiki.onap.org/display/DW/SDC+Distribution+client+AID?preview=/11929307/11929304/SDC_Distribution_AID_1710_030717.docx>`_
+|
+| The link describes the use of distribution client and the sdc-tosca.
+| jtosca is used by sdc-tosca as a dependency and is not used separately
+
+SDC-TITAN-CASSANDRA
+-------------------
+
+| This is a link to the github page of titan project for extra reading regarding Titan DB: `<https://github.com/thinkaurelius/titan>`_
+|
+| SDC forked part of the project to overide the default Titan configuration for Cassandra.
+| The change allows the use of Titan as an active pasive deployment for geo redudndency.
+|
+| Titan by default uses QUORUM in Cassandra on write and read operations.
+| Using our change allows the use of local QUORUM to read and write only to a spacific data center.
+| Since the project is in end of life state the change cannot be merged back to the project.
+
+