diff options
| author |   Rich Bennett <rb2745@att.com> | 2017-10-26 17:41:13 -0400 |
|---|---|---|
| committer | Rich Bennett <rb2745@att.com> | 2017-10-26 17:45:30 -0400 |
| commit | 58492459a10c9b3604aff619aec86431b8affcb5 (patch) | |
| tree | da65cff4dd1212b35c28d2f2628ddd6bffe5cc2b /docs | |
| parent | 810ab2d67c10b820309d7c913083c17c029e59d1 (diff) | |
Fix index and add templates
Added index title
Added architecture and release note templates
Change-Id: I194761c176c982a3fe4b2ec877055ebd3b8e60a1
Issue-ID: DOC-130
Signed-off-by: Rich Bennett <rb2745@att.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/architecture.rst | 20 | ||||
| -rw-r--r-- | docs/index.rst | 7 | ||||
| -rw-r--r-- | docs/release-notes.rst | 48 |
3 files changed, 75 insertions, 0 deletions
diff --git a/docs/architecture.rst b/docs/architecture.rst new file mode 100644 index 0000000..6f677d1 --- /dev/null +++ b/docs/architecture.rst @@ -0,0 +1,20 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + + +CCSDK Plugin Architecture +========================= +CCSDK Plugins extend the capabilities of the orchestrator to integrate with other components + + +Capabilities +------------ + + +Usage Scenarios +--------------- + + +Interactions +------------ diff --git a/docs/index.rst b/docs/index.rst index 3597838..5fb384b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,8 +1,15 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 AT&T Intellectual Property. All rights reserved. + +CCSDK Platform Plugins +====================== + .. toctree:: :maxdepth: 1 + architecture.rst dmaap.rst dnsdesig.rst pgaas.rst diff --git a/docs/release-notes.rst b/docs/release-notes.rst new file mode 100644 index 0000000..b568bee --- /dev/null +++ b/docs/release-notes.rst @@ -0,0 +1,48 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +Release Notes +============= + +.. note:: + * This Release Notes must be updated each time the team decides to Release new artifacts. + * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes. + * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes. + * Except the date and the version number, all the other sections are optional but there must be at least one section describing the purpose of this new release. + * This note must be removed after content has been added. + + +Version: x.y.z +-------------- + + +:Release Date: yyyy-mm-dd + + + +**New Features** + +One or two sentences explaining the purpose of this Release. + +**Bug Fixes** + - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and a sentence explaining what this defect is addressing. +**Known Issues** + - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and two, three sentences. + One sentences explaining what is the issue. + + Another sentence explaining the impact of the issue. + + And an optional sentence providing a workaround. + +**Security Issues** + You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE <https://cve.mitre.org>`_ + + +**Upgrade Notes** + +**Deprecation Notes** + +**Other** + +=========== + +End of Release Notes |