diff options
| -rw-r--r-- | docs/conf.yaml | 2 | ||||
| -rwxr-xr-x[-rw-r--r--] | docs/guides/onap-developer/architecture/media/ONAP-fncview.png | bin | 185554 -> 441038 bytes | |||
| -rw-r--r-- | docs/guides/onap-developer/architecture/onap-architecture.rst | 27 | ||||
| -rw-r--r-- | docs/index.rst | 3 | ||||
| -rw-r--r-- | docs/release/releaserepos.rst | 11 | ||||
| -rw-r--r-- | tox.ini | 6 |
6 files changed, 32 insertions, 17 deletions
diff --git a/docs/conf.yaml b/docs/conf.yaml index 5c06b7f76..ab5928131 100644 --- a/docs/conf.yaml +++ b/docs/conf.yaml @@ -3,5 +3,5 @@ project_cfg: onap project: onap # Change this to ReleaseBranchName to modify the header -default-version: frankfurt +default-version: latest # diff --git a/docs/guides/onap-developer/architecture/media/ONAP-fncview.png b/docs/guides/onap-developer/architecture/media/ONAP-fncview.png Binary files differindex 570629d07..5497edb30 100644..100755 --- a/docs/guides/onap-developer/architecture/media/ONAP-fncview.png +++ b/docs/guides/onap-developer/architecture/media/ONAP-fncview.png diff --git a/docs/guides/onap-developer/architecture/onap-architecture.rst b/docs/guides/onap-developer/architecture/onap-architecture.rst index 0d1d7d613..6ced443f7 100644 --- a/docs/guides/onap-developer/architecture/onap-architecture.rst +++ b/docs/guides/onap-developer/architecture/onap-architecture.rst @@ -114,22 +114,27 @@ microservices-based platform components.** Figure 2 below, provides a simplified functional view of the architecture, which highlights the role of a few key components: -#. Design time environment for onboarding services and resources into ONAP and - designing required services. -#. External API provides northbound interoperability for the ONAP Platform and - Multi-VIM/Cloud provides cloud interoperability for the ONAP workloads. +#. ONAP Design time environment provides onboarding services and resources + into ONAP and designing required services. +#. External API provides northbound interoperability for the ONAP Platform. +#. ONAP Runtime environment provides a model- and policy-driven orchestration + and conrol framework for an automated instantiation and configuration of + services and resources. Multi-VIM/Cloud provides cloud interoperability for + the ONAP workloads. Analytic framework that closely monitors the service + behavior handles close loop management for handling healing, scaling and + update dynamically. #. OOM provides the ability to manage cloud-native installation and deployments to Kubernetes-managed cloud environments. #. ONAP Shared Services provides shared capabilities for ONAP modules. The ONAP Optimization Framework (OOF) provides a declarative, policy-driven approach for creating and running optimization applications like Homing/Placement, - and Change Management Scheduling Optimization. -#. ONAP shared utilities provide utilities for the support of the ONAP - components. -#. Information Model and framework utilities continue to evolve to harmonize - the topology, workflow, and policy models from a number of SDOs including - ETSI NFV MANO, ETSI/3GPP, O-RAN, TM Forum SID, ONF Core, OASIS TOSCA, IETF, - and MEF. + and Change Management Scheduling Optimization. ONAP shared utilities provide + utilities for the support of the ONAP components. + +Information Model and framework utilities continue to evolve to harmonize +the topology, workflow, and policy models from a number of SDOs including +ETSI NFV MANO, ETSI/3GPP, O-RAN, TM Forum SID, ONF Core, OASIS TOSCA, IETF, +and MEF. |image2| diff --git a/docs/index.rst b/docs/index.rst index e1f7e24f8..619af5f73 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -54,6 +54,9 @@ Please find some guidance here on the content of ONAP documentation: | | and PNFs can accelerate the optimal usage of this ONAP environment. The guidelines | | | on VNF/PNF requirements facilitates synchronized and aligned activities for all participants. | +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | :ref:`ONAP Security <onap-security>` | The current state of ONAP Security is described here. We can learn about discovered and fixed | + | | vulnerabilities. | + +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ .. toctree:: diff --git a/docs/release/releaserepos.rst b/docs/release/releaserepos.rst index 960853627..0dd7d6089 100644 --- a/docs/release/releaserepos.rst +++ b/docs/release/releaserepos.rst @@ -22,7 +22,6 @@ Maintained Projects | :ref:`AAI - Active and Available Inventory<onap-aai-aai-common:release_notes>` | :ref:`CCSDK - Common Controller Software Development Kit<onap-ccsdk-distribution:release_notes>` | :ref:`CCSDK/ORAN - Open-RAN Support in ONAP<onap-ccsdk-oran:release_notes>` -| :ref:`CLAMP - Control Loop Automation Platform<onap-policy-clamp:release_notes>` | :ref:`CLI - Command Line Interface<onap-cli:release_notes>` | :ref:`CPS - Configuration Persistence Service<onap-cps:release_notes>` | :ref:`DCAE - Data Collection Analysis and Events<onap-dcaegen2:release_notes>` @@ -48,6 +47,14 @@ Maintained Projects | :ref:`VNFSDK - VNF Software Development Kit<onap-vnfsdk-model:release_notes>` | :ref:`VVP - VNF Validation Project<onap-vvp-documentation:release_notes>` +Migrated Projects +----------------- + +.. toctree:: + :maxdepth: 1 + +| :ref:`CLAMP - Control Loop Automation Platform<onap-policy-clamp:release_notes>` + Unmaintained Projects --------------------- @@ -58,4 +65,4 @@ Unmaintained Projects | :ref:`AAI/ESR - External System Registry<onap-aai-esr-server:master_index>` | :ref:`APPC - Application Controller<onap-appc:release_notes>` | :ref:`MUSIC - ONAP Multi-Site Integration<onap-music:release_notes>` -| :ref:`PORTAL - Portal Platform<onap-portal:release_notes>` +| :ref:`PORTAL - Portal Platform<onap-portal:release_notes>`
\ No newline at end of file @@ -7,7 +7,7 @@ skipsdist = true basepython = python3 deps = -r{toxinidir}/etc/requirements.txt commands = - sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html + sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html echo "Generated docs available in {toxinidir}/docs/_build/html" whitelist_externals = echo @@ -19,7 +19,7 @@ basepython = python3 deps = -r{toxinidir}/etc/requirements.txt commands = git submodule update --depth 100 --init - sphinx-build -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html + sphinx-build -q -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html echo "Generated docs available in {toxinidir}/docs/_build/html" whitelist_externals = echo @@ -28,7 +28,7 @@ whitelist_externals = [testenv:docs-linkcheck] basepython = python3 deps = -r{toxinidir}/etc/requirements.txt -commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck +commands = sphinx-build -q -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck [testenv:spellcheck] basepython = python3 |
