Updating docs for Plugins module

Change-Id: Ia0837cf2f86c42eea71c3f71e8cd99d684912485
Signed-off-by: Dinh Danh Le <dinh.danh.le@ericsson.com>
Issue-ID: POLICY-867

1 files changed, 33 insertions, 0 deletions

diff --git a/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-yaml/src/site-docs/adoc/fragments/ep-yaml.adoc b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-yaml/src/site-docs/adoc/fragments/ep-yaml.adoc
new file mode 100644
index 000000000..90c3812af
--- /dev/null
+++ b/plugins/plugins-event/plugins-event-protocol/plugins-event-protocol-yaml/src/site-docs/adoc/fragments/ep-yaml.adoc
@@ -0,0 +1,33 @@
+//
+// ============LICENSE_START=======================================================
+//  Copyright (C) 2016-2018 Ericsson. All rights reserved.
+// ================================================================================
+// This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE
+// Full license text at https://creativecommons.org/licenses/by/4.0/legalcode
+// 
+// SPDX-License-Identifier: CC-BY-4.0
+// ============LICENSE_END=========================================================
+//
+// @author Sven van der Meer (sven.van.der.meer@ericsson.com)
+//
+
+== YAML Event
+
+The event protocol for YAML is provided by the APEX YAML plugin.
+There is no difference in the configuration for the input and output interface.
+
+If used as input, APEX will consume events as YAML and map them to policy trigger events.
+Not well-formed YAML and not understood trigger events will be rejected.
+If used as output, APEX produce YAML encoded events from the event a policy produces.
+Those events will always be well-formed according to the definition in the policy model.
+
+The following code shows the configuration.
+
+[source%nowrap,json]
+----
+"eventProtocolParameters":{
+  "eventProtocol" : "XML",
+  "parameterClassName" :
+      "org.onap.policy.apex.plugins.event.protocol.yaml.YamlEventProtocolParameters"
+}
+----