summaryrefslogtreecommitdiffstats
path: root/docs/templates/sdk
diff options
context:
space:
mode:
authorRich Bennett <rb2745@att.com>2017-09-18 17:28:09 -0400
committerRich Bennett <rb2745@att.com>2017-09-18 17:30:57 -0400
commit0c8264373da31776958996736cab3701e18d1d34 (patch)
tree26623eba12301eccdb92b29da42ac7a06137b9e5 /docs/templates/sdk
parentc028ba557d33cddd5c7a8c346cc2a88afb853279 (diff)
Updates to templates based on Webinar Feedback
Change-Id: Ib01e3642ec89cbb730a28eb1fd7061d25cdd9e9f Issue-ID: DOC-26 Signed-off-by: Rich Bennett <rb2745@att.com>
Diffstat (limited to 'docs/templates/sdk')
-rw-r--r--docs/templates/sdk/architecture.rst7
-rw-r--r--docs/templates/sdk/build.rst5
-rw-r--r--docs/templates/sdk/index.rst4
-rw-r--r--docs/templates/sdk/interfaces.rst3
-rw-r--r--docs/templates/sdk/libraries.rst2
-rw-r--r--docs/templates/sdk/logging.rst6
-rw-r--r--docs/templates/sdk/offeredapis.rst8
7 files changed, 13 insertions, 22 deletions
diff --git a/docs/templates/sdk/architecture.rst b/docs/templates/sdk/architecture.rst
new file mode 100644
index 000000000..4dede8e5a
--- /dev/null
+++ b/docs/templates/sdk/architecture.rst
@@ -0,0 +1,7 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+
+Architecture
+------------
+Describe the architecture and design of the SDK.
diff --git a/docs/templates/sdk/build.rst b/docs/templates/sdk/build.rst
index 11f4ac537..e8af74eb9 100644
--- a/docs/templates/sdk/build.rst
+++ b/docs/templates/sdk/build.rst
@@ -1,7 +1,6 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-Building components that use the SDK
-------------------------------------
-
+Building a Component using the SDK
+==================================
diff --git a/docs/templates/sdk/index.rst b/docs/templates/sdk/index.rst
index 8c31c9b58..0cc744197 100644
--- a/docs/templates/sdk/index.rst
+++ b/docs/templates/sdk/index.rst
@@ -6,10 +6,10 @@ Software Development Kit
Provide an overview of SDK capabilities here.
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
+ architecture.rst
offeredapis.rst
libraries.rst
- interfaces.rst
logging.rst
build.rst
diff --git a/docs/templates/sdk/interfaces.rst b/docs/templates/sdk/interfaces.rst
deleted file mode 100644
index d28496fa2..000000000
--- a/docs/templates/sdk/interfaces.rst
+++ /dev/null
@@ -1,3 +0,0 @@
-Interfaces
-----------
-Language bindings
diff --git a/docs/templates/sdk/libraries.rst b/docs/templates/sdk/libraries.rst
index 36143660a..618c04428 100644
--- a/docs/templates/sdk/libraries.rst
+++ b/docs/templates/sdk/libraries.rst
@@ -3,5 +3,5 @@
Libraries
---------
-Libraries provided including package/Nexus groupID names, language bindings, etc.
+Provide library package and Nexus groupID names
diff --git a/docs/templates/sdk/logging.rst b/docs/templates/sdk/logging.rst
index 8d480e283..4b272ad76 100644
--- a/docs/templates/sdk/logging.rst
+++ b/docs/templates/sdk/logging.rst
@@ -3,12 +3,6 @@
Logging & Diagnostic Information
--------------------------------
-Description of how to interact with and diagnose problems with the components
-as delivered.
-
-Where to Access Information
-+++++++++++++++++++++++++++
-
Error / Warning Messages
++++++++++++++++++++++++
diff --git a/docs/templates/sdk/offeredapis.rst b/docs/templates/sdk/offeredapis.rst
index 3e3b5b3d0..4e72427d9 100644
--- a/docs/templates/sdk/offeredapis.rst
+++ b/docs/templates/sdk/offeredapis.rst
@@ -3,10 +3,4 @@
Offered APIs
-============
-List APIs offered. One or more of the following examples may be appropriate.
-
-* java docs link
-* rest API swagger json definition displayed with sphinx directive .. swaggerv2doc:
-* a restructured text document
-
+------------