From ab0c78bb275b345eb5e995a40a90e633980d7bca Mon Sep 17 00:00:00 2001
From: Eric Debeau <eric.debeau@orange.com>
Date: Mon, 30 Nov 2020 15:32:31 +0100
Subject: Remove all warnings during Documentation buildings

Remove files with not links:
- guides/onap-developer/architecture/blueprint-enr.rst old file based on Beijing
- smsummary.rst: no more relevant as no more submodules used
- templates/sections/vnf-reference.rst : not referenced
- guides/onap-user/onapportal.rst: redundant
- guides/onap-developer/tutorials/index.rst: no tutorial

Add new files to inlude templates
Move templates directory under how-to-use-docs

Modify global release not label with onap_release_notes to avoid confusion

Issue-ID: DOC-692

Signed-off-by: Eric Debeau <eric.debeau@orange.com>
Change-Id: I709765beb02403c4ad058863c2b5136f42968cff
---
 .../templates/sections/release-notes.rst           | 127 +++++++++++++++++++++
 1 file changed, 127 insertions(+)
 create mode 100644 docs/guides/onap-developer/how-to-use-docs/templates/sections/release-notes.rst

(limited to 'docs/guides/onap-developer/how-to-use-docs/templates/sections/release-notes.rst')

diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/sections/release-notes.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/release-notes.rst
new file mode 100644
index 000000000..11f38fed9
--- /dev/null
+++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/release-notes.rst
@@ -0,0 +1,127 @@
+.. This work is licensed under a Creative Commons Attribution 4.0
+   International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) ONAP Project and its contributors
+.. _release_notes:
+
+***********************
+<project> Release Notes
+***********************
+
+.. note::
+   * The release note needs to be updated for each ONAP release
+   * Except the section "Release data" all other sections are optional and should be
+     applied where applicable
+   * Only the current release is to be documented in this document
+   * This note needs to be removed before publishing the final result
+
+Abstract
+========
+
+This document provides the release notes for the ``<releasename>`` release.
+
+Summary
+=======
+
+<Give a high level description of your project with regards to this
+specific release>
+
+
+Release Data
+============
+
++--------------------------------------+--------------------------------------+
+| **Project**                          | <project name>                       |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Docker images**                    |  make sure you include all docker    |
+|                                      |  images including the                |
+|                                      |  release version                     |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release designation**              | <release name followed by version>   |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+
+
+New features
+------------
+
+<Describe new features or other new additions>
+
+**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 to three sentences
+  explaining what this issue is.
+
+Deliverables
+------------
+
+Software Deliverables
+~~~~~~~~~~~~~~~~~~~~~
+
+
+Documentation Deliverables
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+
+Known Limitations, Issues and Workarounds
+=========================================
+
+System Limitations
+------------------
+
+Any known system limitations.
+
+
+Known Vulnerabilities
+---------------------
+
+Results of know vulnerabilities analysis in used modules.
+
+
+Workarounds
+-----------
+
+Any known workarounds.
+
+
+Security Notes
+--------------
+
+**Fixed Security Issues**
+
+List of security issues fixed in this release including CVEs and OJSI
+tickets.
+
+**Known Security Issues**
+
+List of new security issues that are left unfixed in this release including
+CVEs and OJSI tickets.
+
+
+Test Results
+============
+List or refer to any project specific results
+
+
+References
+==========
+
+For more information on the ONAP ``<release name>`` release, please see:
+
+#. `ONAP Home Page`_
+#. `ONAP Documentation`_
+#. `ONAP Release Downloads`_
+#. `ONAP Wiki Page`_
+
+
+.. _`ONAP Home Page`: https://www.onap.org
+.. _`ONAP Wiki Page`: https://wiki.onap.org
+.. _`ONAP Documentation`: https://docs.onap.org
+.. _`ONAP Release Downloads`: https://git.onap.org
-- 
cgit 1.2.3-korg