diff options
| author |   thmsdt <thomas.kulik@telekom.de> | 2022-04-11 15:34:07 +0200 |
|---|---|---|
| committer | thmsdt <thomas.kulik@telekom.de> | 2022-04-12 08:24:11 +0200 |
| commit | eb446d21767e9af6887613ec13345ab44bf61128 (patch) | |
| tree | b05498eda027a903c2548db7a4238d19044aa802 /docs/release-notes.rst | |
| parent | c1d958ce2fd36dd8b452b9d5a1d1ff9bbfc1476b (diff) | |
update doc release notes
Issue-ID: DOC-782
Signed-off-by: thmsdt <thomas.kulik@telekom.de>
Change-Id: I3ddc44770346c9c735c87bf4227899b204455893
Diffstat (limited to 'docs/release-notes.rst')
| -rw-r--r-- | docs/release-notes.rst | 38 |
1 files changed, 16 insertions, 22 deletions
diff --git a/docs/release-notes.rst b/docs/release-notes.rst index fdeae8ff4..95d2eed1a 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -16,19 +16,19 @@ Istanbul Releases ================= The following releases are available for Istanbul: - - `Istanbul Major Release 9.0.0`_ + - `Jakarta Major Release 10.0.0`_ -Istanbul Major Release 9.0.0 +Jakarta Major Release 10.0.0 ============================ +--------------------------------------+--------------------------------------+ | **Project** | Documentation Project | | | | +--------------------------------------+--------------------------------------+ -| **Release name** | Istanbul | +| **Release name** | Jakarta | | | | +--------------------------------------+--------------------------------------+ -| **Release version** | 9.0.0 | +| **Release version** | 10.0.0 | | | | +--------------------------------------+--------------------------------------+ @@ -36,25 +36,19 @@ Istanbul Major Release 9.0.0 New features ------------ -- 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. - - -- 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. +- Documentation cleaned up. Chapters which include unmaintained projects were + removed to avoid misunderstandings at the readership. +- Projects (repositories) which do not create a stable release branch are no + longer included in the release documentation. This should help to improve the + release management process. +- Beginning with this release we are providing example configuration files for + setting up a proper process of documentation creation. Please check the 'doc' + repository. +- The Interactive Architecture Overview was updated. Learn about the ONAP + architecture in an intuitive way. +- The guide to set up a development system for documentation was updated. All JIRA tickets for the Istanbul release can be found `ONAP Documentation Jira`_ -.. _`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 +.. _`ONAP Documentation Jira`: https://jira.onap.org/issues/?jql=project%20%3D%20DOC%20AND%20fixVersion%20%3D%20%22Jakarta%20Release%22%20%20ORDER%20BY%20priority%20DESC%2C%20updated%20DESC |