Gitiles
Code Review Sign In
gerrit.nordix.org / onap / policy / apex-pdp / af74a6270d6ab6badf04a97495a6ef8ccded9b4b / . / src / site / xdoc / policy-guide.xml
blob: 9167d393a01f1f5514f50a3645852a613d5dec2c [file] [log] [blame]
ramvermaaf74a622018-07-31 18:25:39 +0100[diff] [blame^]1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3 ============LICENSE_START=======================================================
4 Copyright (C) 2016-2018 Ericsson. All rights reserved.
5 ================================================================================
6 This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE
7 Full license text at https://creativecommons.org/licenses/by/4.0/legalcode
8
9 SPDX-License-Identifier: CC-BY-4.0
10 ============LICENSE_END=========================================================
11
12 @author Sven van der Meer (sven.van.der.meer@ericsson.com)
13
14-->
15
16<document>
17 <properties>
18 <title>The APEX Policy Guide</title>
19 <author email="sven.van.der.meer@ericsson.com">Sven van der Meer</author>
20 <author email="liam.fallon@ericsson.com">Liam Fallon</author>
21 <author email="john.keeney@ericsson.com">John Keeny</author>
22 </properties>
23 <body>
24
25 <section name="The APEX Policy Guide">
26
27 <p>
28 The APEX policy guide combines a set of howto documents, all supporting APEX and policy, including how to write task and task selection logic.
29 The howto documents are provided as integrated documentation in the APEX site.
30 Furthermore, we provide stand-alone documents in HTML and PDF.
31 </p>
32
33 <p>
34 Note: most of the documentation is written in AsciiDoc.
35 We are using the AsciiDoctor version.
36 Due to the different build tools used for the different documentation targets, the rendered documents differ in style.
37 The content however comes always from a single, normative source located in the APEX source repositories.
38 </p>
39
40 <h3>APEX Policy Guide documentation</h3>
41 <table>
42 <tr>
43 <th style="white-space:nowrap; font-weight: bold; font-size: 1.25em" width="20%">Name</th>
44 <th style="white-space:nowrap; font-weight: bold; font-size: 1.25em" width="50%">Description</th>
45 <th style="white-space:nowrap; font-weight: bold; font-size: 1.25em" width="30%">Links</th>
46 </tr>
47 <tr>
48 <td>Policy Guide</td>
49 <td>
50 The complete APEX Policy Guide, including all HowTos and other documentation.
51 The stand-alone versions aggregate all other documents listed in this table.
52 </td>
53 <td>
54 <ul>
55 <li><a href="docs-apex/html/APEX-Policy-Guide.html">stand-alone HTML</a></li>
56 <li><a href="docs-apex/pdf/APEX-Policy-Guide.pdf">stand-alone PDF</a></li>
57 </ul>
58 </td>
59 </tr>
60
61 <tr>
62 <td>The APEX Policy Model</td>
63 <td>
64 A deep dive into the policy model defined and implemented in the APEX engine.
65 This model is the foundation for policy execution.
66 </td>
67 <td>
68 <ul>
69 <li><a href="docs-apex/html/Tech-APEX-PolicyModel.html">stand-alone HTML</a></li>
70 <li><a href="docs-apex/pdf/Tech-APEX-PolicyModel.pdf">stand-alone PDF</a></li>
71 </ul>
72 </td>
73 </tr>
74
75 <tr>
76 <td>HowTo: Policy Logic</td>
77 <td>
78 An APEX policy requires task logic being programmed.
79 When multiple tasks are combined into a single policy state, a so called task selection logic needs to be programmed as well.
80 This HowTo explains how to programme policy task logic and if required task selection logic.
81 </td>
82 <td>
83 <ul>
84 <li><a href="policy-guide/pg-task-logic.html">APEX Site, task logic</a></li>
85 <li><a href="policy-guide/pg-task-selection-logic.html">APEX Site, task selection logic</a></li>
86 <li><a href="policy-guide/pg-logic-cheatsheet.html">APEX Site, logic cheatsheet</a></li>
87 <li><a href="docs-apex/html/HowTo-PolicyLogic.html">stand-alone HTML</a></li>
88 <li><a href="docs-apex/pdf/HowTo-PolicyLogic.pdf">stand-alone PDF</a></li>
89 </ul>
90 </td>
91 </tr>
92
93 </table>
94 </section>
95 </body>
96</document>