summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorBertrand Souville <souville@docomolab-euro.com>2016-08-24 11:06:12 +0200
committerBertrand Souville <souville@docomolab-euro.com>2016-08-24 11:06:12 +0200
commit5c9de76a234e3cc115badece4ee7d8edcf048962 (patch)
tree1c91851fcf5d1edf9c7cefee394b42203b3b5800 /docs
parentdd5462a8969713eb913afd8418bbcf4dbfb53c35 (diff)
Proposal to delete configguide directory (featureconfig and images moved
to user guide) and platformoverview directory (no content) Change-Id: Iafea58ca822aa0ada9371e39b495aad7abe544b7 Signed-off-by: Bertrand Souville <souville@docomolab-euro.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/configguide/featureconfig.rst58
-rw-r--r--docs/configguide/images/LICENSE14
-rwxr-xr-xdocs/configguide/images/screenshot_promise.pngbin101419 -> 0 bytes
-rw-r--r--docs/configguide/index.rst12
-rw-r--r--docs/platformoverview/index.rst12
-rw-r--r--docs/platformoverview/promise_platform.rst18
6 files changed, 0 insertions, 114 deletions
diff --git a/docs/configguide/featureconfig.rst b/docs/configguide/featureconfig.rst
deleted file mode 100644
index 9ad61d4..0000000
--- a/docs/configguide/featureconfig.rst
+++ /dev/null
@@ -1,58 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-Promise Feature Configuration Overview
-======================================
-
-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://github.com/opnfv/promise.git
- cd promise
- npm install
-
-Please note that the last command 'npm install' will install all needed dependencies
-for promise (including yangforge and mocha)
-
-Testing
--------
-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=<user password from Step 2> \
- OS_TEST_FLAVOR=<flavor ID from Step 3> \
- OS_TEST_NETWORK=<network ID from Step 4> \
- OS_TEST_IMAGE=<image ID from Step 5> \
- 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: figure1
- :width: 90%
-
-All 33 tests passing?!
-Congratulations, promise has been successfully installed and configured.
diff --git a/docs/configguide/images/LICENSE b/docs/configguide/images/LICENSE
deleted file mode 100644
index 3b8719c..0000000
--- a/docs/configguide/images/LICENSE
+++ /dev/null
@@ -1,14 +0,0 @@
-Copyright 2015 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 <http://creativecommons.org/licenses/by/4.0/>.
-
-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/configguide/images/screenshot_promise.png b/docs/configguide/images/screenshot_promise.png
deleted file mode 100755
index 4a0cbe3..0000000
--- a/docs/configguide/images/screenshot_promise.png
+++ /dev/null
Binary files differ
diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst
deleted file mode 100644
index e9f6490..0000000
--- a/docs/configguide/index.rst
+++ /dev/null
@@ -1,12 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-********************************************
-Promise Installation and Configuration Guide
-********************************************
-
-.. toctree::
- :numbered:
- :maxdepth: 2
-
- featureconfig.rst
diff --git a/docs/platformoverview/index.rst b/docs/platformoverview/index.rst
deleted file mode 100644
index 86f56ee..0000000
--- a/docs/platformoverview/index.rst
+++ /dev/null
@@ -1,12 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-****************************
-Overview of Promise Platform
-****************************
-
-.. toctree::
- :numbered:
- :maxdepth: 2
-
- promise_platform.rst
diff --git a/docs/platformoverview/promise_platform.rst b/docs/platformoverview/promise_platform.rst
deleted file mode 100644
index 7884ae6..0000000
--- a/docs/platformoverview/promise_platform.rst
+++ /dev/null
@@ -1,18 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-
-=========================
-Promise Platform Overview
-=========================
-
-https://wiki.opnfv.org/promise
-
-Features
-========
-
-Description of platform capabilities
-
-Components
-==========
-
-Describe the platform architecture