From c646304b473b052e99e89667f2a2fd269e6c6d53 Mon Sep 17 00:00:00 2001 From: Eric Debeau Date: Tue, 9 Jun 2020 11:36:48 +0200 Subject: Finalize documentation with some editorial corrections Remove Dublin reference Add _release_notes anchor Correct DOC8 errors Harmonize modeling spelling Issue-ID: MODELING-363 Signed-off-by: Eric Debeau Change-Id: I47841c3173e5c70a9a36630e605d397785a00585 (cherry picked from commit 0a5bfa74e8a11de158e00c2523e604f45b7b4b94) --- docs/Release-notes/release-notes.rst | 51 +++++++++++++++++++----------------- docs/index.rst | 16 +++++++---- 2 files changed, 38 insertions(+), 29 deletions(-) (limited to 'docs') diff --git a/docs/Release-notes/release-notes.rst b/docs/Release-notes/release-notes.rst index 95a18e9..17c1eec 100644 --- a/docs/Release-notes/release-notes.rst +++ b/docs/Release-notes/release-notes.rst @@ -1,7 +1,8 @@ .. Copyright 2019 (China Mobile) -.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE +.. This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 +.. INTERNATIONAL LICENSE .. Full license text at https://creativecommons.org/licenses/by/4.0/legalcode - +.. _release_notes: Modeling Spec Release Notes =========================== @@ -25,13 +26,13 @@ Enhance service information model for nested and shared service. **Security Notes** -MODELLING code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found. +Modeling code has been formally scanned during build time using NexusIQ and no +Critical vulnerability was found. Quick Links: - - `MODELLING project page `_ - - - `Passing Badge information for MODELLING `_ - +- `Modeling project page `_ +- `Passing Badge information for Modeling `_ + **Known Issues** None @@ -56,13 +57,13 @@ Introduce business and interaction model. **Security Notes** -MODELLING code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found. +Modeling code has been formally scanned during build time using NexusIQ and no +Critical vulnerability was found. Quick Links: - - `MODELLING project page `_ - - - `Passing Badge information for MODELLING `_ - +- `Modeling project page `_ +- `Passing Badge information for Modeling `_ + **Known Issues** None @@ -86,19 +87,20 @@ Introduce generic parser. **Security Notes** -MODELLING code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found. +Modeling code has been formally scanned during build time using NexusIQ and no +Critical vulnerability was found. Quick Links: - - `MODELLING project page `_ - - - `Passing Badge information for MODELLING `_ - +- `Modeling project page `_ +- `Passing Badge information for Modeling `_ + **Known Issues** None **Upgrade Notes** - Update VNFD information and data model to align with ETSI NFV IFA011/SOL001 v2.5.1 specifications. + Update VNFD information and data model to align with ETSI NFV IFA011/SOL001 + v2.5.1 specifications. **Other** None @@ -110,19 +112,20 @@ Version: 3.1.1 **New Features** -Define design time VNFD model information model and onboarding data model specifications based on ETSI NFV specifications IFA011 and SOL001. +Define design time VNFD model information model and onboarding data model +specifications based on ETSI NFV specifications IFA011 and SOL001. **Bug Fixes** **Security Notes** -MODELLING code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found. +Modeling code has been formally scanned during build time using NexusIQ and no +Critical vulnerability was found. Quick Links: - - `MODELLING project page `_ - - - `Passing Badge information for MODELLING `_ - +- `Modeling project page `_ +- `Passing Badge information for Modeling `_ + **Known Issues** None diff --git a/docs/index.rst b/docs/index.rst index a821e4f..0828f11 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,21 +1,27 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. This work is licensed under a Creative Commons Attribution 4.0 +.. International License. .. _master_index: Model Specifications ==================== -ONAP is expected to be a general model driven platform to support design, deployment and management of various services, across traditional access, transport and core network domains. ONAP has leveraged the experience of community members, standard organizations and other open source projects to produce models which enable the model driven approach and improve the interprobility of ONAP. +ONAP is expected to be a general model driven platform to support design, +deployment and management of various services, across traditional access, +transport and core network domains. ONAP has leveraged the experience of +community members, standard organizations and other open source projects to +produce models which enable the model driven approach and improve the +interoperability of ONAP. -The models documented in the Dublin Release are listed below: +The models documented in the current release are listed below: .. toctree:: :maxdepth: 2 - ONAP Model Spec/index + ONAP Model Spec/index The changes can be found in the Release Notes: .. toctree:: :maxdepth: 1 - + Release-notes/release-notes -- cgit 1.2.3-korg