| ramverma | af74a62 | 2018-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 User Manual</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 User Manual"> |
| 26 | |
| 27 | <p> |
| 28 | The APEX user manual combines a set of guides and howto documents, all supporting the use of APEX. |
| 29 | The guides and 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 User Manual 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>User Manual</td> |
| 49 | <td> |
| 50 | The complete APEX User Manual, 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-User-Manual.html">stand-alone HTML</a></li> |
| 56 | <li><a href="docs-apex/pdf/APEX-User-Manual.pdf">stand-alone PDF</a></li> |
| 57 | </ul> |
| 58 | </td> |
| 59 | </tr> |
| 60 | <tr> |
| 61 | <td>Installation Guide</td> |
| 62 | <td> |
| 63 | The guide with all information on how to get an APEX distribution, install it, configure it, and verify an installation. |
| 64 | The guide describes automatic and manual installations on Unix, Windows, and Cygwin. |
| 65 | It also has a brief description on how to build APEX from source. |
| 66 | </td> |
| 67 | <td> |
| 68 | <ul> |
| 69 | <li><a href="user-manual/install/um-install.html">APEX Site</a></li> |
| 70 | <li><a href="docs-apex/html/APEX-Install-Guide.html">stand-alone HTML</a></li> |
| 71 | <li><a href="docs-apex/pdf/APEX-Install-Guide.pdf">stand-alone PDF</a></li> |
| 72 | </ul> |
| 73 | </td> |
| 74 | </tr> |
| 75 | <tr> |
| 76 | <td>HowTo: Configure the APEX Engine</td> |
| 77 | <td> |
| 78 | This HowTo document details all options for configuring an APEX engine. |
| 79 | </td> |
| 80 | <td> |
| 81 | <ul> |
| 82 | <li><a href="user-manual/configuration/um-00-introduction.html">APEX Site</a></li> |
| 83 | <li><a href="docs-apex/html/HowTo-Configuration.html">stand-alone HTML</a></li> |
| 84 | <li><a href="docs-apex/pdf/HowTo-Configuration.pdf">stand-alone PDF</a></li> |
| 85 | </ul> |
| 86 | </td> |
| 87 | </tr> |
| 88 | <tr> |
| 89 | <td>HowTo: Run the APEX engine and the provided applications</td> |
| 90 | <td> |
| 91 | This Howto details the different ways to run an APEX engine. |
| 92 | It also shows how the various provided applications (e.g. CLI Editor, REST Editor, WS clients) can be used. |
| 93 | </td> |
| 94 | <td> |
| 95 | <ul> |
| 96 | <li><a href="user-manual/engine-apps/um-engapps.html">APEX Site</a></li> |
| 97 | <li><a href="docs-apex/html/HowTo-APEX.html">stand-alone HTML</a></li> |
| 98 | <li><a href="docs-apex/pdf/HowTo-APEX.pdf">stand-alone PDF</a></li> |
| 99 | </ul> |
| 100 | </td> |
| 101 | </tr> |
| 102 | <tr> |
| 103 | <td>HowTo: My First Policy</td> |
| 104 | <td> |
| 105 | This HowTo is a step-by-step introduction on how to define a policy. |
| 106 | The document introduces a non-technical retail scenario and analyzes what requirements a policy will have. |
| 107 | Then it shows how a simple policy can be defined, includining all events (trigger and action). |
| 108 | It finished with an extension of this simple policy including some context information. |
| 109 | </td> |
| 110 | <td> |
| 111 | <ul> |
| 112 | <li><a href="user-manual/my-first-policy/um-mfp-01-introduction.html">APEX Site</a></li> |
| 113 | <li><a href="docs-apex/html/HowTo-MyFirstPolicy.html">stand-alone HTML</a></li> |
| 114 | <li><a href="docs-apex/pdf/HowTo-MyFirstPolicy.pdf">stand-alone PDF</a></li> |
| 115 | </ul> |
| 116 | </td> |
| 117 | </tr> |
| 118 | <tr> |
| 119 | <td>HowTo: Logging</td> |
| 120 | <td> |
| 121 | The APEX system uses SLF4j for logging with logback as backend. |
| 122 | This HowTo explains how the logging can be configured for a number of use cases. |
| 123 | </td> |
| 124 | <td> |
| 125 | <ul> |
| 126 | <li><a href="user-manual/logging/um-logging.html">APEX Site</a></li> |
| 127 | <li><a href="docs-apex/html/HowTo-Logging.html">stand-alone HTML</a></li> |
| 128 | <li><a href="docs-apex/pdf/HowTo-Logging.pdf">stand-alone PDF</a></li> |
| 129 | </ul> |
| 130 | </td> |
| 131 | </tr> |
| 132 | <tr> |
| 133 | <td>HowTo: APEX and Websockets as Carrier Technology</td> |
| 134 | <td> |
| 135 | This HowTo starts with a brief introduction into Websockets in general, including links to open source Java implementations. |
| 136 | Then it explains the different configuration options for an APEX engine when using Websockets. |
| 137 | It finishes with an example configuration using the simple Websocket clients (applications). |
| 138 | </td> |
| 139 | <td> |
| 140 | <ul> |
| 141 | <li><a href="user-manual/websockets/um-websocket-introduction.html">APEX Site</a></li> |
| 142 | <li><a href="docs-apex/html/HowTo-Websockets.html">stand-alone HTML</a></li> |
| 143 | <li><a href="docs-apex/pdf/HowTo-Websockets.pdf">stand-alone PDF</a></li> |
| 144 | </ul> |
| 145 | </td> |
| 146 | </tr> |
| 147 | </table> |
| 148 | </section> |
| 149 | </body> |
| 150 | </document> |