From f9872bff827166ce2292e5d270b3fb5290e5b577 Mon Sep 17 00:00:00 2001 From: thmsdt Date: Thu, 17 Nov 2022 15:41:55 +0100 Subject: fix doc config files Issue-ID: DOC-798 Signed-off-by: thmsdt Change-Id: I83fbb41344d74c82fd7e1a510370687d763c6255 (cherry picked from commit 1e0ffba5092d6c595fec90d3a1bea745bd084b3b) --- .gitreview | 1 + docs/conf.py | 46 +++++---- docs/conf.yaml | 7 -- docs/docs_intent_based_network.rst | 105 -------------------- docs/docs_intent_based_network.rst.DISABLED | 107 +++++++++++++++++++++ docs/index.rst | 4 +- docs/platform/index.rst | 20 ++-- .../installation/installation/uui-over-oom.rst | 5 +- docs/requirements-docs.txt | 1 - docs/tox.ini | 30 +++--- 10 files changed, 165 insertions(+), 161 deletions(-) delete mode 100644 docs/conf.yaml delete mode 100644 docs/docs_intent_based_network.rst create mode 100644 docs/docs_intent_based_network.rst.DISABLED diff --git a/.gitreview b/.gitreview index 8e879d06..27b4fc93 100644 --- a/.gitreview +++ b/.gitreview @@ -2,3 +2,4 @@ host=gerrit.onap.org port=29418 project=usecase-ui.git +defaultbranch=kohn diff --git a/docs/conf.py b/docs/conf.py index a6063226..bee123df 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,8 +1,6 @@ -from docs_conf.conf import * - project = "onap" -release = "master" -version = "master" +release = "kohn" +version = "kohn" author = "Open Network Automation Platform" # yamllint disable-line rule:line-length @@ -11,27 +9,13 @@ copyright = "ONAP. Licensed under Creative Commons Attribution 4.0 International pygments_style = "sphinx" html_theme = "sphinx_rtd_theme" html_theme_options = { - "style_nav_header_background": "white", - "sticky_navigation": "False" } + "style_nav_header_background": "white", + "sticky_navigation": "False" } html_logo = "_static/logo_onap_2017.png" html_favicon = "_static/favicon.ico" html_static_path = ["_static"] html_show_sphinx = False -# -# Map to 'latest' if this file is used in 'latest' (master) 'doc' branch. -# Change to {releasename} after you have created the new 'doc' branch. -# - -branch = 'latest' -doc_url = 'https://docs.onap.org/projects' - -master_doc = 'index' - -linkcheck_ignore = [ - r'http://localhost:\d+/' -] - extensions = [ 'sphinx.ext.intersphinx', 'sphinx.ext.graphviz', @@ -41,11 +25,31 @@ extensions = [ 'sphinxcontrib.plantuml' ] +# +# Map to 'latest' if this file is used in 'latest' (master) 'doc' branch. +# Change to {releasename} after you have created the new 'doc' branch. +# + +branch = 'kohn' + intersphinx_mapping = {} +doc_url = 'https://docs.onap.org/projects' +master_doc = 'index' + +exclude_patterns = ['.tox'] + +spelling_word_list_filename='spelling_wordlist.txt' +spelling_lang = "en_GB" + +# +intersphinx_mapping['onap-oom'] = ('{}/onap-oom/en/%s'.format(doc_url) % branch, None) +# html_last_updated_fmt = '%d-%b-%y %H:%M' def setup(app): app.add_css_file("css/ribbon.css") - +linkcheck_ignore = [ + r'http://localhost:\d+/' +] diff --git a/docs/conf.yaml b/docs/conf.yaml deleted file mode 100644 index ab592813..00000000 --- a/docs/conf.yaml +++ /dev/null @@ -1,7 +0,0 @@ ---- -project_cfg: onap -project: onap - -# Change this to ReleaseBranchName to modify the header -default-version: latest -# diff --git a/docs/docs_intent_based_network.rst b/docs/docs_intent_based_network.rst deleted file mode 100644 index a27bb607..00000000 --- a/docs/docs_intent_based_network.rst +++ /dev/null @@ -1,105 +0,0 @@ -.. contents:: - :depth: 3 -.. -.. _docs_intent_based_network: - - -Intent Based Network -============================= - -Overall Blueprint ------------------ -Intent-based network (IBN) is a self-driving network that uses decoupling -network control logic and closed-loop orchestration techniques to automate -application intents. An IBN is an intelligent network, which can automatically -convert, verify, deploy, configure, and optimize itself to achieve target -network state according to the intent of the operators, and can automatically -solve abnormal events to ensure the network reliability. - -REQ-453 Smart Operator Intent Translation in UUI based on IBN - R8 5G Slicing Support -In R8, the smart operator intent translation function is proposed to support -the 5G slicing selection of current E2E usecase in UUI. -The target architecture of the Intent-Based Network is divided into a Intent -orchestration layer (hereinafter referred to as the Intent layer), a control -layer and a network layer. - -REQ-861 Smart Intent Guarantee - Intent Instance -The new network applications, like E2E Slicing and CCVPN, provide different SLA services to customers. In this REQ, a scenario of intent guarantee is proposed to support the SLA requirements of users in run-time, as well as updating users’ intents. In R9, Intent instance will be developed to support the E2E Slicing and CCVPN. - -REQ-1074 Smart Intent Guarantee based on Closed-loop in R10 -In R10, the closed-loop will be developed to support the smart Intent E2E Slicing and CCVPN. - -REQ-1075 Network Services without Perception for Users based on IBN -In R10, Network Services without perception for users based on IBN will be developed to support the E2E Slicing and CCVPN. - -REQ-1214 Maintenance and Enhancement of Intent-driven Closed-loop Autonomous Networks in R11 -Based on the closed-loop automation of ONAP, the proposal of Intent-driven Closed-loop Autonomous Networks is proposed for the smart operation of networks. In R11, the proposal enhances the functions of intent interaction and intent guarantee for CCVPN and E2E Slicing usecases. - -REQ-1267 General intent model and general intent interface requirements in R11 -For complex intent, such as the intent of cloud leased line, it is necessary to decompose the complex intent into sub intents of different dimensions, and implement the user's original intent through the execution of sub intents. So we need to deal with machin-machine intent, and for different intents or sub intents in the system, it is necessary to provide general intent model and general intent interface to ensure that all intents(especially machine-machine intents) operate according to the same expression and process. - - - -Abbreviations -------------- - -+---------------+--------------------------------------------+ -| Abbreviation | Meaning | -+===============+============================================+ -| IBN | Intent Based Network | -+---------------+--------------------------------------------+ - - - -Scope of Honolulu release ------------------------ -The scope for Honolulu developed in UUI includes GUI, UUI-server, and NLP. - -GUI -- Services -- 5G Slicing Management -- Package Management -- NLP Model resource - -Server -- Intent Management Module - -NLP Server -(new Micro-service) -Three NLP algorithms are considered to be applied in current solutions: -- BERT (Bidirectional Encoder Representations from Transformers)：developed by researchers at Google AI Language. It has caused a stir in the Machine Learning community by presenting state-of-the-art results in a wide variety of NLP tasks. BERT’s key technical innovation is applying the bidirectional training of Transformer, a popular attention model, to language modelling. - -Scope of Istanbul release ------------------------ -The scope for Istanbul developed in AAI focuses on Intent Instance Management - -The storage and management of AAI-based Intent Instance are realized in the R9 version. -Intent Instance is created to save the users' real-time intent (network parameters) and connected service ID (CCNVPN service ID / E2E Slicing customer service intent ID) in AAI. - -The user's intent is stored from the UUI or SO to the intent instance in the AAI, and then DCAE calls the intent instance in the AAI through the interface. - -Impacted Modules for Honolulu ---------------------------- - -U-UI -~~~~ -Target of R8: translate from the human inputs to the slice parameters based on NLP -in UUI, and then run the slices based on the current ONAP. - -A new page is required in the UUI that users can enter network requirements through -the natural language, which then sends the user input to the IBN component and displays -the response information to the user. This process can be repeated several times -until the dialog completes and a new Intent is formed in the IBN component. - -Target of R9: support multiple usecase services, so it is not a sub-node of any usecase in AAI. - -The IBN will be expect to provide unawares service to users. Multiple usecases services could be changed by IBN instead of the users, so it should be an independent node in AAI. - - -Functional Test Cases ---------------------- - - - -Operation Guidance ------------------- diff --git a/docs/docs_intent_based_network.rst.DISABLED b/docs/docs_intent_based_network.rst.DISABLED new file mode 100644 index 00000000..1f5cb9b7 --- /dev/null +++ b/docs/docs_intent_based_network.rst.DISABLED @@ -0,0 +1,107 @@ +.. contents:: + :depth: 3 +.. +.. _docs_intent_based_network: + + +Intent Based Network +============================= + +Overall Blueprint +----------------- +Intent-based network (IBN) is a self-driving network that uses decoupling +network control logic and closed-loop orchestration techniques to automate +application intents. An IBN is an intelligent network, which can automatically +convert, verify, deploy, configure, and optimize itself to achieve target +network state according to the intent of the operators, and can automatically +solve abnormal events to ensure the network reliability. + +REQ-453 Smart Operator Intent Translation in UUI based on IBN - R8 5G Slicing Support +In R8, the smart operator intent translation function is proposed to support +the 5G slicing selection of current E2E usecase in UUI. +The target architecture of the Intent-Based Network is divided into a Intent +orchestration layer (hereinafter referred to as the Intent layer), a control +layer and a network layer. + +REQ-861 Smart Intent Guarantee - Intent Instance +The new network applications, like E2E Slicing and CCVPN, provide different SLA services to customers. In this REQ, a scenario of intent guarantee is proposed to support the SLA requirements of users in run-time, as well as updating users’ intents. In R9, Intent instance will be developed to support the E2E Slicing and CCVPN. + +REQ-1074 Smart Intent Guarantee based on Closed-loop in R10 +In R10, the closed-loop will be developed to support the smart Intent E2E Slicing and CCVPN. + +REQ-1075 Network Services without Perception for Users based on IBN +In R10, Network Services without perception for users based on IBN will be developed to support the E2E Slicing and CCVPN. + +REQ-1214 Maintenance and Enhancement of Intent-driven Closed-loop Autonomous Networks in R11 +Based on the closed-loop automation of ONAP, the proposal of Intent-driven Closed-loop Autonomous Networks is proposed for the smart operation of networks. In R11, the proposal enhances the functions of intent interaction and intent guarantee for CCVPN and E2E Slicing usecases. + +REQ-1267 General intent model and general intent interface requirements in R11 +For complex intent, such as the intent of cloud leased line, it is necessary to decompose the complex intent into sub intents of different dimensions, and implement the user's original intent through the execution of sub intents. So we need to deal with machin-machine intent, and for different intents or sub intents in the system, it is necessary to provide general intent model and general intent interface to ensure that all intents(especially machine-machine intents) operate according to the same expression and process. + + + +Abbreviations +------------- + ++---------------+--------------------------------------------+ +| Abbreviation | Meaning | ++===============+============================================+ +| IBN | Intent Based Network | ++---------------+--------------------------------------------+ + + + +Scope of Honolulu release +------------------------- + +The scope for Honolulu developed in UUI includes GUI, UUI-server, and NLP. + +GUI +- Services +- 5G Slicing Management +- Package Management +- NLP Model resource + +Server +- Intent Management Module + +NLP Server +(new Micro-service) +Three NLP algorithms are considered to be applied in current solutions: +- BERT (Bidirectional Encoder Representations from Transformers)：developed by researchers at Google AI Language. It has caused a stir in the Machine Learning community by presenting state-of-the-art results in a wide variety of NLP tasks. BERT’s key technical innovation is applying the bidirectional training of Transformer, a popular attention model, to language modelling. + +Scope of Istanbul release +------------------------- + +The scope for Istanbul developed in AAI focuses on Intent Instance Management + +The storage and management of AAI-based Intent Instance are realized in the R9 version. +Intent Instance is created to save the users' real-time intent (network parameters) and connected service ID (CCNVPN service ID / E2E Slicing customer service intent ID) in AAI. + +The user's intent is stored from the UUI or SO to the intent instance in the AAI, and then DCAE calls the intent instance in the AAI through the interface. + +Impacted Modules for Honolulu +----------------------------- + +U-UI +~~~~ +Target of R8: translate from the human inputs to the slice parameters based on NLP +in UUI, and then run the slices based on the current ONAP. + +A new page is required in the UUI that users can enter network requirements through +the natural language, which then sends the user input to the IBN component and displays +the response information to the user. This process can be repeated several times +until the dialog completes and a new Intent is formed in the IBN component. + +Target of R9: support multiple usecase services, so it is not a sub-node of any usecase in AAI. + +The IBN will be expect to provide unawares service to users. Multiple usecases services could be changed by IBN instead of the users, so it should be an independent node in AAI. + + +Functional Test Cases +--------------------- + + + +Operation Guidance +------------------ diff --git a/docs/index.rst b/docs/index.rst index fc54aa76..9d85cd8a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,8 +1,8 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. _master_index: -Usecase-UI(Use Case User Interface) ---------------------------------- +Usecase-UI (Use Case User Interface) +------------------------------------- This document is aimed to give the users some brief introductions on Usecase-UI from different aspects. The users could find useful information, e.g. the architecture, the APIs and the installation steps, etc. diff --git a/docs/platform/index.rst b/docs/platform/index.rst index 7b3e9723..730b595f 100644 --- a/docs/platform/index.rst +++ b/docs/platform/index.rst @@ -4,7 +4,7 @@ .. _uui_index: ONAP Usecase-UI -========== +=============== |image0| @@ -27,18 +27,18 @@ Usecase UI is composed of two parts that are usecase-ui and usecase-ui-server. * Usecase UI (Frontend) - * providing customer and service type management GUI. - * providing E2E instance lifecycle management GUI. - * providing NS instance lifecycle management GUI. - * providing NS/VNF/PNF package management GUI. - * providing 5G Slicing network management and monitor GUI. - * providing network management GUI for OTN Domain. + * providing customer and service type management GUI. + * providing E2E instance lifecycle management GUI. + * providing NS instance lifecycle management GUI. + * providing NS/VNF/PNF package management GUI. + * providing 5G Slicing network management and monitor GUI. + * providing network management GUI for OTN Domain. * Usecase UI Server (Backend) - * providing postgreSQL for recording instance operation history. - * providing template analysis result via calling modeling parser. - * providing the way to call ONAP other components APIs. + * providing postgreSQL for recording instance operation history. + * providing template analysis result via calling modeling parser. + * providing the way to call ONAP other components APIs. .. toctree:: diff --git a/docs/platform/installation/installation/uui-over-oom.rst b/docs/platform/installation/installation/uui-over-oom.rst index c26b066f..38f4ede5 100644 --- a/docs/platform/installation/installation/uui-over-oom.rst +++ b/docs/platform/installation/installation/uui-over-oom.rst @@ -34,10 +34,9 @@ Usecase-UI Docker Images For initialization of docker there are 2 deployment options currently adpoted in ONAP : using heat template and using OOM. From Casablanca release, OOM is the recommended way, so here mainly give the steps for OOM based deployment. -For OOM deployment you can refer to the below links: +For OOM deployment you can refer to the link below: -https://onap.readthedocs.io/en/latest/submodules/oom.git/docs/oom_setup_kubernetes_rancher.html -https://onap.readthedocs.io/en/latest/submodules/oom.git/docs/oom_quickstart_guide.html#quick-start-label +ONAP Operations Manager: :ref:`oom` 1. First ensure Usecase-UI is marked true against field enabled in the oom/kubernetes/onap/values.yaml for successful deployment. diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index 0cfb2ae2..71df2ab0 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -1,4 +1,3 @@ -lfdocs-conf sphinx>=4.2.0 # BSD sphinx-rtd-theme>=1.0.0 # MIT sphinxcontrib-blockdiag # BSD diff --git a/docs/tox.ini b/docs/tox.ini index 49bbe010..4a8d9a05 100644 --- a/docs/tox.ini +++ b/docs/tox.ini @@ -1,6 +1,6 @@ [tox] minversion = 1.6 -envlist = docs, +envlist = docs,docs-linkcheck,docs-spellcheck skipsdist = true [testenv:docs] @@ -8,18 +8,24 @@ basepython = python3.8 deps = -r{toxinidir}/requirements-docs.txt -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt - -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt + -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=kohn commands = - sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html - echo "Generated docs available in {toxinidir}/_build/html" -whitelist_externals = - echo - git - sh + sphinx-build -W -q -b html -n -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/html [testenv:docs-linkcheck] basepython = python3.8 -#deps = -r{toxinidir}/requirements-docs.txt -commands = echo "Link Checking not enforced" -#commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./ {toxinidir}/_build/linkcheck -whitelist_externals = echo +deps = + -r{toxinidir}/requirements-docs.txt + -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt + -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=kohn +commands = + sphinx-build -W -q -b linkcheck -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/linkcheck + +[testenv:docs-spellcheck] +basepython = python3.8 +deps = + -r{toxinidir}/requirements-docs.txt + -chttps://raw.githubusercontent.com/openstack/requirements/stable/yoga/upper-constraints.txt + -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=kohn +commands = + sphinx-build -W -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck -- cgit 1.2.3-korg