summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChris Donley <christopher.donley@huawei.com>2018-05-30 13:33:08 -0700
committerChris Donley <christopher.donley@huawei.com>2018-05-30 13:33:08 -0700
commit9ddf5d56726e400bbf6955c3620706916057e6d8 (patch)
tree158c1aae3dfdab8da13fea1197c272b8b3ce169f
parentc3ef59ead7c51bf9777fb8092e4b0ad7c20573dd (diff)
Fix typos in VNFSDK docs
Issue-ID: VNFSDK-270 Change-Id: Ia8b1fcf8f32fe2b15dd4facacee206ccff8b8c80 Signed-off-by: Chris Donley <christopher.donley@huawei.com>
-rw-r--r--docs/files/VESEventRegistration.rst37
-rw-r--r--docs/files/marketplace-overview.rst4
-rw-r--r--docs/index.rst4
-rw-r--r--docs/swagger.json (renamed from docs/files/swagger.json)0
-rw-r--r--docs/swagger.yaml (renamed from docs/files/swagger.yaml)0
5 files changed, 21 insertions, 24 deletions
diff --git a/docs/files/VESEventRegistration.rst b/docs/files/VESEventRegistration.rst
index 4104a1f..a3fe93d 100644
--- a/docs/files/VESEventRegistration.rst
+++ b/docs/files/VESEventRegistration.rst
@@ -164,6 +164,7 @@ YAML files consist of a series of YAML documents delimited by ‘---‘ and
‘…’ for example:
::
+
---
# Event Registration for eventName ‘name1’
@@ -480,6 +481,7 @@ based on the named ‘conditions’ asserted in action qualifiers in the
preceding event definitions. For example:
::
+
---
# Event Registration for eventName ‘name1’
@@ -531,17 +533,13 @@ The YAML ‘rules’ document begins with the keyword ‘rules’ followed by a
colon and square brackets. Each rule is then defined within the square
brackets. Commas are used to separate rules.
-Each rule is expressed as follows:
-
-rule: {
-
-trigger: *logical expression in terms of conditions*,
+Each rule is expressed as follows::
-microservices: [ *microservice1, microservice2, microservice3…* ]
-
-alerts: [tcaE*ventName1, tcaEventName2, tcaEventName3…* ],
-
-}
+ rule: {
+ trigger: *logical expression in terms of conditions*,
+ microservices: [ *microservice1, microservice2, microservice3…* ]
+ alerts: [tcaE*ventName1, tcaEventName2, tcaEventName3…* ],
+ }
Notes:
@@ -573,9 +571,7 @@ Example logical expression:
Where A, B, C and D are named conditions expressed earlier in the YAML
file.
-Example rules definition:
-
-::
+Example rules definition::
rules: [
rule: {
@@ -603,6 +599,7 @@ with a colon and curly braces. The time based rule is placed in the
curly braces as follows:
::
+
trigger: B:{3 times in 300 seconds}
This means that if condition B occurs 3 (or more) times in 300 seconds
@@ -611,6 +608,7 @@ This means that if condition B occurs 3 (or more) times in 300 seconds
More complex triggers can be created as follows:
::
+
trigger: B:{3 times in 300 seconds} \|\| (C & D:{2 times in 600 seconds}),
This means that the trigger fires if condition B occurs 3 (or more)
@@ -665,7 +663,7 @@ make it easier to read.
}}
}}
- ...
+::
---
# registration for clearing Fault\_vMrf\_alarm003Cleared
@@ -701,7 +699,7 @@ make it easier to read.
}}
}}
- ...
+::
---
# registration for Heartbeat_vMRF
@@ -732,7 +730,7 @@ make it easier to read.
}}
}}
- ...
+::
---
# registration for Mfvs\_vMRF
@@ -1001,7 +999,7 @@ make it easier to read.
}}
}}
- ...
+::
---
# registration for Syslog\_vMRF
@@ -1038,7 +1036,7 @@ make it easier to read.
}}
}}
- ...
+::
---
#Rules
@@ -1054,6 +1052,5 @@ make it easier to read.
microservices: [scaleIn]
}
]
-
- ...
+
diff --git a/docs/files/marketplace-overview.rst b/docs/files/marketplace-overview.rst
index df1dde0..8927ea1 100644
--- a/docs/files/marketplace-overview.rst
+++ b/docs/files/marketplace-overview.rst
@@ -3,7 +3,7 @@
.. Copyright 2017 Huawei Technologies Co., Ltd.
VNF SDK Marketplace
-===================
+-------------------
VNF SDK provides a reference implementation "marketplace" to help vendors
validate and manage VNF packages. It also supports the operator to onboard VNF
@@ -12,7 +12,7 @@ or :download:`json <swagger.json>` :download:`yaml <swagger.yaml>`
|image0|
-.. |image0| image:: vnfsdk-marketplace.png
+.. |image0| image:: files/vnfsdk-marketplace.png
:height: 600px
:width: 800px
diff --git a/docs/index.rst b/docs/index.rst
index af04833..2d77e38 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -46,7 +46,7 @@ persisted, along with the product executables and data, using TOSCA CSAR files.
files/*blueprints
VNF SDK Marketplace
--------------------
+===================
.. include:: files/marketplace-overview.rst
@@ -82,7 +82,7 @@ content. The following tools are included...
User Guides
------------
+===========
VNF Package Tools User Guide
----------------------------
diff --git a/docs/files/swagger.json b/docs/swagger.json
index 04a227b..04a227b 100644
--- a/docs/files/swagger.json
+++ b/docs/swagger.json
diff --git a/docs/files/swagger.yaml b/docs/swagger.yaml
index 79edd40..79edd40 100644
--- a/docs/files/swagger.yaml
+++ b/docs/swagger.yaml