diff options
| -rw-r--r-- | .gitreview | 2 | ||||
| -rw-r--r-- | docs/OCLIP.rst | 2 | ||||
| -rw-r--r-- | docs/OOM_and_HEAT_based_deployment.rst | 3 | ||||
| -rw-r--r-- | docs/architecture.rst | 5 | ||||
| -rw-r--r-- | docs/cmd_help_onap_amsterdam.rst | 1 | ||||
| -rw-r--r-- | docs/cmd_help_onap_beijing.rst | 6 | ||||
| -rw-r--r-- | docs/cmd_sample_onap_amsterdam.rst | 2 | ||||
| -rw-r--r-- | docs/conf.py | 13 | ||||
| -rw-r--r-- | docs/console.rst | 2 | ||||
| -rw-r--r-- | docs/open_cli_schema_version_1_0.rst | 5 | ||||
| -rw-r--r-- | docs/release-notes.rst | 12 | ||||
| -rw-r--r-- | docs/tox.ini | 10 |
12 files changed, 35 insertions, 28 deletions
@@ -2,4 +2,4 @@ host=gerrit.onap.org port=29418 project=cli.git -defaultbranch=master
\ No newline at end of file +defaultbranch=london
\ No newline at end of file diff --git a/docs/OCLIP.rst b/docs/OCLIP.rst index de7d623f..13375b88 100644 --- a/docs/OCLIP.rst +++ b/docs/OCLIP.rst @@ -2,6 +2,8 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2017 Huawei Technologies Co., Ltd. +:orphan: + .. _OCLIP: Open CLI Platform (OCLIP) diff --git a/docs/OOM_and_HEAT_based_deployment.rst b/docs/OOM_and_HEAT_based_deployment.rst index d7efdf16..fd20a173 100644 --- a/docs/OOM_and_HEAT_based_deployment.rst +++ b/docs/OOM_and_HEAT_based_deployment.rst @@ -10,7 +10,7 @@ CLI deployment using OOM and HEAT ONAP CLI deployment is enabled with OOM and HEAT based ONAP installation. OpenStack HEAT based deployment ------------------------------- +------------------------------- As part of HEAT based deployment, ONAL CLI docker image is integrated into ONAP Portal and when portal_vm is successfully installed, it will be available at http://portal.api.simpledemo.openecomp.org:8080 @@ -24,4 +24,3 @@ ONAL CLI docker image is integrated with OOM and is available under name 'cli' Once successfully installed, CLI is available under onap-cli name-space. So user can access the CLI at http://<k8s-host>:30260 - diff --git a/docs/architecture.rst b/docs/architecture.rst index 95953b7b..95da1928 100644 --- a/docs/architecture.rst +++ b/docs/architecture.rst @@ -13,10 +13,10 @@ Following diagram shows the high-level architecture of OCLIP. .. image:: images/portal-cli-arch.png * **Command Registrar** : Registrar keeps track of the commands registered in OCLIP and when user invokes the command, -it identifies the corresponding command and helps to invoke the corresponding command plug-in. + it identifies the corresponding command and helps to invoke the corresponding command plug-in. * **Command Discoverer** : Discoverer discovers the commands both in plug-in format and YAML and automatically register -them into Registrar. + them into Registrar. * **Command Plug-in** : Implement the command as plug-in. More details :ref:`cli_developer_guide` @@ -31,3 +31,4 @@ them into Registrar. * **Cache** : Provides persistent storage for discoverer to store the meta-data about the discovered Commands. * **open cli schemas** : Set of command YAML provides the CLI definitions. + diff --git a/docs/cmd_help_onap_amsterdam.rst b/docs/cmd_help_onap_amsterdam.rst index c18412d7..39817352 100644 --- a/docs/cmd_help_onap_amsterdam.rst +++ b/docs/cmd_help_onap_amsterdam.rst @@ -2,6 +2,7 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2018 Huawei Technologies Co., Ltd. +:orphan: .. toctree:: :maxdepth: 2 diff --git a/docs/cmd_help_onap_beijing.rst b/docs/cmd_help_onap_beijing.rst index bd572cdb..1bf74a40 100644 --- a/docs/cmd_help_onap_beijing.rst +++ b/docs/cmd_help_onap_beijing.rst @@ -2,6 +2,7 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2018 Huawei Technologies Co., Ltd. +:orphan: .. toctree:: :maxdepth: 2 @@ -1241,9 +1242,8 @@ Error:: - license-group-show ------------------------------------------------ - +license-group-show +------------------ usage: oclip license-group-show diff --git a/docs/cmd_sample_onap_amsterdam.rst b/docs/cmd_sample_onap_amsterdam.rst index a77615e4..2e2d47da 100644 --- a/docs/cmd_sample_onap_amsterdam.rst +++ b/docs/cmd_sample_onap_amsterdam.rst @@ -2,7 +2,7 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2018 Huawei Technologies Co., Ltd. -.. _cli_cmd_sample: +.. _cli_cmd_sample_amsterdam: onap-amsterdam diff --git a/docs/conf.py b/docs/conf.py index 70937d74..32e90457 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,11 +1,16 @@ project = "onap" -release = "master" -version = "master" +release = "london" +version = "london" +branch = 'london' author = "Open Network Automation Platform" # yamllint disable-line rule:line-length copyright = "ONAP. Licensed under Creative Commons Attribution 4.0 International License" +exclude_patterns = [ + '.tox' +] + pygments_style = "sphinx" html_theme = "sphinx_rtd_theme" html_theme_options = { @@ -30,14 +35,10 @@ extensions = [ # Change to {releasename} after you have created the new 'doc' branch. # -branch = 'latest' - 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" diff --git a/docs/console.rst b/docs/console.rst index acde93e8..2bfd5080 100644 --- a/docs/console.rst +++ b/docs/console.rst @@ -14,7 +14,7 @@ After installation, CLI can be used in following form: Linux Command Shell ------------------- It is available when user has access to the server where CLI is installed using zip or docker container. -In this mode, user can use CLI in scripting mode or interactive mode as mentioned in :ref:`user_guide` +In this mode, user can use CLI in scripting mode or interactive mode as mentioned in :ref:`cli_user_guide` .. image:: images/portal-cli-shell.png diff --git a/docs/open_cli_schema_version_1_0.rst b/docs/open_cli_schema_version_1_0.rst index 634052ef..9d85450f 100644 --- a/docs/open_cli_schema_version_1_0.rst +++ b/docs/open_cli_schema_version_1_0.rst @@ -2,6 +2,8 @@ .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2017 Huawei Technologies Co., Ltd. +:orphan: + .. _open_cli_schema_version_1_0: Open Command Line Interface (CLI) Schema Version (OCS) 1.0 @@ -89,7 +91,7 @@ the following format: parameters ---------- +---------- Every command has set of arguments to provide the input values and *parameters* section allows to add the required arguments details such as name, description, etc as list of entries. @@ -702,6 +704,7 @@ value. So the none auth is defined by: section default_parameters -------------------- + request ~~~~~~~ *request* section captures all HTTP request information as: diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 19c04786..1a29db94 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -40,7 +40,7 @@ Version: 6.0.0 1. Enabled auto discover and registration of products functionalities as commands -2. Profile managment commands are added +2. Profile management commands are added *Security Notes* @@ -147,14 +147,14 @@ Version: 2.0.5 CLI code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The CLI open Critical security vulnerabilities and their risk assessment have been -documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=45298770>`_. +documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=45298770>`__. Quick Links: - `CLI project page <https://wiki.onap.org/display/DW/Command+Line+Interface+Project>`_ - `Passing Badge information for CLI <https://bestpractices.coreinfrastructure.org/en/projects/1540>`_ - - `Project Vulnerability Review Table for CLI <https://wiki.onap.org/pages/viewpage.action?pageId=45298770>`_ + - `Project Vulnerability Review Table for CLI <https://wiki.onap.org/pages/viewpage.action?pageId=45298770>`__ Version: 2.0.0 @@ -181,7 +181,7 @@ by using CLI as portal does not support. In addition, it made following changes to OCS 1.0 * http profile is enabled with service section to capture micro-service catalog and auth information -and body section could be customized using context. + and body section could be customized using context. * New default parameters verify and context are added. @@ -202,14 +202,14 @@ and body section could be customized using context. CLI code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The CLI open Critical security vulnerabilities and their risk assessment have been -documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28377287>`_. +documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28377287>`__. Quick Links: - `CLI project page <https://wiki.onap.org/display/DW/Command+Line+Interface+Project>`_ - `Passing Badge information for CLI <https://bestpractices.coreinfrastructure.org/en/projects/1540>`_ - - `Project Vulnerability Review Table for CLI <https://wiki.onap.org/pages/viewpage.action?pageId=28377287>`_ + - `Project Vulnerability Review Table for CLI <https://wiki.onap.org/pages/viewpage.action?pageId=28377287>`__ Version: 1.1.0 -------------- diff --git a/docs/tox.ini b/docs/tox.ini index 4bbc6403..44de4474 100644 --- a/docs/tox.ini +++ b/docs/tox.ini @@ -8,11 +8,11 @@ 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=london commands = - sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html + sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html echo "Generated docs available in {toxinidir}/_build/html" -whitelist_externals = +allowlist_externals = echo git sh @@ -22,13 +22,13 @@ 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 +allowlist_externals = echo [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=master + -chttps://git.onap.org/doc/plain/etc/upper-constraints.onap.txt?h=london commands = sphinx-build -W -q -b spelling -d {envtmpdir}/doctrees {toxinidir} {toxinidir}/_build/spellcheck |