From: Rich Bennett Date: Mon, 18 Sep 2017 21:28:09 +0000 (-0400) Subject: Updates to templates based on Webinar Feedback X-Git-Tag: 1.0.0-Amsterdam~2201^2 X-Git-Url: https://gerrit.onap.org/r/gitweb?p=doc.git;a=commitdiff_plain;h=0c8264373da31776958996736cab3701e18d1d34 Updates to templates based on Webinar Feedback Change-Id: Ib01e3642ec89cbb730a28eb1fd7061d25cdd9e9f Issue-ID: DOC-26 Signed-off-by: Rich Bennett --- diff --git a/docs/guides/onap-developer/architecture/index.rst b/docs/guides/onap-developer/architecture/index.rst index 8d06c4f1f..4c7aad10f 100644 --- a/docs/guides/onap-developer/architecture/index.rst +++ b/docs/guides/onap-developer/architecture/index.rst @@ -9,6 +9,9 @@ Platform Components SDKs ---- +Data Models +----------- + Dependencies ------------ diff --git a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst index 6ec4ed849..d6f720c97 100644 --- a/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst +++ b/docs/guides/onap-developer/how-to-use-docs/include-documentation.rst @@ -131,12 +131,12 @@ to convert or add new content you can update the index and add files under the d The diagram below illustrates what is accomplished in the setup steps above from the perspective of a file structure created for a local test, a jenkins verify job, and/or published release documentation including: - - - ONAP gerrit project repositories, - - doc project repository master document index.rst, templates, configuration, and other documents - - submodules directory where other project repositories and directories/files are referenced - - file structure: directories (ellipses), files(boxes) - - references: directory/files (solid edges), git submodule (dotted edges), sphinx toctree (dashed edges) + +- ONAP gerrit project repositories, +- doc project repository master document index.rst, templates, configuration, and other documents +- submodules directory where other project repositories and directories/files are referenced +- file structure: directories (ellipses), files(boxes) +- references: directory/files (solid edges), git submodule (dotted edges), sphinx toctree (dashed edges) .. graphviz:: diff --git a/docs/templates/platform-component/architecture.rst b/docs/templates/platform-component/architecture.rst new file mode 100644 index 000000000..fd46637fd --- /dev/null +++ b/docs/templates/platform-component/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 platform component. diff --git a/docs/templates/platform-component/index.rst b/docs/templates/platform-component/index.rst index 4364739ee..d5db511f1 100644 --- a/docs/templates/platform-component/index.rst +++ b/docs/templates/platform-component/index.rst @@ -7,11 +7,12 @@ Provide an overview of the ONAP Platform component capabilities here. Add or remove sections below as appropriate for the platform component. .. toctree:: - :maxdepth: 2 + :maxdepth: 1 - delivery.rst + architecture.rst offeredapis.rst consumedapis.rst + delivery.rst logging.rst installation.rst configuration.rst 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 - +------------