aboutsummaryrefslogtreecommitdiffstats
path: root/src/site/xdoc/developer-guide.xml
diff options
context:
space:
mode:
Diffstat (limited to 'src/site/xdoc/developer-guide.xml')
-rw-r--r--src/site/xdoc/developer-guide.xml93
1 files changed, 0 insertions, 93 deletions
diff --git a/src/site/xdoc/developer-guide.xml b/src/site/xdoc/developer-guide.xml
deleted file mode 100644
index 40e689739..000000000
--- a/src/site/xdoc/developer-guide.xml
+++ /dev/null
@@ -1,93 +0,0 @@
-<?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 Developer 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 Developer Guide">
-
- <p>
- The APEX developer guide combines a set of guides and howto documents, all addressing aspects for APEX developers.
- These documents look at APEX internals and how to extend build and extend the platform, and how to add applications.
- The guide and 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 User Manual 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>Developer Guide</td>
- <td>
- The complete APEX Developer 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-Developer-Guide.html">stand-alone HTML</a></li>
- <li><a href="docs-apex/pdf/APEX-Developer-Guide.pdf">stand-alone PDF</a></li>
- </ul>
- </td>
- </tr>
- <tr>
- <td>HowTo: Build APEX from source</td>
- <td>
- This HowTo details all variations to build APEX from the source code.
- Some of the options are: standard build with and without tests, build with all test, build with all components.
- The document also shows how to build the documentation and the APEX site.
- </td>
- <td>
- <ul>
- <li><a href="developer-guide/build/dg-build.html">APEX Site</a></li>
- <li><a href="docs-apex/html/HowTo-Build-APEX.html">stand-alone HTML</a></li>
- <li><a href="docs-apex/pdf/HowTo-Build-APEX.pdf">stand-alone PDF</a></li>
- </ul>
- </td>
- </tr>
- <tr>
- <td>HowTo: Codestyle and Automated Style Checks</td>
- <td>
- This HowTo defines the Java coding rules when developing for the APEX system and any of its components.
- It details how to install and configure required Eclipse plugins (JAutoDoc, Checkstyle) and how to run automated style checks.
- </td>
- <td>
- <ul>
- <li><a href="developer-guide/codestyle/dg-codestyle.html">APEX Site</a></li>
- <li><a href="docs-apex/html/HowTo-Codestyle.html">stand-alone HTML</a></li>
- <li><a href="docs-apex/pdf/HowTo-Codestyle.pdf">stand-alone PDF</a></li>
- </ul>
- </td>
- </tr>
- </table>
- </section>
- </body>
-</document>