summaryrefslogtreecommitdiffstats
path: root/docs/design
diff options
context:
space:
mode:
authorRyota MIBU <r-mibu@cq.jp.nec.com>2016-02-26 02:31:45 +0900
committerRyota MIBU <r-mibu@cq.jp.nec.com>2016-02-26 02:31:45 +0900
commit534a1d1aeb178985bd884449377b2f4d671e14cf (patch)
tree2d12d00c7c77ca8af86ef7293eb393bb7b230d7f /docs/design
parent1ac0bc3e63c6d0ecff751843893fbb475b8e6c07 (diff)
migrate new docs template and fix pdf view
JIRA: SFC-31 Change-Id: I9e46c799083553b8c6142f018cd71a638006a449 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
Diffstat (limited to 'docs/design')
-rw-r--r--docs/design/architecture.rst3
-rw-r--r--docs/design/definitions.rst3
-rw-r--r--docs/design/index.rst22
-rw-r--r--docs/design/introduction.rst24
-rw-r--r--docs/design/requirements.rst3
-rw-r--r--docs/design/usecases.rst4
6 files changed, 24 insertions, 35 deletions
diff --git a/docs/design/architecture.rst b/docs/design/architecture.rst
index d2a1bb4d..d6779e9a 100644
--- a/docs/design/architecture.rst
+++ b/docs/design/architecture.rst
@@ -1,3 +1,6 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
Architecture
------------
diff --git a/docs/design/definitions.rst b/docs/design/definitions.rst
index 38263044..85416fb8 100644
--- a/docs/design/definitions.rst
+++ b/docs/design/definitions.rst
@@ -1,3 +1,6 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
Definitions
-----------
diff --git a/docs/design/index.rst b/docs/design/index.rst
index 138a1817..f13d575b 100644
--- a/docs/design/index.rst
+++ b/docs/design/index.rst
@@ -1,28 +1,16 @@
-.. OPNFV Service Function Chaining (SFC) documentation
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
-.. image:: ../etc/opnfv-logo.png
- :height: 40
- :width: 200
- :alt: OPNFV
- :align: left
-|
-|
+*******************************
Service Function Chaining (SFC)
-===============================
-
-Contents:
+*******************************
.. toctree::
:numbered:
- :maxdepth: 4
+ :maxdepth: 2
introduction.rst
definitions.rst
usecases.rst
architecture.rst
requirements.rst
-
-Indices and tables
-==================
-
-* :ref:`search`
diff --git a/docs/design/introduction.rst b/docs/design/introduction.rst
index 441ed999..13584e79 100644
--- a/docs/design/introduction.rst
+++ b/docs/design/introduction.rst
@@ -1,23 +1,13 @@
-.. two dots create a comment. please leave this logo at the top of each of your rst files.
-.. image:: ../etc/opnfv-logo.png
- :height: 40
- :width: 200
- :alt: OPNFV
- :align: left
-.. these two pipes are to seperate the logo from the first title
-|
-|
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
Introduction
------------
-..
- This work is licensed under a Creative Commons Attribution 3.0 Unported License.
-
- http://creativecommons.org/licenses/by/3.0/legalcode
-
.. NOTE::
This is the working documentation for the SFC project.
-The `OPNFV Service Function Chaining (SFC) <https://wiki.opnfv.org/sfc>`_ project aims to provide the ability to define an ordered list of a network services (e.g. firewalls, NAT, QoS). These service are then "stitched" together in the network to create a service chain. This project provides the infrastructure to install the upstream ODL SFC implementation project in an NFV environment.
-
-
+The `OPNFV Service Function Chaining (SFC) <https://wiki.opnfv.org/sfc>`_ project aims to provide the ability to define
+an ordered list of a network services (e.g. firewalls, NAT, QoS).
+These service are then "stitched" together in the network to create a service chain.
+This project provides the infrastructure to install the upstream ODL SFC implementation project in an NFV environment.
diff --git a/docs/design/requirements.rst b/docs/design/requirements.rst
index 3a716351..3a790200 100644
--- a/docs/design/requirements.rst
+++ b/docs/design/requirements.rst
@@ -1,3 +1,6 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
Requirements
------------
diff --git a/docs/design/usecases.rst b/docs/design/usecases.rst
index b42fcbde..0f22491d 100644
--- a/docs/design/usecases.rst
+++ b/docs/design/usecases.rst
@@ -1,10 +1,12 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
Use Cases
---------
This section outlines the Brahmaputra use cases driving the initial OPNFV
SFC implementation.
-
The use cases targeted in the OPNFV SFC Brahmaputra release focus on creating
simple Service Chains using Firewall Service Functions. As can be seen in the
following diagram, 2 service chains are created, each through a different