diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 46 | ||||
| -rw-r--r-- | docs/conf.yaml | 7 | ||||
| -rw-r--r-- | docs/docs_intent_based_network.rst.DISABLED (renamed from docs/docs_intent_based_network.rst) | 24 | ||||
| -rw-r--r-- | docs/index.rst | 4 | ||||
| -rw-r--r-- | docs/platform/index.rst | 20 | ||||
| -rw-r--r-- | docs/platform/installation/installation/uui-over-oom.rst | 5 | ||||
| -rw-r--r-- | docs/requirements-docs.txt | 1 | ||||
| -rw-r--r-- | docs/tox.ini | 30 |
8 files changed, 70 insertions, 67 deletions
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.DISABLED index a27bb607..1f5cb9b7 100644 --- a/docs/docs_intent_based_network.rst +++ b/docs/docs_intent_based_network.rst.DISABLED @@ -52,7 +52,8 @@ Abbreviations Scope of Honolulu release
------------------------
+-------------------------
+
The scope for Honolulu developed in UUI includes GUI, UUI-server, and NLP.
GUI
@@ -70,16 +71,17 @@ 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 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
~~~~
@@ -91,9 +93,9 @@ the natural language, which then sends the user input to the IBN component and d 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. +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
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<onap-oom:master_index>` 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 |