diff options
| author |   Rich Bennett <rb2745@att.com> | 2017-09-13 03:19:19 -0400 |
|---|---|---|
| committer | Rich Bennett <rb2745@att.com> | 2017-09-13 07:39:09 +0000 |
| commit | 5baea4608e685f67e9dec77cfee57cacb73662dd (patch) | |
| tree | 3f6349e6ef9a6c0eb487a721087d0644dafd73d8 /docs/templates/sdk | |
| parent | a7f9e351a97b5b5b89e4e1eccd201a3e15e8f385 (diff) | |
Enhancement and additions for webinar
Add templates, revise master index, guides, and release document
Improve project integration instructions based on 5 project
integrations.
Change-Id: I2a3e62737f3c126b7f5fb7cc4f53b35dba4f1d8f
Issue-ID: DOC-26
Signed-off-by: Rich Bennett <rb2745@att.com>
Diffstat (limited to 'docs/templates/sdk')
| -rw-r--r-- | docs/templates/sdk/build.rst | 7 | ||||
| -rw-r--r-- | docs/templates/sdk/index.rst | 15 | ||||
| -rw-r--r-- | docs/templates/sdk/interfaces.rst | 3 | ||||
| -rw-r--r-- | docs/templates/sdk/libraries.rst | 7 | ||||
| -rw-r--r-- | docs/templates/sdk/logging.rst | 14 | ||||
| -rw-r--r-- | docs/templates/sdk/offeredapis.rst | 12 |
6 files changed, 58 insertions, 0 deletions
diff --git a/docs/templates/sdk/build.rst b/docs/templates/sdk/build.rst new file mode 100644 index 000000000..11f4ac537 --- /dev/null +++ b/docs/templates/sdk/build.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 + +Building components that use the SDK +------------------------------------ + + diff --git a/docs/templates/sdk/index.rst b/docs/templates/sdk/index.rst new file mode 100644 index 000000000..8c31c9b58 --- /dev/null +++ b/docs/templates/sdk/index.rst @@ -0,0 +1,15 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Software Development Kit +======================== +Provide an overview of SDK capabilities here. + +.. toctree:: + :maxdepth: 2 + + offeredapis.rst + libraries.rst + interfaces.rst + logging.rst + build.rst diff --git a/docs/templates/sdk/interfaces.rst b/docs/templates/sdk/interfaces.rst new file mode 100644 index 000000000..d28496fa2 --- /dev/null +++ b/docs/templates/sdk/interfaces.rst @@ -0,0 +1,3 @@ +Interfaces +---------- +Language bindings diff --git a/docs/templates/sdk/libraries.rst b/docs/templates/sdk/libraries.rst new file mode 100644 index 000000000..36143660a --- /dev/null +++ b/docs/templates/sdk/libraries.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 + +Libraries +--------- +Libraries provided including package/Nexus groupID names, language bindings, etc. + diff --git a/docs/templates/sdk/logging.rst b/docs/templates/sdk/logging.rst new file mode 100644 index 000000000..8d480e283 --- /dev/null +++ b/docs/templates/sdk/logging.rst @@ -0,0 +1,14 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +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 new file mode 100644 index 000000000..3e3b5b3d0 --- /dev/null +++ b/docs/templates/sdk/offeredapis.rst @@ -0,0 +1,12 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + + +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 + |