Added SDC SDKs section to Read the Docs 19/21919/1
authorIdan Amit <ia096e@intl.att.com>
Thu, 2 Nov 2017 17:20:23 +0000 (19:20 +0200)
committerIdan Amit <ia096e@intl.att.com>
Thu, 2 Nov 2017 17:20:23 +0000 (19:20 +0200)
Added a section describing all the SDC SDKs

Change-Id: I223f569353b8382856811afd9fd9bf8e13253639
Issue-Id: SDC-579
Signed-off-by: Idan Amit <ia096e@intl.att.com>
docs/index.rst
docs/sdcsdks.rst [new file with mode: 0644]

index cc71b45..193734d 100644 (file)
@@ -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 (file)
index 0000000..4cb40e8
--- /dev/null
@@ -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.
+
+