summaryrefslogtreecommitdiffstats
path: root/src/site/xdoc/policy-guide.xml
diff options
context:
space:
mode:
authorramverma <ram.krishna.verma@ericsson.com>2018-07-31 18:25:39 +0100
committerramverma <ram.krishna.verma@ericsson.com>2018-07-31 18:27:31 +0100
commitaf74a6270d6ab6badf04a97495a6ef8ccded9b4b (patch)
tree2c7a536e54207a0870ca2008ce457a64de917ab9 /src/site/xdoc/policy-guide.xml
parent9e318f20f2e64970bf3c2e3a5532c516231a6f8a (diff)
Adding first set of apex-pdp document changes
Adding document changes for auth, context, core, model, services & the main apex-pdp module. Change-Id: Id0d026baa258f1dc6998978f9911f3c4a73b5b3b Issue-ID: POLICY-867 Signed-off-by: ramverma <ram.krishna.verma@ericsson.com>
Diffstat (limited to 'src/site/xdoc/policy-guide.xml')
-rw-r--r--src/site/xdoc/policy-guide.xml96
1 files changed, 96 insertions, 0 deletions
diff --git a/src/site/xdoc/policy-guide.xml b/src/site/xdoc/policy-guide.xml
new file mode 100644
index 000000000..9167d393a
--- /dev/null
+++ b/src/site/xdoc/policy-guide.xml
@@ -0,0 +1,96 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ============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)
+
+-->
+
+<document>
+ <properties>
+ <title>The APEX Policy Guide</title>
+ <author email="sven.van.der.meer@ericsson.com">Sven van der Meer</author>
+ <author email="liam.fallon@ericsson.com">Liam Fallon</author>
+ <author email="john.keeney@ericsson.com">John Keeny</author>
+ </properties>
+ <body>
+
+ <section name="The APEX Policy Guide">
+
+ <p>
+ The APEX policy guide combines a set of howto documents, all supporting APEX and policy, including how to write task and task selection logic.
+ The howto documents are provided as integrated documentation in the APEX site.
+ Furthermore, we provide stand-alone documents in HTML and PDF.
+ </p>
+
+ <p>
+ Note: most of the documentation is written in AsciiDoc.
+ We are using the AsciiDoctor version.
+ Due to the different build tools used for the different documentation targets, the rendered documents differ in style.
+ The content however comes always from a single, normative source located in the APEX source repositories.
+ </p>
+
+ <h3>APEX Policy Guide documentation</h3>
+ <table>
+ <tr>
+ <th style="white-space:nowrap; font-weight: bold; font-size: 1.25em" width="20%">Name</th>
+ <th style="white-space:nowrap; font-weight: bold; font-size: 1.25em" width="50%">Description</th>
+ <th style="white-space:nowrap; font-weight: bold; font-size: 1.25em" width="30%">Links</th>
+ </tr>
+ <tr>
+ <td>Policy Guide</td>
+ <td>
+ The complete APEX Policy Guide, including all HowTos and other documentation.
+ The stand-alone versions aggregate all other documents listed in this table.
+ </td>
+ <td>
+ <ul>
+ <li><a href="docs-apex/html/APEX-Policy-Guide.html">stand-alone HTML</a></li>
+ <li><a href="docs-apex/pdf/APEX-Policy-Guide.pdf">stand-alone PDF</a></li>
+ </ul>
+ </td>
+ </tr>
+
+ <tr>
+ <td>The APEX Policy Model</td>
+ <td>
+ A deep dive into the policy model defined and implemented in the APEX engine.
+ This model is the foundation for policy execution.
+ </td>
+ <td>
+ <ul>
+ <li><a href="docs-apex/html/Tech-APEX-PolicyModel.html">stand-alone HTML</a></li>
+ <li><a href="docs-apex/pdf/Tech-APEX-PolicyModel.pdf">stand-alone PDF</a></li>
+ </ul>
+ </td>
+ </tr>
+
+ <tr>
+ <td>HowTo: Policy Logic</td>
+ <td>
+ An APEX policy requires task logic being programmed.
+ When multiple tasks are combined into a single policy state, a so called task selection logic needs to be programmed as well.
+ This HowTo explains how to programme policy task logic and if required task selection logic.
+ </td>
+ <td>
+ <ul>
+ <li><a href="policy-guide/pg-task-logic.html">APEX Site, task logic</a></li>
+ <li><a href="policy-guide/pg-task-selection-logic.html">APEX Site, task selection logic</a></li>
+ <li><a href="policy-guide/pg-logic-cheatsheet.html">APEX Site, logic cheatsheet</a></li>
+ <li><a href="docs-apex/html/HowTo-PolicyLogic.html">stand-alone HTML</a></li>
+ <li><a href="docs-apex/pdf/HowTo-PolicyLogic.pdf">stand-alone PDF</a></li>
+ </ul>
+ </td>
+ </tr>
+
+ </table>
+ </section>
+ </body>
+</document> \ No newline at end of file