summaryrefslogtreecommitdiffstats
path: root/docs/guides
diff options
context:
space:
mode:
authorSofia Wallin <sofia.wallin@est.tech>2020-12-02 09:55:18 +0000
committerGerrit Code Review <gerrit@onap.org>2020-12-02 09:55:18 +0000
commit14accb22e2c37c4b79a2be0a96b11c4418978f55 (patch)
tree8082fd4434b8ef461684dcee9bebb505fc32d2e7 /docs/guides
parentab61350eb0d62d054b597b8eb45a314d8e9e332d (diff)
parentab0c78bb275b345eb5e995a40a90e633980d7bca (diff)
Merge "Remove all warnings during Documentation buildings"
Diffstat (limited to 'docs/guides')
-rw-r--r--docs/guides/onap-developer/architecture/blueprint-enr.rst100
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/index.rst1
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/templates.rst24
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/templates/collections/platform-component.rst23
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/templates/collections/sdk.rst17
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/templates/sections/administration.rst24
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/templates/sections/architecture.rst27
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/templates/sections/build.rst23
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/templates/sections/configuration.rst27
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/templates/sections/consumedapis.rst16
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/templates/sections/delivery.rst44
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/templates/sections/design.rst13
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/templates/sections/humaninterfaces.rst17
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/templates/sections/installation.rst20
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/templates/sections/logging.rst22
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/templates/sections/offeredapis.rst14
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/templates/sections/release-notes.rst127
-rw-r--r--docs/guides/onap-developer/tutorials/index.rst10
-rw-r--r--docs/guides/onap-user/design/index.rst24
-rw-r--r--docs/guides/onap-user/instantiate/index.rst2
-rw-r--r--docs/guides/onap-user/instantiate/instantiation/index.rst10
-rw-r--r--docs/guides/onap-user/onapportal.rst58
-rw-r--r--docs/guides/overview/overview.rst7
23 files changed, 453 insertions, 197 deletions
diff --git a/docs/guides/onap-developer/architecture/blueprint-enr.rst b/docs/guides/onap-developer/architecture/blueprint-enr.rst
deleted file mode 100644
index a3018a195..000000000
--- a/docs/guides/onap-developer/architecture/blueprint-enr.rst
+++ /dev/null
@@ -1,100 +0,0 @@
-ONAP Blueprint Enrichment
--------------------------
-
-The ONAP Beijing release includes four functional enhancements in the
-areas of manually triggered scaling, change management, and hardware
-platform awareness (HPA). These features required significant community
-collaboration as they impact multiple ONAP projects. These features are
-applicable to any use case; however, to showcase them in a concrete
-manner, they have been incorporated into VoLTE and vCPE blueprints.
-
-Manually Triggered Scaling
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Scale-out and scale-in are two primary benefits of NFV. Scaling can be
-triggered manually (e.g., by a user or OSS/BSS) or automatically via a
-policy-driven closed loop. An automatic trigger allows real-time action
-without human intervention, reducing costs and improving customer
-experience. A manual trigger, on the other hand, is useful to schedule
-capacity in anticipation of events such as holiday shopping. An ideal
-scaling operation can scale granularly at a virtual function level (VF),
-automate VF configuration tasks and manage the load-balancer that may be
-in front of the VF instances. In addition to run-time, this capability
-also affects service design, as VNF descriptors need to be granular up
-to the VF level.
-
-The Beijing release provides the initial support for these capabilities.
-The community has implemented manually triggered scale-out and scale-in
-in combination with a specific VNF manager (sVNFM) and demonstrated this
-with the VoLTE blueprint. An operator uses the Usecase UI (UUI) project
-to trigger a scaleing operation. UUI communicates with the Service
-Orchestrator (SO). SO uses the VF-C controller, which in turn instructs
-a vendor-provided sVNFM to implement the scale-out action.
-
-We have also demonstrated a manual process to Scale Out VNFs that use
-the Virtual Infrastructure Deployment (VID), the Service Orchestrator
-(SO) and the Application Controller (APPC) as a generic VNF Manager.
-Currently, the process is for the operator to trigger the Scale Out
-action using VID, which will request SO to spin up a new component of
-the VNF. Then SO is building the ConfigScaleOut request and sending to
-APPC over DMaaP, where APPC picks it up and executes the configuration
-scale out action on the requested VNF.
-
-Change Management
-~~~~~~~~~~~~~~~~~
-
-NFV will bring with it an era of continuous, incremental changes instead
-of periodic step-function software upgrades, in addition to a constant
-stream of both PNF and VNF updates and configuration changes. To
-automatically deliver these to existing network services, the ONAP
-community is creating framework to implement change management
-functionality that is independent of any particular network service or
-use case. Ideally, change management provides a consistent interface and
-mechanisms to manage complex dependencies, different upgrade mechanisms
-(in-place vs. scale-out and replace), A/B testing, conflict checking,
-pre- and post-change testing, change scheduling, rollbacks, and traffic
-draining, redirection and load-balancing. These capabilities impact both
-design-time and run-time environments.
-
-Over the next several releases, the community will enhance change
-management capabilities in ONAP, culminating with a full CI/CD flow.
-These capabilities can be applied to any use case; however, specifically
-for the Beijing release, the vCPE blueprint has been enriched to execute
-a predefined workflow to upgrade the virtual gateway VNF by using
-Ansible. An operator invokes an upgrade operation through the VID
-interface. VID drives SO, which initiates a sequence of steps such as
-VNF lock, pre-check, software upgrade, post-check and unlock. Since
-virtual gateway is an L3 VNF, the specific operations are carried out by
-the SDN-C controller in terms of running the pre-check, post-check and
-upgrade through Ansible playbooks.
-
-Hardware Platform Awareness (HPA)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Many VNFs have specific hardware requirements to achieve their
-performance and security goals. These hardware requirements may range
-from basic requirements such as number of cores, memory size, and
-ephemeral disk size to advanced requirements such as CPU policy (e.g.
-dedicate, shared), NUMA, hugepages (size and number), accelerated
-vSwitch (e.g DPDK), crypto/compression acceleration, SRIOV-NIC, TPM, SGX
-and so on. The Beijing release provides three HPA-related capabilities:
-
-1. Specification of the VNF hardware platform requirements as a set of
- policies.
-
-2. Discovery of hardware and other platform features supported by cloud
- regions.
-
-3. Selection of the right cloud region and NFV infrastructure flavor by
- matching VNF HPA requirements with the discovered platform
- capabilities.
-
-While this functionality is independent of any particular use case, in
-the Beijing release, the vCPE use case has been enriched with HPA. An
-operator can specify engineering rules for performance sensitive VNFs
-through a set of policies. During run-time, SO relies on the ONAP
-Optimization Framework (OOF) to enforce these policies via a
-placement/scheduling decision. OOF determines the right compute node
-flavors for the VNF by querying the above-defined policies. Once a
-homing decision is conveyed to SO, SO executes the appropriate workflow
-via the appropriate controller.
diff --git a/docs/guides/onap-developer/how-to-use-docs/index.rst b/docs/guides/onap-developer/how-to-use-docs/index.rst
index 799574dbb..2e7e47acf 100644
--- a/docs/guides/onap-developer/how-to-use-docs/index.rst
+++ b/docs/guides/onap-developer/how-to-use-docs/index.rst
@@ -12,6 +12,7 @@ Creating Documentation
setting-up-environment
style-guide
api-swagger-guide
+ templates
converting-to-rst
addendum
diff --git a/docs/guides/onap-developer/how-to-use-docs/templates.rst b/docs/guides/onap-developer/how-to-use-docs/templates.rst
new file mode 100644
index 000000000..73b60666b
--- /dev/null
+++ b/docs/guides/onap-developer/how-to-use-docs/templates.rst
@@ -0,0 +1,24 @@
+.. This work is licensed under a Creative Commons Attribution 4.0
+.. International License. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2020 ONAP community
+
+Templates
+=========
+
+This section provides templates for the projects
+
+Sections
+--------
+
+.. toctree::
+ :maxdepth: 1
+
+ templates/collections/platform-component.rst
+ templates/collections/sdk.rst
+
+Release notes
+-------------
+.. toctree::
+ :maxdepth: 1
+
+ templates/sections/release-notes.rst
diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/collections/platform-component.rst b/docs/guides/onap-developer/how-to-use-docs/templates/collections/platform-component.rst
new file mode 100644
index 000000000..3cde22948
--- /dev/null
+++ b/docs/guides/onap-developer/how-to-use-docs/templates/collections/platform-component.rst
@@ -0,0 +1,23 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+
+Platform Component
+==================
+
+.. Add or remove sections below as appropriate for the platform component.
+
+.. toctree::
+ :maxdepth: 1
+
+ ../sections/architecture.rst
+ ../sections/offeredapis.rst
+ ../sections/consumedapis.rst
+ ../sections/delivery.rst
+ ../sections/design.rst
+ ../sections/logging.rst
+ ../sections/installation.rst
+ ../sections/configuration.rst
+ ../sections/administration.rst
+ ../sections/humaninterfaces.rst
+ ../sections/release-notes.rst
diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/collections/sdk.rst b/docs/guides/onap-developer/how-to-use-docs/templates/collections/sdk.rst
new file mode 100644
index 000000000..83fbbe2ee
--- /dev/null
+++ b/docs/guides/onap-developer/how-to-use-docs/templates/collections/sdk.rst
@@ -0,0 +1,17 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+SDK
+===
+
+.. Add or remove sections below as appropriate for the SDK
+
+.. toctree::
+ :maxdepth: 1
+
+ ../sections/architecture.rst
+ ../sections/offeredapis.rst
+ ../sections/delivery.rst
+ ../sections/logging.rst
+ ../sections/build.rst
+ ../sections/release-notes.rst
diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/sections/administration.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/administration.rst
new file mode 100644
index 000000000..94a740718
--- /dev/null
+++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/administration.rst
@@ -0,0 +1,24 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Administration
+==============
+
+
+.. note::
+ * This section is used to describe a software component from the perspective of on-going
+ operation including regular processes and actions that are taken to configure and manage
+ the component.
+
+ * This section is typically: provided for platform-component or applications; and
+ referenced in user guides
+
+ * This note must be removed after content has been added.
+
+
+Processes
+---------
+
+
+Actions
+-------
diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/sections/architecture.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/architecture.rst
new file mode 100644
index 000000000..8daa0d3bc
--- /dev/null
+++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/architecture.rst
@@ -0,0 +1,27 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Architecture
+============
+
+.. note::
+ * This section is used to describe a software component from a high level
+ view of capability, common usage scenarios, and interactions with other
+ components required in the usage scenarios.
+
+ * The architecture section is typically: provided in a platform-component
+ and sdk collections; and referenced from developer and user guides.
+
+ * This note must be removed after content has been added.
+
+
+Capabilities
+------------
+
+
+Usage Scenarios
+---------------
+
+
+Interactions
+------------
diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/sections/build.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/build.rst
new file mode 100644
index 000000000..99a061c24
--- /dev/null
+++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/build.rst
@@ -0,0 +1,23 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Build
+=====
+
+.. note::
+ * This section is used to describe how a software component is built from source
+ into something ready for use either in a run-time environment or to build other
+ components.
+
+ * This section is typically provided for a platform-component, application, and sdk; and
+ referenced in developer guides.
+
+ * This note must be removed after content has been added.
+
+
+Environment
+-----------
+
+
+Steps
+-----
diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/sections/configuration.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/configuration.rst
new file mode 100644
index 000000000..085f9c667
--- /dev/null
+++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/configuration.rst
@@ -0,0 +1,27 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Configuration
+=============
+
+.. note::
+ * This section is used to describe the options a software component offers for configuration.
+
+ * Configuration is typically: provided for platform-component and sdk projects;
+ and referenced in developer and user guides.
+
+ * This note must be removed after content has been added.
+
+
+
+Example ...
+
+You can provide the following in ``basic.conf``
+
+``host=ADDRESS``
+ The address of the host
+
+``port=PORT``
+ The port used for signaling
+
+ Optional. Default: ``8080``
diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/sections/consumedapis.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/consumedapis.rst
new file mode 100644
index 000000000..c2af4c20e
--- /dev/null
+++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/consumedapis.rst
@@ -0,0 +1,16 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Consumed APIs
+=============
+
+.. note::
+ * This section is used to reference APIs that a software component depends on
+ and uses from other sources.
+
+ * Consumed APIs should be a specific link to the offered APIs from another component
+ or external source.
+
+ * This note must be removed after content has been added.
+
+
diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/sections/delivery.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/delivery.rst
new file mode 100644
index 000000000..f3f083a73
--- /dev/null
+++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/delivery.rst
@@ -0,0 +1,44 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Delivery
+========
+
+.. note::
+ * This section is used to describe a software component packaging.
+ For a run-time component this might be executable images, containers, etc.
+ For an SDK this might be libraries.
+
+ * This section is typically provided for a platform-component and sdk;
+ and referenced in developer and user guides
+
+ * This note must be removed after content has been added.
+
+Example use of a block diagram.
+
+.. blockdiag::
+
+
+ blockdiag layers {
+ orientation = portrait
+ a -> m;
+ b -> n;
+ c -> x;
+ m -> y;
+ m -> z;
+ group l1 {
+ color = blue;
+ x; y; z;
+ }
+ group l2 {
+ color = yellow;
+ m; n;
+ }
+ group l3 {
+ color = orange;
+ a; b; c;
+ }
+
+ }
+
+
diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/sections/design.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/design.rst
new file mode 100644
index 000000000..f173a2fb5
--- /dev/null
+++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/design.rst
@@ -0,0 +1,13 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Design
+======
+
+.. note::
+ * This section is used to describe the internal design structure of a software component.
+
+ * This section is typically provided: for a platform-component and sdk; and
+ referenced in developer guides.
+
+ * This note must be removed after content has been added.
diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/sections/humaninterfaces.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/humaninterfaces.rst
new file mode 100644
index 000000000..429284608
--- /dev/null
+++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/humaninterfaces.rst
@@ -0,0 +1,17 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Human Interfaces
+================
+
+.. note::
+ * This section is used to describe a software component's command line and graphical
+ user interfaces.
+
+ * This section is typically: provided for a platform-component and application; and
+ referenced from user guides.
+
+ * This note must be removed after content has been added.
+
+
+
diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/sections/installation.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/installation.rst
new file mode 100644
index 000000000..be64a63bb
--- /dev/null
+++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/installation.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
+
+Installation
+============
+
+.. note::
+ * This section is used to describe how a software component is acquired and installed.
+
+ * This section is typically: provided for a platform-component and application; and
+ referenced in user guides.
+
+ * This note must be removed after content has been added.
+
+Environment
+-----------
+
+
+Steps
+-----
diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/sections/logging.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/logging.rst
new file mode 100644
index 000000000..39eabfba7
--- /dev/null
+++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/logging.rst
@@ -0,0 +1,22 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Logging
+=======
+
+.. note::
+ * This section is used to describe the informational or diagnostic messages emitted from
+ a software component and the methods or collecting them.
+
+ * This section is typically: provided for a platform-component and sdk; and
+ referenced in developer and user guides
+
+ * This note must be removed after content has been added.
+
+
+Where to Access Information
+---------------------------
+
+
+Error / Warning Messages
+------------------------
diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/sections/offeredapis.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/offeredapis.rst
new file mode 100644
index 000000000..23504c1da
--- /dev/null
+++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/offeredapis.rst
@@ -0,0 +1,14 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Offered APIs
+============
+
+.. note::
+ * This section is used to describe the external interfaces offered by a software component
+
+ * This section is typically: provided for a platform-component and sdk; and
+ referenced in developer guides and api reference manuals.
+
+ * This note must be removed after content has been added.
+
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
diff --git a/docs/guides/onap-developer/tutorials/index.rst b/docs/guides/onap-developer/tutorials/index.rst
deleted file mode 100644
index a181644bc..000000000
--- a/docs/guides/onap-developer/tutorials/index.rst
+++ /dev/null
@@ -1,10 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0
-.. International License.
-
-Tutorials
-=========
-
-.. note::
- This is an empty document as placeholder for future tutorials.
-
-
diff --git a/docs/guides/onap-user/design/index.rst b/docs/guides/onap-user/design/index.rst
index aa38a79c8..2a629999e 100644
--- a/docs/guides/onap-user/design/index.rst
+++ b/docs/guides/onap-user/design/index.rst
@@ -91,35 +91,27 @@ Onboarding, Design and Distribution process.
not yet integrated with the SDC Design Catalog to exchange models and
artefacts.
-The follwing sections will focus on the different Design steps:
+The following sections focus on the different Design steps:
.. toctree::
:maxdepth: 1
:titlesonly:
Pre-Onboarding <./pre-onboarding/index.rst>
-
Resource-Onboarding <./resource-onboarding/index.rst>
-
VF Creation and Testing <./vfcreation/index.rst>
-
Service Design <./service-design/index.rst>
-
Service Distribution <./service-distribution/index.rst>
-
VNF parameter resolution Design <./parameter_resolution/index.rst>
+ Control Loop Design <./control-loop/index.rst>
-:ref:`Policy Design<onap-policy-parent:design-label>`
-
-:ref:`VNF LifeCycle Command templating<onap-appc:master_index>`
-
-:ref:`Workflow Design<onap-sdc:workflow>`
-
-:ref:`DCAE Onboard/Design<onap-dcaegen2:master_index>`
-
-:ref:`Control Loop Automation Management<onap-clamp:master_index>`
-
+The following section provide links to the projects:
+- :ref:`Policy Design<onap-policy-parent:design-label>`
+- :ref:`VNF LifeCycle Command templating<onap-appc:master_index>`
+- :ref:`Workflow Design<onap-sdc:workflow>`
+- :ref:`DCAE Onboard/Design<onap-dcaegen2:master_index>`
+- :ref:`Control Loop Automation Management<onap-clamp:master_index>`
.. |image1| image:: media/Design-Overview.png
diff --git a/docs/guides/onap-user/instantiate/index.rst b/docs/guides/onap-user/instantiate/index.rst
index fb14e698e..d9bc3c7fb 100644
--- a/docs/guides/onap-user/instantiate/index.rst
+++ b/docs/guides/onap-user/instantiate/index.rst
@@ -16,3 +16,5 @@ Instantiation includes the following topics:
Pre-instantiation operations <./pre_instantiation/index.rst>
Instantiation operation(s) <./instantiation/index.rst>
+
+ Instantiation via Use-Case UI portal <./instantiation/uui/index.rst>
diff --git a/docs/guides/onap-user/instantiate/instantiation/index.rst b/docs/guides/onap-user/instantiate/instantiation/index.rst
index 0d2981b4d..9bfb6b6b3 100644
--- a/docs/guides/onap-user/instantiate/instantiation/index.rst
+++ b/docs/guides/onap-user/instantiate/instantiation/index.rst
@@ -2,7 +2,6 @@
.. International License. http://creativecommons.org/licenses/by/4.0
.. Copyright 2019 ONAP Contributors. All rights reserved.
-
Declare PNF instances:
.. toctree::
@@ -17,7 +16,6 @@ Instantiate a Service
Instantiate a Service <./service_instance/index.rst>
-
Instantiate a VNF:
.. toctree::
@@ -25,14 +23,6 @@ Instantiate a VNF:
Instantiate a VNF <./vnf_instance/index.rst>
-Configure a VNF:
-
-.. toctree::
- :maxdepth: 1
-
- Configure a VNF <./vnf_configure/index.rst>
-
-
Instantiate a Virtual Link:
.. toctree::
diff --git a/docs/guides/onap-user/onapportal.rst b/docs/guides/onap-user/onapportal.rst
deleted file mode 100644
index 205798ec3..000000000
--- a/docs/guides/onap-user/onapportal.rst
+++ /dev/null
@@ -1,58 +0,0 @@
-.. 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.
-
-
-ONAP Portal
-===========
-The ONAP Portal integrates different ONAP applications in one place.
-The Portal platform provides common management services and
-connectivity, while the applications run separately.
-
-From the Portal, users access applications. Administrators
-onboard and manage applications and widgets, and manage user access.
-
-The Portal SDK for application developers includes bundled tools,
-technologies, and built-in capabilities such as services, APIs,
-and UI controls. Existing applications can migrate to the Portal
-with the provided APIs and libraries.
-See Portal SDK_.
-
-:ref:`docs tutorials portal-sdk <onap-portal:master_index>`
-
-Access the ONAP Portal
-----------------------
-
-Access the ONAP Portal using a browser such as Mozilla Firefox or
-Google Chrome. The URL is dependent on a specific ONAP platform
-deployment.
-
-From the Portal, users access applications directly or by
-function using the Manage menu.
-
-.. figure:: onap-portal-home.png
- :width: 900 px
- :height: 600 px
-
-
-Roles in the ONAP Portal
-------------------------
-The Portal displays different menus for the following roles:
-
-* User
-
-* Portal Administrator
-
-* Application Administrator
-
-* Governor
-
-* Operator
-
-Each application also defines a distinct set of user roles.
-See Users.
-
-See also
---------
-
-* `Applications in the Portal <https://wiki.onap.org/x/h4sP>`_
diff --git a/docs/guides/overview/overview.rst b/docs/guides/overview/overview.rst
index 12f536953..2567ec4be 100644
--- a/docs/guides/overview/overview.rst
+++ b/docs/guides/overview/overview.rst
@@ -127,8 +127,7 @@ These service design activities are built up of the following subtasks:
the example of onboarding and instantiating a virtual network function
(VNF), the virtual Firewall (vFirewall). Following the guidelines and
steps of this example, any other VNF can be similarly onboarded
- and instantiated to ONAP. See :ref:`virtual Firewall Onboarding and
- Instantiating <vfirewall_usecase>` examples.
+ and instantiated to ONAP.
e. Controllers applying configuration on VNFs
@@ -164,7 +163,9 @@ is named after a city.
+----------------------+----------------+----------------------+-----------------------------------------------------------+
|Release Name |Release version |Release Date |Features delivered |
+======================+================+======================+===========================================================+
-|Frankfurt |6.0.0 | 11 June 2020 | :ref:`Frankfurt Release Notes<release-notes>` |
+|Guilin |7.0.0 | 3 Deember 2020 | |
++----------------------+----------------+----------------------+-----------------------------------------------------------+
+|Frankfurt |6.0.0 | 11 June 2020 | |
+----------------------+----------------+----------------------+-----------------------------------------------------------+
|El Alto |5.0.1 | 24 October 2019 | |
+----------------------+----------------+----------------------+-----------------------------------------------------------+