diff options
| -rw-r--r-- | .gitmodules | 5 | ||||
| -rw-r--r-- | docs/guides/onap-developer/architecture/index.rst | 3 | ||||
| -rw-r--r-- | docs/guides/onap-developer/how-to-use-docs/include-documentation.rst | 12 | ||||
| -rw-r--r-- | docs/release/repolist.rst | 1 | ||||
| m--------- | docs/submodules/aaf/authz.git | 0 | ||||
| m--------- | docs/submodules/appc.git | 0 | ||||
| m--------- | docs/submodules/appc/deployment.git | 0 | ||||
| m--------- | docs/submodules/clamp.git | 0 | ||||
| m--------- | docs/submodules/cli.git | 0 | ||||
| m--------- | docs/submodules/dcaegen2.git | 0 | ||||
| m--------- | docs/submodules/policy/engine.git | 0 | ||||
| m--------- | docs/submodules/vfc/lcm.git | 0 | ||||
| m--------- | docs/submodules/vnfrqts/requirements.git | 0 | ||||
| -rw-r--r-- | docs/templates/platform-component/architecture.rst | 7 | ||||
| -rw-r--r-- | docs/templates/platform-component/index.rst | 5 | ||||
| -rw-r--r-- | docs/templates/sdk/architecture.rst | 7 | ||||
| -rw-r--r-- | docs/templates/sdk/build.rst | 5 | ||||
| -rw-r--r-- | docs/templates/sdk/index.rst | 4 | ||||
| -rw-r--r-- | docs/templates/sdk/interfaces.rst | 3 | ||||
| -rw-r--r-- | docs/templates/sdk/libraries.rst | 2 | ||||
| -rw-r--r-- | docs/templates/sdk/logging.rst | 6 | ||||
| -rw-r--r-- | docs/templates/sdk/offeredapis.rst | 8 |
22 files changed, 38 insertions, 30 deletions
diff --git a/.gitmodules b/.gitmodules index bfb80148a..ccf6a23c0 100644 --- a/.gitmodules +++ b/.gitmodules @@ -54,3 +54,8 @@ branch = . ignore = dirty +[submodule "docs/submodules/vfc/lcm.git"] + path = docs/submodules/vfc/lcm.git + url = ../vfc/nfvo/lcm + branch = . + ignore = dirty 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 71feb9607..b1caff88a 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/release/repolist.rst b/docs/release/repolist.rst index a41d69f1e..79887359c 100644 --- a/docs/release/repolist.rst +++ b/docs/release/repolist.rst @@ -24,3 +24,4 @@ Documentation organized by the project delivering them. dcaegen2 <../submodules/dcaegen2.git/docs/index> aaf/authz <../submodules/aaf/authz.git/docs/index> policy/engine <../submodules/policy/engine.git/docs/index> + vfc/nfvo/lcm <../submodules/vfc/lcm.git/docs/index> diff --git a/docs/submodules/aaf/authz.git b/docs/submodules/aaf/authz.git -Subproject 20e269405bc72144421ebccb1b2208ea22d17a5 +Subproject 4e6a217cf763dc49cd5f7f162b4bb52186638f4 diff --git a/docs/submodules/appc.git b/docs/submodules/appc.git -Subproject c406e1cc747c50f398e14b6aec112d83fff8b96 +Subproject 807828291309411ab6bae1fe27bbf300fbe7b09 diff --git a/docs/submodules/appc/deployment.git b/docs/submodules/appc/deployment.git -Subproject 2850546aed3712fc05f4314bc77510f145cb278 +Subproject cc29b311f34c1888a319f67a69847180017ea53 diff --git a/docs/submodules/clamp.git b/docs/submodules/clamp.git -Subproject eaea5ad06aa510cbf36bb95c920932ab6de0e6d +Subproject 2b15edd224cc6dcff90e170959102eb1a1bb1a5 diff --git a/docs/submodules/cli.git b/docs/submodules/cli.git -Subproject c8c451d2e1214e4b44d8693dd13e03987baab4e +Subproject fda4c99bf835bdcb41fec81ab2f7cf87ed6fafd diff --git a/docs/submodules/dcaegen2.git b/docs/submodules/dcaegen2.git -Subproject 73b40eba22e9b0a41e3fc8b420df97f45805b9f +Subproject 8086adcd6290b71b90c654c31fc8d09d521e5ee diff --git a/docs/submodules/policy/engine.git b/docs/submodules/policy/engine.git -Subproject bdbaad66f2a42d4ef9f58a9d7cf3747afb61407 +Subproject e64508463caed53e661e4e02e1de971b21f642a diff --git a/docs/submodules/vfc/lcm.git b/docs/submodules/vfc/lcm.git new file mode 160000 +Subproject a33e556087b77ed8c916e4b9a3a2f60de92dae8 diff --git a/docs/submodules/vnfrqts/requirements.git b/docs/submodules/vnfrqts/requirements.git -Subproject f2a55e8c025ab71d6b7b9aaf6096ce66ab13c04 +Subproject 06d4aae640443fad544635a8d656617eda2728a 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 - +------------ |