From cfd849936ab0dba02df60c5a8509d83cb8c58fdb Mon Sep 17 00:00:00 2001 From: liamfallon Date: Mon, 13 Jul 2020 09:41:28 +0100 Subject: Remove old documentation from build apex-pdp had an in-line docuemntation build system built on asciidoc. It has proven to be very difficult to maintain and keep up to date and it is incompatible with the ONAP official RST/ReadTheDocs docuementation system. In the Dublin release, we converted the asciidoc documentation to RST format, and hae been updating the RST documentation since. The asciidoc docuemntation system is now so out of date that it is being removed. In this change, the "site" directory is removed from all modules in apex-pdp and a profile called "apexSite" is removed from the pom.xml file in all modules. Issue-ID: POLICY-2686 Change-Id: I645f3ed101159d356cd90e619cef791067ad5eb5 Signed-off-by: liamfallon --- src/site/xdoc/user-manual.xml | 150 ------------------------------------------ 1 file changed, 150 deletions(-) delete mode 100644 src/site/xdoc/user-manual.xml (limited to 'src/site/xdoc/user-manual.xml') diff --git a/src/site/xdoc/user-manual.xml b/src/site/xdoc/user-manual.xml deleted file mode 100644 index 2b34610ff..000000000 --- a/src/site/xdoc/user-manual.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - The APEX User Manual - Sven van der Meer - Liam Fallon - John Keeny - - - -
- -

- The APEX user manual combines a set of guides and howto documents, all supporting the use of APEX. - The guides and howto documents are provided as integrated documentation in the APEX site. - Furthermore, we provide stand-alone documents in HTML and PDF. -

- -

- 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. -

- -

APEX User Manual documentation

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionLinks
User Manual - The complete APEX User Manual, including all HowTos and other documentation. - The stand-alone versions aggregate all other documents listed in this table. - - -
Installation Guide - The guide with all information on how to get an APEX distribution, install it, configure it, and verify an installation. - The guide describes automatic and manual installations on Unix, Windows, and Cygwin. - It also has a brief description on how to build APEX from source. - - -
HowTo: Configure the APEX Engine - This HowTo document details all options for configuring an APEX engine. - - -
HowTo: Run the APEX engine and the provided applications - This Howto details the different ways to run an APEX engine. - It also shows how the various provided applications (e.g. CLI Editor, REST Editor, WS clients) can be used. - - -
HowTo: My First Policy - This HowTo is a step-by-step introduction on how to define a policy. - The document introduces a non-technical retail scenario and analyzes what requirements a policy will have. - Then it shows how a simple policy can be defined, includining all events (trigger and action). - It finished with an extension of this simple policy including some context information. - - -
HowTo: Logging - The APEX system uses SLF4j for logging with logback as backend. - This HowTo explains how the logging can be configured for a number of use cases. - - -
HowTo: APEX and Websockets as Carrier Technology - This HowTo starts with a brief introduction into Websockets in general, including links to open source Java implementations. - Then it explains the different configuration options for an APEX engine when using Websockets. - It finishes with an example configuration using the simple Websocket clients (applications). - - -
-
- - \ No newline at end of file -- cgit 1.2.3-korg