Committer Promotion for doc : Cédric Ollivier
[doc.git] / docs / release-notes.rst
index 716baa9..fdeae8f 100644 (file)
@@ -1,36 +1,60 @@
-
 .. 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.
+   Copyright 2018-2021 by ONAP and contributors.
+
+.. _doc_release_notes:
 
-.. _doc-release-notes:
+:orphan:
 
 Release Notes
 =============
 
+This document provides the release notes for the documentation project.
 
-Version: x.y.z
---------------
-
+Istanbul Releases
+=================
 
-:Release Date: yyyy-mm-dd
+The following releases are available for Istanbul:
+  - `Istanbul Major Release 9.0.0`_
 
+Istanbul Major Release 9.0.0
+============================
 
++--------------------------------------+--------------------------------------+
+| **Project**                          | Documentation Project                |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release name**                     | Istanbul                             |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
+| **Release version**                  | 9.0.0                                |
+|                                      |                                      |
++--------------------------------------+--------------------------------------+
 
-**New Features**
 
-Release controlled documentation moved to / now managed in gerrit and published
-on readthedocs.
+New features
+------------
 
-**Bug Fixes**
-         
+- Interactive architecture map incl. short description and link to detailed
+  documentation for every architecture building block. The interactive
+  architecture map can act as a starting point to easily gain knowledge about
+  ONAP components.
+- Changes in the sphinx configuration for all contributing projects. The
+  updated sphinx configuration can avoid problems in the documentation build
+  process caused by changes in required libraries.
+- Guide to set up a documentation development environment with preview function
+  . The guide eases the process of documentation creation and validation by
+  providing step-by-step instructions on a beginner level.
 
-**Other**
 
-The developer wiki still contains pages that are release dependent, should be
-under change control in gerrit, and are being referenced from some gerrit change controlled documentation.  The pages and links that remain to be migrated
-are listed in <JIRA ISSUE> and by TBD tag or other indicator on the wiki.
+- Refined and improved parts of the documentation guide.
+- Continue with improving the user and admin documentation.
+- In addition the documentation project is continuously improving processes and
+  tools for documentation. We are enabling the community to document all
+  aspects of the ONAP platform.
 
-===========
+All JIRA tickets for the Istanbul release can be found
+`ONAP Documentation Jira`_
 
-End of Release Notes
+.. _`ONAP Documentation Jira`: https://jira.onap.org/issues/?jql=project%20%3D%20DOC%20AND%20fixVersion%20%3D%20%22Istanbul%20Release%22%20%20ORDER%20BY%20priority%20DESC%2C%20updated%20DESC