diff options
| author |   Rich Bennett <rb2745@att.com> | 2017-10-13 15:28:09 -0400 |
|---|---|---|
| committer | Rich Bennett <rb2745@att.com> | 2017-10-13 15:32:13 -0400 |
| commit | dd0f4438e8dea6ef68a043488545e3efcb3fa78a (patch) | |
| tree | ced34525665cc8c4b35a79c0ee7a50290c60240c /docs/installation_guide.rst | |
| parent | 0e89c1fbeb6618a1a4218c7c78506dff6f71dd6d (diff) | |
Minor edits to resturcture text documentation
Improved cross references, bullet lists, and used code-block directive on bash cmds
Added release-notes template
Change-Id: Id12fb1b77ef9690b5b50505e47ec7035039f2f24
Issue-ID: CLI-54
Signed-off-by: Rich Bennett <rb2745@att.com>
Diffstat (limited to 'docs/installation_guide.rst')
| -rw-r--r-- | docs/installation_guide.rst | 31 |
1 files changed, 21 insertions, 10 deletions
diff --git a/docs/installation_guide.rst b/docs/installation_guide.rst index b6864f05..dc02bcc5 100644 --- a/docs/installation_guide.rst +++ b/docs/installation_guide.rst @@ -1,8 +1,9 @@ -.. _installation_guide: .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 .. Copyright 2017 Huawei Technologies Co., Ltd. +.. _cli_installation_guide: + CLI installation guide ====================== @@ -22,15 +23,19 @@ Please follow the instructions given below, for installing CLI using install.sh. .. _here: https://gerrit.onap.org/r/gitweb?p=cli.git;a=blob_plain;f=deployment/zip/installer/install.sh;hb=refs/heads/master -2. Run command:: +2. Run command + +.. code-block:: bash source /tmp/install.sh -3. Verify the installation by running following command:: +3. Verify the installation by running following command. + +.. code-block:: bash onap -v -4. For details, see :ref:`user_guide` +4. For details, see :ref:`cli_user_guide` Using Portal CLI app @@ -52,26 +57,32 @@ Please follow the instructions given below, for installing CLI from portal. 3. After downloading, please follow the instruction given in this page to install ONAP CLI. -4. Verify the installation by running following command:: +4. Verify the installation by running following command + +.. code-block:: bash onap -v -5. For details, see :ref:`user_guide` +5. For details, see :ref:`cli_user_guide` Using docker image ------------------ +------------------ Please follow the instructions given below, for installing CLI using docker image. -1. Download the cli docker image:: +1. Download the cli docker image + +.. code-block:: bash docker login -u docker -p docker nexus3.onap.org:10001 docker pull nexus3.onap.org:10001/onap/cli -2. Verify the installation by running following command:: +2. Verify the installation by running following command + +.. code-block:: bash docker run onap/cli onap -v -3. For details, see :ref:`user_guide` +3. For details, see :ref:`cli_user_guide` |