From 78aa63af02df682b3c8d825c1bec9cec6cd3b207 Mon Sep 17 00:00:00 2001 From: Gerald Kunzmann Date: Thu, 9 Feb 2017 09:36:29 +0000 Subject: Update docs structure according to new guidelines in https://wiki.opnfv.org/display/DOC Change-Id: I69e6536d9044dd9db2ed3cd698059aa3a800c318 Signed-off-by: Gerald Kunzmann --- .../feature.configuration.rst | 63 --------------------- docs/installationprocedure/images/LICENSE | 14 ----- .../images/screenshot_promise.png | Bin 101419 -> 0 bytes .../images/screenshot_promise_install.png | Bin 77709 -> 0 bytes docs/installationprocedure/index.rst | 13 ----- 5 files changed, 90 deletions(-) delete mode 100644 docs/installationprocedure/feature.configuration.rst delete mode 100644 docs/installationprocedure/images/LICENSE delete mode 100755 docs/installationprocedure/images/screenshot_promise.png delete mode 100644 docs/installationprocedure/images/screenshot_promise_install.png delete mode 100644 docs/installationprocedure/index.rst (limited to 'docs/installationprocedure') diff --git a/docs/installationprocedure/feature.configuration.rst b/docs/installationprocedure/feature.configuration.rst deleted file mode 100644 index 10696e0..0000000 --- a/docs/installationprocedure/feature.configuration.rst +++ /dev/null @@ -1,63 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -Manual testing -============== - -Promise installation --------------------- - -Install nodejs, npm and promise - -.. code-block:: bash - - curl -sL https://deb.nodesource.com/setup_4.x | sudo -E bash - - sudo apt-get install -y nodejs - sudo npm -g install npm@latest - git clone https://gerrit.opnfv.org/gerrit/promise - cd promise/source - npm install - -Please note that the last command 'npm install' will install all needed dependencies -for promise (including yangforge and mocha) - -.. figure:: images/screenshot_promise_install.png - :name: figure1 - :width: 90% - - -Validation ----------- -Please perform the following preparation steps: - -1. Set OpenStack environment parameters properly (e.g. source openrc admin demo - in DevStack) -2. Create OpenStack tenant (e.g. promise) and tenant user (e.g. promiser) -3. Create a flavor in Nova with 1 vCPU and 512 MB RAM -4. Create a private network, subnet and router in Neutron -5. Create an image in Glance - -Once done, the promise test script can be invoked as follows (as a single line -command): - -.. code-block:: bash - - NODE_ENV=mytest \ - OS_TENANT_NAME=promise \ - OS_USERNAME=promiser \ - OS_PASSWORD= \ - OS_TEST_FLAVOR= \ - OS_TEST_NETWORK= \ - OS_TEST_IMAGE= \ - npm run -s test -- --reporter json > promise-results.json - -The results of the tests will be stored in the promise-results.json file. - -The results can also be seen in the console ("npm run -s test") - -.. figure:: images/screenshot_promise.png - :name: figure2 - :width: 90% - -All 33 tests passing?! -Congratulations, promise has been successfully installed and configured. diff --git a/docs/installationprocedure/images/LICENSE b/docs/installationprocedure/images/LICENSE deleted file mode 100644 index 6a84dd4..0000000 --- a/docs/installationprocedure/images/LICENSE +++ /dev/null @@ -1,14 +0,0 @@ -Copyright 2016 Open Platform for NFV Project, Inc. and its contributors - -Open Platform for NFV Project Documentation Licence -=================================================== -Any documentation developed by the "Open Platform for NFV Project" -is licensed under a Creative Commons Attribution 4.0 International License. -You should have received a copy of the license along with this. If not, -see . - -Unless required by applicable law or agreed to in writing, documentation -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. diff --git a/docs/installationprocedure/images/screenshot_promise.png b/docs/installationprocedure/images/screenshot_promise.png deleted file mode 100755 index 4a0cbe3..0000000 Binary files a/docs/installationprocedure/images/screenshot_promise.png and /dev/null differ diff --git a/docs/installationprocedure/images/screenshot_promise_install.png b/docs/installationprocedure/images/screenshot_promise_install.png deleted file mode 100644 index 2cb27d9..0000000 Binary files a/docs/installationprocedure/images/screenshot_promise_install.png and /dev/null differ diff --git a/docs/installationprocedure/index.rst b/docs/installationprocedure/index.rst deleted file mode 100644 index 41bc079..0000000 --- a/docs/installationprocedure/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - .. (c) - -************************************** -Promise installation and configuration -************************************** - -.. toctree:: - :numbered: - :maxdepth: 2 - - feature.configuration.rst -- cgit 1.2.3-korg