summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/Chapter1.rst10
-rw-r--r--docs/Chapter2.rst29
-rw-r--r--docs/_static/css/ribbon.css63
-rwxr-xr-xdocs/_static/favicon.icobin0 -> 2102 bytes
-rwxr-xr-xdocs/_static/logo_onap_2017.pngbin0 -> 6980 bytes
-rw-r--r--docs/_templates/layout.html19
6 files changed, 118 insertions, 3 deletions
diff --git a/docs/Chapter1.rst b/docs/Chapter1.rst
index 1c3481d..ea9dbaf 100644
--- a/docs/Chapter1.rst
+++ b/docs/Chapter1.rst
@@ -16,6 +16,16 @@
**VNF Package Test Cases**
==========================
+The information in this section deals with the Test Cases corresponding to
+the the VNF Requirements. There are two types:
+
+ 1. VNF Package Information Element Present: which is the base case of a
+ Test Case, please refer to :ref:`Annex.<info-elements>`
+
+ 2. VNF Package Information Element within Range Limits: refers to a Test Case
+ when there are Range Limits placed, please refer to
+ :ref:`Annex.<info-elements-range-limits>`
+
VNF Package Information Element Present
---------------------------------------
diff --git a/docs/Chapter2.rst b/docs/Chapter2.rst
index 99c0053..eea9c0f 100644
--- a/docs/Chapter2.rst
+++ b/docs/Chapter2.rst
@@ -16,12 +16,22 @@
**Appendix**
============
-Appendix 1 List of VNF Requirements and corresponding Information Elements
+.. _info-elements:
+
+List of VNF Requirements and corresponding Information Elements
--------------------------------------------------------------------------
You can download the table
:download:`here<ReqTable.csv>`
+Included here is a table of VNF Requirements that are mainly referring to
+the testability of VNF Package requirements. It includes TOSCA or CSAR
+artifact information as well as how it is testable (VNFSDK/VVP/SDC).
+These requirements are mainly from :doc:`Chapter 5 <../../../../vnfrqts/requirements.git/docs/Chapter5/index>`
+and the table has been generated manually to show users what specific
+artifact is being tested by a specific requirement to make mapping possible
+and to show coverage.
+
.. csv-table:: **Test Descriptions**
:file: ReqTable.csv
:header-rows: 1
@@ -35,15 +45,28 @@ List of Requirements with associated Tests
You can download the table
:download:`here<traceability.csv>`
+This table shows all the requirements within the VNF Requirements project with
+the section they are in, associated test names and modules. This is generated
+dynamically within the VVP project, where it pulls down the latest JSON from
+:doc:`Chapter 9 - Requirement List <../../../../vnfrqts/requirements.git/docs/Chapter9/index>`
+and maps the requirements to the tests in VVP to output this table.
+
+ **Note: Tests on the bottom do not map to any requirements.**
+
+ **Note: VVP only validates Heat for Requirements in Chapter 5.**
+
.. csv-table:: **Test Traceability**
:file: traceability.csv
:header-rows: 1
:align: center
:widths: auto
-Appendix 2 List of VNF Requirements and corresponding Information Elements with Range limits
----------------------------------------------------------------------------------------------
+.. _info-elements-range-limits:
+
+VNF Requirements corresponding Information Elements w/Range limits
+------------------------------------------------------------------------------
+Will be generated in future releases.
.. [#4.1.1]
Refer to NCSP’s Network Cloud specification
diff --git a/docs/_static/css/ribbon.css b/docs/_static/css/ribbon.css
new file mode 100644
index 0000000..6008cb1
--- /dev/null
+++ b/docs/_static/css/ribbon.css
@@ -0,0 +1,63 @@
+.ribbon {
+ z-index: 1000;
+ background-color: #a00;
+ overflow: hidden;
+ white-space: nowrap;
+ position: fixed;
+ top: 25px;
+ right: -50px;
+ -webkit-transform: rotate(45deg);
+ -moz-transform: rotate(45deg);
+ -ms-transform: rotate(45deg);
+ -o-transform: rotate(45deg);
+ transform: rotate(45deg);
+ -webkit-box-shadow: 0 0 10px #888;
+ -moz-box-shadow: 0 0 10px #888;
+ box-shadow: 0 0 10px #888;
+
+}
+
+.ribbon a {
+ border: 1px solid #faa;
+ color: #fff;
+ display: block;
+ font: bold 81.25% 'Helvetica Neue', Helvetica, Arial, sans-serif;
+ margin: 1px 0;
+ padding: 10px 50px;
+ text-align: center;
+ text-decoration: none;
+ text-shadow: 0 0 5px #444;
+ transition: 0.5s;
+}
+
+.ribbon a:hover {
+ background: #c11;
+ color: #fff;
+}
+
+
+/* override table width restrictions */
+@media screen and (min-width: 767px) {
+
+ .wy-table-responsive table td, .wy-table-responsive table th {
+ /* !important prevents the common CSS stylesheets from overriding
+ this as on RTD they are loaded after this stylesheet */
+ white-space: normal !important;
+ }
+
+ .wy-table-responsive {
+ overflow: visible !important;
+ }
+}
+
+@media screen and (max-width: 767px) {
+ .wy-table-responsive table td {
+ white-space: nowrap;
+ }
+}
+
+/* fix width of the screen */
+
+.wy-nav-content {
+ max-width: none;
+}
diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico
new file mode 100755
index 0000000..cb712eb
--- /dev/null
+++ b/docs/_static/favicon.ico
Binary files differ
diff --git a/docs/_static/logo_onap_2017.png b/docs/_static/logo_onap_2017.png
new file mode 100755
index 0000000..9f63444
--- /dev/null
+++ b/docs/_static/logo_onap_2017.png
Binary files differ
diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html
new file mode 100644
index 0000000..ba05e82
--- /dev/null
+++ b/docs/_templates/layout.html
@@ -0,0 +1,19 @@
+{# Import the theme's layout. #}
+{% extends "!layout.html" %}
+
+{# Custom CSS override for warning banner #}
+{% set css_files = css_files + ['_static/css/warning-header.css'] %}
+
+{# Ribbon #}
+{% block content %}
+ <div class="ribbon">
+ <a href="https://jira.onap.org/secure/CreateIssueDetails!init.jspa
+?pid=10111
+&issuetype=10004
+&priority=2
+&description=version:+{{version}}%0Apage:+{{pagename}}%0A%0A" target="_blank">
+ Report Issue
+ </a>
+ </div>
+ {{ super() }}
+{% endblock %}