From af74a6270d6ab6badf04a97495a6ef8ccded9b4b Mon Sep 17 00:00:00 2001 From: ramverma Date: Tue, 31 Jul 2018 18:25:39 +0100 Subject: 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 --- .../apex-intro/intro-configuration-matrix.adoc | 14 ++ .../asciidoc/apex-intro/intro-introduction.adoc | 14 ++ .../asciidoc/apex-intro/intro-policy-matrix.adoc | 14 ++ src/site/asciidoc/apex-intro/intro-resources.adoc | 14 ++ .../asciidoc/apex-intro/intro-upee-clustering.adoc | 14 ++ .../asciidoc/apex-intro/intro-upee-deployment.adoc | 14 ++ src/site/asciidoc/apex-publications.adoc | 45 ++++ .../developer-guide/build/dg-build-checkstyle.adoc | 14 ++ .../build/dg-build-documentation.adoc | 14 ++ .../developer-guide/build/dg-build-site.adoc | 14 ++ .../developer-guide/build/dg-build-standard.adoc | 14 ++ .../build/dg-build-with-all-components.adoc | 14 ++ .../build/dg-build-with-all-tests.adoc | 14 ++ .../developer-guide/build/dg-build-with-tests.adoc | 14 ++ .../asciidoc/developer-guide/build/dg-build.adoc | 14 ++ .../codestyle/dg-codestyle-02-rules.adoc | 14 ++ .../codestyle/dg-codestyle-10-plugin-jautodoc.adoc | 14 ++ .../dg-codestyle-11-plugin-checkstyle.adoc | 14 ++ ...g-codestyle-20-configure-eclipse-templates.adoc | 14 ++ ...-codestyle-21-configure-jautodoc-templates.adoc | 14 ++ ...dg-codestyle-30-configure-checkstyle-maven.adoc | 14 ++ .../dg-codestyle-31-run-checkstyle-maven.adoc | 14 ++ ...-codestyle-32-configure-checkstyle-eclipse.adoc | 14 ++ ...odestyle-33-configure-checkstyle-blueprint.adoc | 14 ++ ...codestyle-40-use-eclipse-source-operations.adoc | 14 ++ .../codestyle/dg-codestyle-41-using-jautodoc.adoc | 14 ++ .../dg-codestyle-42-using-checkstyle.adoc | 14 ++ ...dg-codestyle-50-disable-eclispe-formatting.adoc | 14 ++ .../dg-codestyle-51-supress-checkstyle.adoc | 14 ++ .../developer-guide/codestyle/dg-codestyle.adoc | 14 ++ .../asciidoc/developer-guide/dg-code-examples.adoc | 18 ++ .../asciidoc/policy-guide/pg-logic-cheatsheet.adoc | 14 ++ .../asciidoc/policy-guide/pg-policy-examples.adoc | 16 ++ .../asciidoc/policy-guide/pg-policy-matrix.adoc | 14 ++ src/site/asciidoc/policy-guide/pg-task-logic.adoc | 14 ++ .../policy-guide/pg-task-selection-logic.adoc | 14 ++ .../policy-model/apm-concept-contextitem.adoc | 14 ++ .../apm-concept-contextitemtemplate.adoc | 14 ++ .../policy-model/apm-concept-contextmap.adoc | 14 ++ .../policy-model/apm-concept-datatype.adoc | 14 ++ .../policy-model/apm-concept-event.adoc | 14 ++ .../policy-model/apm-concept-eventfield.adoc | 14 ++ .../policy-model/apm-concept-logic.adoc | 14 ++ .../policy-model/apm-concept-policy.adoc | 14 ++ .../policy-model/apm-concept-policymodel.adoc | 14 ++ .../policy-model/apm-concept-state.adoc | 14 ++ .../policy-model/apm-concept-task.adoc | 14 ++ .../policy-model/apm-concept-taskparameter.adoc | 14 ++ .../policy-model/apm-concepts-keys.adoc | 14 ++ .../policy-model/apm-introduction.adoc | 14 ++ .../configuration/um-00-introduction.adoc | 14 ++ .../configuration/um-01-config-general-format.adoc | 14 ++ .../um-02-config-service-parameters.adoc | 14 ++ .../um-03-config-interfaces-general.adoc | 14 ++ .../user-manual/configuration/um-04-executors.adoc | 24 ++ .../user-manual/configuration/um-05-context.adoc | 16 ++ .../configuration/um-06-carriertech.adoc | 32 +++ .../configuration/um-07-eventprotols.adoc | 24 ++ .../configuration/um-99-config-example.adoc | 14 ++ .../engine-apps/um-engapps-app-model-2-cli.adoc | 14 ++ .../engine-apps/um-engapps-app-tpl-event-json.adoc | 14 ++ .../user-manual/engine-apps/um-engapps-app-ws.adoc | 14 ++ .../um-engapps-application-launcher.adoc | 14 ++ .../engine-apps/um-engapps-cli-editor.adoc | 14 ++ .../engine-apps/um-engapps-eng-deployment.adoc | 14 ++ .../engine-apps/um-engapps-eng-monitoring.adoc | 14 ++ .../user-manual/engine-apps/um-engapps-engine.adoc | 14 ++ .../engine-apps/um-engapps-full-client.adoc | 14 ++ .../engine-apps/um-engapps-rest-editor.adoc | 14 ++ .../user-manual/engine-apps/um-engapps.adoc | 14 ++ .../user-manual/install/um-install-build-apex.adoc | 14 ++ .../user-manual/install/um-install-configure.adoc | 14 ++ .../user-manual/install/um-install-docker.adoc | 14 ++ .../user-manual/install/um-install-get-source.adoc | 14 ++ .../user-manual/install/um-install-install.adoc | 14 ++ .../user-manual/install/um-install-layout.adoc | 14 ++ .../user-manual/install/um-install-monitoring.adoc | 14 ++ .../user-manual/install/um-install-resteditor.adoc | 14 ++ .../user-manual/install/um-install-verify.adoc | 14 ++ .../asciidoc/user-manual/install/um-install.adoc | 14 ++ .../logging/um-logging-example-logic.adoc | 14 ++ .../logging/um-logging-example-server.adoc | 14 ++ .../logging/um-logging-logback-status.adoc | 14 ++ .../logging/um-logging-logging-3pps.adoc | 14 ++ .../logging/um-logging-logging-policy-logic.adoc | 14 ++ .../logging/um-logging-rolling-file-appenders.adoc | 14 ++ .../logging/um-logging-standard-configuration.adoc | 14 ++ .../asciidoc/user-manual/logging/um-logging.adoc | 14 ++ .../my-first-policy/um-mfp-01-introduction.adoc | 16 ++ .../my-first-policy/um-mfp-02-data-models.adoc | 14 ++ .../my-first-policy/um-mfp-03-policy-step1.adoc | 14 ++ .../my-first-policy/um-mfp-031-s1-new-model.adoc | 14 ++ .../my-first-policy/um-mfp-032-s1-new-events.adoc | 14 ++ .../my-first-policy/um-mfp-033-s1-new-policy.adoc | 14 ++ .../my-first-policy/um-mfp-034-s1-test-policy.adoc | 14 ++ .../my-first-policy/um-mfp-035-s1-clieditor.adoc | 14 ++ .../my-first-policy/um-mfp-04-policy-step2.adoc | 14 ++ .../um-mfp-041-s2-extend-model.adoc | 14 ++ .../my-first-policy/um-mfp-042-s2-test-policy.adoc | 14 ++ .../my-first-policy/um-mfp-043-s2-clieditor.adoc | 14 ++ .../websockets/um-websocket-demo-00.adoc | 14 ++ .../um-websocket-demo-01-vpn-wsconfig.adoc | 14 ++ .../um-websocket-demo-02-start-engine.adoc | 14 ++ .../um-websocket-demo-03-start-echo-client.adoc | 14 ++ .../um-websocket-demo-04-start-console-client.adoc | 14 ++ .../um-websocket-demo-05-send-events.adoc | 14 ++ .../websockets/um-websocket-engine-config.adoc | 14 ++ .../websockets/um-websocket-introduction.adoc | 21 ++ src/site/css/site.css | 100 ++++++++ src/site/images/logos.png | Bin 0 -> 162383 bytes src/site/site.xml | 226 +++++++++++++++++ src/site/xdoc/developer-guide.xml | 93 +++++++ src/site/xdoc/index.xml | 280 +++++++++++++++++++++ src/site/xdoc/policy-guide.xml | 96 +++++++ src/site/xdoc/user-manual.xml | 150 +++++++++++ 115 files changed, 2543 insertions(+) create mode 100644 src/site/asciidoc/apex-intro/intro-configuration-matrix.adoc create mode 100644 src/site/asciidoc/apex-intro/intro-introduction.adoc create mode 100644 src/site/asciidoc/apex-intro/intro-policy-matrix.adoc create mode 100644 src/site/asciidoc/apex-intro/intro-resources.adoc create mode 100644 src/site/asciidoc/apex-intro/intro-upee-clustering.adoc create mode 100644 src/site/asciidoc/apex-intro/intro-upee-deployment.adoc create mode 100644 src/site/asciidoc/apex-publications.adoc create mode 100644 src/site/asciidoc/developer-guide/build/dg-build-checkstyle.adoc create mode 100644 src/site/asciidoc/developer-guide/build/dg-build-documentation.adoc create mode 100644 src/site/asciidoc/developer-guide/build/dg-build-site.adoc create mode 100644 src/site/asciidoc/developer-guide/build/dg-build-standard.adoc create mode 100644 src/site/asciidoc/developer-guide/build/dg-build-with-all-components.adoc create mode 100644 src/site/asciidoc/developer-guide/build/dg-build-with-all-tests.adoc create mode 100644 src/site/asciidoc/developer-guide/build/dg-build-with-tests.adoc create mode 100644 src/site/asciidoc/developer-guide/build/dg-build.adoc create mode 100644 src/site/asciidoc/developer-guide/codestyle/dg-codestyle-02-rules.adoc create mode 100644 src/site/asciidoc/developer-guide/codestyle/dg-codestyle-10-plugin-jautodoc.adoc create mode 100644 src/site/asciidoc/developer-guide/codestyle/dg-codestyle-11-plugin-checkstyle.adoc create mode 100644 src/site/asciidoc/developer-guide/codestyle/dg-codestyle-20-configure-eclipse-templates.adoc create mode 100644 src/site/asciidoc/developer-guide/codestyle/dg-codestyle-21-configure-jautodoc-templates.adoc create mode 100644 src/site/asciidoc/developer-guide/codestyle/dg-codestyle-30-configure-checkstyle-maven.adoc create mode 100644 src/site/asciidoc/developer-guide/codestyle/dg-codestyle-31-run-checkstyle-maven.adoc create mode 100644 src/site/asciidoc/developer-guide/codestyle/dg-codestyle-32-configure-checkstyle-eclipse.adoc create mode 100644 src/site/asciidoc/developer-guide/codestyle/dg-codestyle-33-configure-checkstyle-blueprint.adoc create mode 100644 src/site/asciidoc/developer-guide/codestyle/dg-codestyle-40-use-eclipse-source-operations.adoc create mode 100644 src/site/asciidoc/developer-guide/codestyle/dg-codestyle-41-using-jautodoc.adoc create mode 100644 src/site/asciidoc/developer-guide/codestyle/dg-codestyle-42-using-checkstyle.adoc create mode 100644 src/site/asciidoc/developer-guide/codestyle/dg-codestyle-50-disable-eclispe-formatting.adoc create mode 100644 src/site/asciidoc/developer-guide/codestyle/dg-codestyle-51-supress-checkstyle.adoc create mode 100644 src/site/asciidoc/developer-guide/codestyle/dg-codestyle.adoc create mode 100644 src/site/asciidoc/developer-guide/dg-code-examples.adoc create mode 100644 src/site/asciidoc/policy-guide/pg-logic-cheatsheet.adoc create mode 100644 src/site/asciidoc/policy-guide/pg-policy-examples.adoc create mode 100644 src/site/asciidoc/policy-guide/pg-policy-matrix.adoc create mode 100644 src/site/asciidoc/policy-guide/pg-task-logic.adoc create mode 100644 src/site/asciidoc/policy-guide/pg-task-selection-logic.adoc create mode 100644 src/site/asciidoc/policy-guide/policy-model/apm-concept-contextitem.adoc create mode 100644 src/site/asciidoc/policy-guide/policy-model/apm-concept-contextitemtemplate.adoc create mode 100644 src/site/asciidoc/policy-guide/policy-model/apm-concept-contextmap.adoc create mode 100644 src/site/asciidoc/policy-guide/policy-model/apm-concept-datatype.adoc create mode 100644 src/site/asciidoc/policy-guide/policy-model/apm-concept-event.adoc create mode 100644 src/site/asciidoc/policy-guide/policy-model/apm-concept-eventfield.adoc create mode 100644 src/site/asciidoc/policy-guide/policy-model/apm-concept-logic.adoc create mode 100644 src/site/asciidoc/policy-guide/policy-model/apm-concept-policy.adoc create mode 100644 src/site/asciidoc/policy-guide/policy-model/apm-concept-policymodel.adoc create mode 100644 src/site/asciidoc/policy-guide/policy-model/apm-concept-state.adoc create mode 100644 src/site/asciidoc/policy-guide/policy-model/apm-concept-task.adoc create mode 100644 src/site/asciidoc/policy-guide/policy-model/apm-concept-taskparameter.adoc create mode 100644 src/site/asciidoc/policy-guide/policy-model/apm-concepts-keys.adoc create mode 100644 src/site/asciidoc/policy-guide/policy-model/apm-introduction.adoc create mode 100644 src/site/asciidoc/user-manual/configuration/um-00-introduction.adoc create mode 100644 src/site/asciidoc/user-manual/configuration/um-01-config-general-format.adoc create mode 100644 src/site/asciidoc/user-manual/configuration/um-02-config-service-parameters.adoc create mode 100644 src/site/asciidoc/user-manual/configuration/um-03-config-interfaces-general.adoc create mode 100644 src/site/asciidoc/user-manual/configuration/um-04-executors.adoc create mode 100644 src/site/asciidoc/user-manual/configuration/um-05-context.adoc create mode 100644 src/site/asciidoc/user-manual/configuration/um-06-carriertech.adoc create mode 100644 src/site/asciidoc/user-manual/configuration/um-07-eventprotols.adoc create mode 100644 src/site/asciidoc/user-manual/configuration/um-99-config-example.adoc create mode 100644 src/site/asciidoc/user-manual/engine-apps/um-engapps-app-model-2-cli.adoc create mode 100644 src/site/asciidoc/user-manual/engine-apps/um-engapps-app-tpl-event-json.adoc create mode 100644 src/site/asciidoc/user-manual/engine-apps/um-engapps-app-ws.adoc create mode 100644 src/site/asciidoc/user-manual/engine-apps/um-engapps-application-launcher.adoc create mode 100644 src/site/asciidoc/user-manual/engine-apps/um-engapps-cli-editor.adoc create mode 100644 src/site/asciidoc/user-manual/engine-apps/um-engapps-eng-deployment.adoc create mode 100644 src/site/asciidoc/user-manual/engine-apps/um-engapps-eng-monitoring.adoc create mode 100644 src/site/asciidoc/user-manual/engine-apps/um-engapps-engine.adoc create mode 100644 src/site/asciidoc/user-manual/engine-apps/um-engapps-full-client.adoc create mode 100644 src/site/asciidoc/user-manual/engine-apps/um-engapps-rest-editor.adoc create mode 100644 src/site/asciidoc/user-manual/engine-apps/um-engapps.adoc create mode 100644 src/site/asciidoc/user-manual/install/um-install-build-apex.adoc create mode 100644 src/site/asciidoc/user-manual/install/um-install-configure.adoc create mode 100644 src/site/asciidoc/user-manual/install/um-install-docker.adoc create mode 100644 src/site/asciidoc/user-manual/install/um-install-get-source.adoc create mode 100644 src/site/asciidoc/user-manual/install/um-install-install.adoc create mode 100644 src/site/asciidoc/user-manual/install/um-install-layout.adoc create mode 100644 src/site/asciidoc/user-manual/install/um-install-monitoring.adoc create mode 100644 src/site/asciidoc/user-manual/install/um-install-resteditor.adoc create mode 100644 src/site/asciidoc/user-manual/install/um-install-verify.adoc create mode 100644 src/site/asciidoc/user-manual/install/um-install.adoc create mode 100644 src/site/asciidoc/user-manual/logging/um-logging-example-logic.adoc create mode 100644 src/site/asciidoc/user-manual/logging/um-logging-example-server.adoc create mode 100644 src/site/asciidoc/user-manual/logging/um-logging-logback-status.adoc create mode 100644 src/site/asciidoc/user-manual/logging/um-logging-logging-3pps.adoc create mode 100644 src/site/asciidoc/user-manual/logging/um-logging-logging-policy-logic.adoc create mode 100644 src/site/asciidoc/user-manual/logging/um-logging-rolling-file-appenders.adoc create mode 100644 src/site/asciidoc/user-manual/logging/um-logging-standard-configuration.adoc create mode 100644 src/site/asciidoc/user-manual/logging/um-logging.adoc create mode 100644 src/site/asciidoc/user-manual/my-first-policy/um-mfp-01-introduction.adoc create mode 100644 src/site/asciidoc/user-manual/my-first-policy/um-mfp-02-data-models.adoc create mode 100644 src/site/asciidoc/user-manual/my-first-policy/um-mfp-03-policy-step1.adoc create mode 100644 src/site/asciidoc/user-manual/my-first-policy/um-mfp-031-s1-new-model.adoc create mode 100644 src/site/asciidoc/user-manual/my-first-policy/um-mfp-032-s1-new-events.adoc create mode 100644 src/site/asciidoc/user-manual/my-first-policy/um-mfp-033-s1-new-policy.adoc create mode 100644 src/site/asciidoc/user-manual/my-first-policy/um-mfp-034-s1-test-policy.adoc create mode 100644 src/site/asciidoc/user-manual/my-first-policy/um-mfp-035-s1-clieditor.adoc create mode 100644 src/site/asciidoc/user-manual/my-first-policy/um-mfp-04-policy-step2.adoc create mode 100644 src/site/asciidoc/user-manual/my-first-policy/um-mfp-041-s2-extend-model.adoc create mode 100644 src/site/asciidoc/user-manual/my-first-policy/um-mfp-042-s2-test-policy.adoc create mode 100644 src/site/asciidoc/user-manual/my-first-policy/um-mfp-043-s2-clieditor.adoc create mode 100644 src/site/asciidoc/user-manual/websockets/um-websocket-demo-00.adoc create mode 100644 src/site/asciidoc/user-manual/websockets/um-websocket-demo-01-vpn-wsconfig.adoc create mode 100644 src/site/asciidoc/user-manual/websockets/um-websocket-demo-02-start-engine.adoc create mode 100644 src/site/asciidoc/user-manual/websockets/um-websocket-demo-03-start-echo-client.adoc create mode 100644 src/site/asciidoc/user-manual/websockets/um-websocket-demo-04-start-console-client.adoc create mode 100644 src/site/asciidoc/user-manual/websockets/um-websocket-demo-05-send-events.adoc create mode 100644 src/site/asciidoc/user-manual/websockets/um-websocket-engine-config.adoc create mode 100644 src/site/asciidoc/user-manual/websockets/um-websocket-introduction.adoc create mode 100644 src/site/css/site.css create mode 100644 src/site/images/logos.png create mode 100644 src/site/site.xml create mode 100644 src/site/xdoc/developer-guide.xml create mode 100644 src/site/xdoc/index.xml create mode 100644 src/site/xdoc/policy-guide.xml create mode 100644 src/site/xdoc/user-manual.xml (limited to 'src/site') diff --git a/src/site/asciidoc/apex-intro/intro-configuration-matrix.adoc b/src/site/asciidoc/apex-intro/intro-configuration-matrix.adoc new file mode 100644 index 000000000..fad04941f --- /dev/null +++ b/src/site/asciidoc/apex-intro/intro-configuration-matrix.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-intro/configuration-matrix.adoc[] diff --git a/src/site/asciidoc/apex-intro/intro-introduction.adoc b/src/site/asciidoc/apex-intro/intro-introduction.adoc new file mode 100644 index 000000000..95219bb72 --- /dev/null +++ b/src/site/asciidoc/apex-intro/intro-introduction.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-intro/introduction.adoc[] diff --git a/src/site/asciidoc/apex-intro/intro-policy-matrix.adoc b/src/site/asciidoc/apex-intro/intro-policy-matrix.adoc new file mode 100644 index 000000000..1e8510f2e --- /dev/null +++ b/src/site/asciidoc/apex-intro/intro-policy-matrix.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-intro/policy-matrix.adoc[] diff --git a/src/site/asciidoc/apex-intro/intro-resources.adoc b/src/site/asciidoc/apex-intro/intro-resources.adoc new file mode 100644 index 000000000..37405a3ef --- /dev/null +++ b/src/site/asciidoc/apex-intro/intro-resources.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-intro/resources.adoc[] diff --git a/src/site/asciidoc/apex-intro/intro-upee-clustering.adoc b/src/site/asciidoc/apex-intro/intro-upee-clustering.adoc new file mode 100644 index 000000000..c239cdf6a --- /dev/null +++ b/src/site/asciidoc/apex-intro/intro-upee-clustering.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-intro/upee-clustering.adoc[] diff --git a/src/site/asciidoc/apex-intro/intro-upee-deployment.adoc b/src/site/asciidoc/apex-intro/intro-upee-deployment.adoc new file mode 100644 index 000000000..c3abf4845 --- /dev/null +++ b/src/site/asciidoc/apex-intro/intro-upee-deployment.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-intro/upee-deployment.adoc[] diff --git a/src/site/asciidoc/apex-publications.adoc b/src/site/asciidoc/apex-publications.adoc new file mode 100644 index 000000000..dbf5ce8eb --- /dev/null +++ b/src/site/asciidoc/apex-publications.adoc @@ -0,0 +1,45 @@ +// +// ============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) +// + +== APEX Publications + +include::{adsite-main-dir}/site-docs/adoc/fragments/reference-publications/apex.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/reference-publications/cnsm-2015.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/reference-publications/noms-2016.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/reference-publications/im-2017a.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/reference-publications/im-2017b.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/reference-publications/noms-2018a.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/reference-publications/noms-2018c.adoc[leveloffset=+1] + + + +include::{adsite-main-dir}/site-docs/adoc/fragments/reference-publications/policy-general.adoc[] + +include::{adsite-main-dir}/site-docs/adoc/fragments/reference-publications/monami-2012.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/reference-publications/im-2013.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/reference-publications/monami-2013.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/reference-publications/cnsm-2014.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/reference-publications/5g-2015.adoc[leveloffset=+1] + +include::{adsite-main-dir}/site-docs/adoc/fragments/reference-publications/noms-2018b.adoc[leveloffset=+1] + diff --git a/src/site/asciidoc/developer-guide/build/dg-build-checkstyle.adoc b/src/site/asciidoc/developer-guide/build/dg-build-checkstyle.adoc new file mode 100644 index 000000000..9fb2741e5 --- /dev/null +++ b/src/site/asciidoc/developer-guide/build/dg-build-checkstyle.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-build/checkstyle.adoc[] diff --git a/src/site/asciidoc/developer-guide/build/dg-build-documentation.adoc b/src/site/asciidoc/developer-guide/build/dg-build-documentation.adoc new file mode 100644 index 000000000..0a5b3f4b5 --- /dev/null +++ b/src/site/asciidoc/developer-guide/build/dg-build-documentation.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-build/documentation.adoc[] diff --git a/src/site/asciidoc/developer-guide/build/dg-build-site.adoc b/src/site/asciidoc/developer-guide/build/dg-build-site.adoc new file mode 100644 index 000000000..727811cea --- /dev/null +++ b/src/site/asciidoc/developer-guide/build/dg-build-site.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-build/site.adoc[] diff --git a/src/site/asciidoc/developer-guide/build/dg-build-standard.adoc b/src/site/asciidoc/developer-guide/build/dg-build-standard.adoc new file mode 100644 index 000000000..1d08e71ab --- /dev/null +++ b/src/site/asciidoc/developer-guide/build/dg-build-standard.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-build/standard.adoc[] diff --git a/src/site/asciidoc/developer-guide/build/dg-build-with-all-components.adoc b/src/site/asciidoc/developer-guide/build/dg-build-with-all-components.adoc new file mode 100644 index 000000000..57ec22156 --- /dev/null +++ b/src/site/asciidoc/developer-guide/build/dg-build-with-all-components.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-build/with-all-components.adoc[] diff --git a/src/site/asciidoc/developer-guide/build/dg-build-with-all-tests.adoc b/src/site/asciidoc/developer-guide/build/dg-build-with-all-tests.adoc new file mode 100644 index 000000000..1bab557cd --- /dev/null +++ b/src/site/asciidoc/developer-guide/build/dg-build-with-all-tests.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-build/with-all-tests.adoc[] diff --git a/src/site/asciidoc/developer-guide/build/dg-build-with-tests.adoc b/src/site/asciidoc/developer-guide/build/dg-build-with-tests.adoc new file mode 100644 index 000000000..3f11e99b0 --- /dev/null +++ b/src/site/asciidoc/developer-guide/build/dg-build-with-tests.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-build/with-tests.adoc[] diff --git a/src/site/asciidoc/developer-guide/build/dg-build.adoc b/src/site/asciidoc/developer-guide/build/dg-build.adoc new file mode 100644 index 000000000..fcc48e9db --- /dev/null +++ b/src/site/asciidoc/developer-guide/build/dg-build.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-build/introduction.adoc[] diff --git a/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-02-rules.adoc b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-02-rules.adoc new file mode 100644 index 000000000..85ee11074 --- /dev/null +++ b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-02-rules.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/02-rules.adoc[] diff --git a/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-10-plugin-jautodoc.adoc b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-10-plugin-jautodoc.adoc new file mode 100644 index 000000000..2c4f691e0 --- /dev/null +++ b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-10-plugin-jautodoc.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/10-plugin-jautodoc.adoc[] diff --git a/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-11-plugin-checkstyle.adoc b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-11-plugin-checkstyle.adoc new file mode 100644 index 000000000..2cafd21e0 --- /dev/null +++ b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-11-plugin-checkstyle.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/11-plugin-checkstyle.adoc[] diff --git a/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-20-configure-eclipse-templates.adoc b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-20-configure-eclipse-templates.adoc new file mode 100644 index 000000000..c6ec70ac7 --- /dev/null +++ b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-20-configure-eclipse-templates.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/20-configure-eclipse-templates.adoc[] diff --git a/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-21-configure-jautodoc-templates.adoc b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-21-configure-jautodoc-templates.adoc new file mode 100644 index 000000000..b829d0d1f --- /dev/null +++ b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-21-configure-jautodoc-templates.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/21-configure-jautodoc-templates.adoc[] diff --git a/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-30-configure-checkstyle-maven.adoc b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-30-configure-checkstyle-maven.adoc new file mode 100644 index 000000000..52dbd2fd8 --- /dev/null +++ b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-30-configure-checkstyle-maven.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/30-configure-checkstyle-maven.adoc[] diff --git a/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-31-run-checkstyle-maven.adoc b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-31-run-checkstyle-maven.adoc new file mode 100644 index 000000000..0ed5772c8 --- /dev/null +++ b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-31-run-checkstyle-maven.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/31-run-checkstyle-maven.adoc[] diff --git a/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-32-configure-checkstyle-eclipse.adoc b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-32-configure-checkstyle-eclipse.adoc new file mode 100644 index 000000000..86cf187fa --- /dev/null +++ b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-32-configure-checkstyle-eclipse.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/32-configure-checkstyle-eclipse.adoc[] diff --git a/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-33-configure-checkstyle-blueprint.adoc b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-33-configure-checkstyle-blueprint.adoc new file mode 100644 index 000000000..b849963d3 --- /dev/null +++ b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-33-configure-checkstyle-blueprint.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/33-configure-checkstyle-blueprint.adoc[] diff --git a/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-40-use-eclipse-source-operations.adoc b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-40-use-eclipse-source-operations.adoc new file mode 100644 index 000000000..5bb23b0cb --- /dev/null +++ b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-40-use-eclipse-source-operations.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/40-use-eclipse-source-operations.adoc[] diff --git a/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-41-using-jautodoc.adoc b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-41-using-jautodoc.adoc new file mode 100644 index 000000000..1ad1e69bc --- /dev/null +++ b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-41-using-jautodoc.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/41-using-jautodoc.adoc[] diff --git a/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-42-using-checkstyle.adoc b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-42-using-checkstyle.adoc new file mode 100644 index 000000000..a22ab99ef --- /dev/null +++ b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-42-using-checkstyle.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/42-using-checkstyle.adoc[] diff --git a/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-50-disable-eclispe-formatting.adoc b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-50-disable-eclispe-formatting.adoc new file mode 100644 index 000000000..5320969c0 --- /dev/null +++ b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-50-disable-eclispe-formatting.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/50-disable-eclispe-formatting.adoc[] diff --git a/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-51-supress-checkstyle.adoc b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-51-supress-checkstyle.adoc new file mode 100644 index 000000000..ec1f1ce1c --- /dev/null +++ b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle-51-supress-checkstyle.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/51-supress-checkstyle.adoc[] diff --git a/src/site/asciidoc/developer-guide/codestyle/dg-codestyle.adoc b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle.adoc new file mode 100644 index 000000000..eb0d982cf --- /dev/null +++ b/src/site/asciidoc/developer-guide/codestyle/dg-codestyle.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-codestyle/01-introduction.adoc[] diff --git a/src/site/asciidoc/developer-guide/dg-code-examples.adoc b/src/site/asciidoc/developer-guide/dg-code-examples.adoc new file mode 100644 index 000000000..b14fe02fd --- /dev/null +++ b/src/site/asciidoc/developer-guide/dg-code-examples.adoc @@ -0,0 +1,18 @@ +// +// ============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) +// + +== Code Examples + +- APEX Applications (apex-apps) + ** Utilities: link:../modules/tools/tools-common/example-cli.html[CLI Options and Parser Example] + ** Utilities: link:../modules/tools/tools-common/example-cli-version.html[Autoversion for Applications Example] diff --git a/src/site/asciidoc/policy-guide/pg-logic-cheatsheet.adoc b/src/site/asciidoc/policy-guide/pg-logic-cheatsheet.adoc new file mode 100644 index 000000000..c2053e15e --- /dev/null +++ b/src/site/asciidoc/policy-guide/pg-logic-cheatsheet.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-write-logic/logic-cheatsheet.adoc[] diff --git a/src/site/asciidoc/policy-guide/pg-policy-examples.adoc b/src/site/asciidoc/policy-guide/pg-policy-examples.adoc new file mode 100644 index 000000000..ec357b270 --- /dev/null +++ b/src/site/asciidoc/policy-guide/pg-policy-examples.adoc @@ -0,0 +1,16 @@ +// +// ============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) +// + +== Policy Examples + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-write-logic/policy-examples.adoc[] diff --git a/src/site/asciidoc/policy-guide/pg-policy-matrix.adoc b/src/site/asciidoc/policy-guide/pg-policy-matrix.adoc new file mode 100644 index 000000000..1e8510f2e --- /dev/null +++ b/src/site/asciidoc/policy-guide/pg-policy-matrix.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-intro/policy-matrix.adoc[] diff --git a/src/site/asciidoc/policy-guide/pg-task-logic.adoc b/src/site/asciidoc/policy-guide/pg-task-logic.adoc new file mode 100644 index 000000000..46c568c6c --- /dev/null +++ b/src/site/asciidoc/policy-guide/pg-task-logic.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-write-logic/task-logic.adoc[] diff --git a/src/site/asciidoc/policy-guide/pg-task-selection-logic.adoc b/src/site/asciidoc/policy-guide/pg-task-selection-logic.adoc new file mode 100644 index 000000000..582229a2c --- /dev/null +++ b/src/site/asciidoc/policy-guide/pg-task-selection-logic.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-write-logic/task-selection-logic.adoc[] diff --git a/src/site/asciidoc/policy-guide/policy-model/apm-concept-contextitem.adoc b/src/site/asciidoc/policy-guide/policy-model/apm-concept-contextitem.adoc new file mode 100644 index 000000000..56a84ec3f --- /dev/null +++ b/src/site/asciidoc/policy-guide/policy-model/apm-concept-contextitem.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concept-contextitem.adoc[] diff --git a/src/site/asciidoc/policy-guide/policy-model/apm-concept-contextitemtemplate.adoc b/src/site/asciidoc/policy-guide/policy-model/apm-concept-contextitemtemplate.adoc new file mode 100644 index 000000000..9b010fbb1 --- /dev/null +++ b/src/site/asciidoc/policy-guide/policy-model/apm-concept-contextitemtemplate.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concept-contextitemtemplate.adoc[] diff --git a/src/site/asciidoc/policy-guide/policy-model/apm-concept-contextmap.adoc b/src/site/asciidoc/policy-guide/policy-model/apm-concept-contextmap.adoc new file mode 100644 index 000000000..656cb63c3 --- /dev/null +++ b/src/site/asciidoc/policy-guide/policy-model/apm-concept-contextmap.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concept-contextmap.adoc[] diff --git a/src/site/asciidoc/policy-guide/policy-model/apm-concept-datatype.adoc b/src/site/asciidoc/policy-guide/policy-model/apm-concept-datatype.adoc new file mode 100644 index 000000000..b687a7251 --- /dev/null +++ b/src/site/asciidoc/policy-guide/policy-model/apm-concept-datatype.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concept-datatype.adoc[] diff --git a/src/site/asciidoc/policy-guide/policy-model/apm-concept-event.adoc b/src/site/asciidoc/policy-guide/policy-model/apm-concept-event.adoc new file mode 100644 index 000000000..0cb2cf88f --- /dev/null +++ b/src/site/asciidoc/policy-guide/policy-model/apm-concept-event.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concept-event.adoc[] diff --git a/src/site/asciidoc/policy-guide/policy-model/apm-concept-eventfield.adoc b/src/site/asciidoc/policy-guide/policy-model/apm-concept-eventfield.adoc new file mode 100644 index 000000000..76ffc11a7 --- /dev/null +++ b/src/site/asciidoc/policy-guide/policy-model/apm-concept-eventfield.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concept-eventfield.adoc[] diff --git a/src/site/asciidoc/policy-guide/policy-model/apm-concept-logic.adoc b/src/site/asciidoc/policy-guide/policy-model/apm-concept-logic.adoc new file mode 100644 index 000000000..d96414861 --- /dev/null +++ b/src/site/asciidoc/policy-guide/policy-model/apm-concept-logic.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concept-logic.adoc[] diff --git a/src/site/asciidoc/policy-guide/policy-model/apm-concept-policy.adoc b/src/site/asciidoc/policy-guide/policy-model/apm-concept-policy.adoc new file mode 100644 index 000000000..a10a361ea --- /dev/null +++ b/src/site/asciidoc/policy-guide/policy-model/apm-concept-policy.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concept-policy.adoc[] diff --git a/src/site/asciidoc/policy-guide/policy-model/apm-concept-policymodel.adoc b/src/site/asciidoc/policy-guide/policy-model/apm-concept-policymodel.adoc new file mode 100644 index 000000000..762daa720 --- /dev/null +++ b/src/site/asciidoc/policy-guide/policy-model/apm-concept-policymodel.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concept-policymodel.adoc[] diff --git a/src/site/asciidoc/policy-guide/policy-model/apm-concept-state.adoc b/src/site/asciidoc/policy-guide/policy-model/apm-concept-state.adoc new file mode 100644 index 000000000..79fd71786 --- /dev/null +++ b/src/site/asciidoc/policy-guide/policy-model/apm-concept-state.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concept-state.adoc[] diff --git a/src/site/asciidoc/policy-guide/policy-model/apm-concept-task.adoc b/src/site/asciidoc/policy-guide/policy-model/apm-concept-task.adoc new file mode 100644 index 000000000..54f1d4b3f --- /dev/null +++ b/src/site/asciidoc/policy-guide/policy-model/apm-concept-task.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concept-task.adoc[] diff --git a/src/site/asciidoc/policy-guide/policy-model/apm-concept-taskparameter.adoc b/src/site/asciidoc/policy-guide/policy-model/apm-concept-taskparameter.adoc new file mode 100644 index 000000000..982e5c356 --- /dev/null +++ b/src/site/asciidoc/policy-guide/policy-model/apm-concept-taskparameter.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concept-taskparameter.adoc[] diff --git a/src/site/asciidoc/policy-guide/policy-model/apm-concepts-keys.adoc b/src/site/asciidoc/policy-guide/policy-model/apm-concepts-keys.adoc new file mode 100644 index 000000000..024fca695 --- /dev/null +++ b/src/site/asciidoc/policy-guide/policy-model/apm-concepts-keys.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/concepts-keys.adoc[] diff --git a/src/site/asciidoc/policy-guide/policy-model/apm-introduction.adoc b/src/site/asciidoc/policy-guide/policy-model/apm-introduction.adoc new file mode 100644 index 000000000..f4016f273 --- /dev/null +++ b/src/site/asciidoc/policy-guide/policy-model/apm-introduction.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/apex-policy-model/introduction.adoc[] diff --git a/src/site/asciidoc/user-manual/configuration/um-00-introduction.adoc b/src/site/asciidoc/user-manual/configuration/um-00-introduction.adoc new file mode 100644 index 000000000..6c8b9a5f2 --- /dev/null +++ b/src/site/asciidoc/user-manual/configuration/um-00-introduction.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-config/introduction.adoc[] diff --git a/src/site/asciidoc/user-manual/configuration/um-01-config-general-format.adoc b/src/site/asciidoc/user-manual/configuration/um-01-config-general-format.adoc new file mode 100644 index 000000000..4401f4c06 --- /dev/null +++ b/src/site/asciidoc/user-manual/configuration/um-01-config-general-format.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-services-engine-dir}/site-docs/adoc/fragments/config-general-format.adoc[] diff --git a/src/site/asciidoc/user-manual/configuration/um-02-config-service-parameters.adoc b/src/site/asciidoc/user-manual/configuration/um-02-config-service-parameters.adoc new file mode 100644 index 000000000..b12c84a7d --- /dev/null +++ b/src/site/asciidoc/user-manual/configuration/um-02-config-service-parameters.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-services-engine-dir}/site-docs/adoc/fragments/config-service-parameters.adoc[] \ No newline at end of file diff --git a/src/site/asciidoc/user-manual/configuration/um-03-config-interfaces-general.adoc b/src/site/asciidoc/user-manual/configuration/um-03-config-interfaces-general.adoc new file mode 100644 index 000000000..d82894de7 --- /dev/null +++ b/src/site/asciidoc/user-manual/configuration/um-03-config-interfaces-general.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-services-engine-dir}/site-docs/adoc/fragments/config-interfaces-general.adoc[] \ No newline at end of file diff --git a/src/site/asciidoc/user-manual/configuration/um-04-executors.adoc b/src/site/asciidoc/user-manual/configuration/um-04-executors.adoc new file mode 100644 index 000000000..82e34746f --- /dev/null +++ b/src/site/asciidoc/user-manual/configuration/um-04-executors.adoc @@ -0,0 +1,24 @@ +// +// ============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) +// + +include::{adsite-plugins-executor-dir}/site-docs/adoc/fragments/executors.adoc[] + +include::{adsite-plugins-executor-javascript-dir}/site-docs/adoc/fragments/javascript-config.adoc[leveloffset=+1] + +include::{adsite-plugins-executor-jython-dir}/site-docs/adoc/fragments/jython-config.adoc[leveloffset=+1] + +include::{adsite-plugins-executor-jruby-dir}/site-docs/adoc/fragments/jruby-config.adoc[leveloffset=+1] + +include::{adsite-plugins-executor-java-dir}/site-docs/adoc/fragments/java-config.adoc[leveloffset=+1] + +include::{adsite-plugins-executor-mvel-dir}/site-docs/adoc/fragments/mvel-config.adoc[leveloffset=+1] diff --git a/src/site/asciidoc/user-manual/configuration/um-05-context.adoc b/src/site/asciidoc/user-manual/configuration/um-05-context.adoc new file mode 100644 index 000000000..099639d27 --- /dev/null +++ b/src/site/asciidoc/user-manual/configuration/um-05-context.adoc @@ -0,0 +1,16 @@ +// +// ============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) +// + +include::{adsite-plugins-context-dir}/site-docs/adoc/fragments/context.adoc[] + +include::{adsite-plugins-context-schema-avro-dir}/site-docs/adoc/fragments/ctx-schema-avro-config.adoc[leveloffset=+1] diff --git a/src/site/asciidoc/user-manual/configuration/um-06-carriertech.adoc b/src/site/asciidoc/user-manual/configuration/um-06-carriertech.adoc new file mode 100644 index 000000000..316d88d3e --- /dev/null +++ b/src/site/asciidoc/user-manual/configuration/um-06-carriertech.adoc @@ -0,0 +1,32 @@ +// +// ============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) +// + +include::{adsite-plugins-event-carrier-dir}/site-docs/adoc/fragments/carriertech.adoc[] + +include::{adsite-plugins-event-carrier-dir}/site-docs/adoc/fragments/ct-standard-io.adoc[leveloffset=+1] + +include::{adsite-plugins-event-carrier-dir}/site-docs/adoc/fragments/ct-file-io.adoc[leveloffset=+1] + +include::{adsite-plugins-event-carrier-dir}/site-docs/adoc/fragments/ct-eventrequestor-io.adoc[leveloffset=+1] + +include::{adsite-plugins-event-carrier-kafka-dir}/site-docs/adoc/fragments/ct-kafka-io.adoc[leveloffset=+1] + +include::{adsite-plugins-event-carrier-jms-dir}/site-docs/adoc/fragments/ct-jms-io.adoc[leveloffset=+1] + +include::{adsite-plugins-event-carrier-websocket-dir}/site-docs/adoc/fragments/ct-websocket-io.adoc[leveloffset=+1] + +include::{adsite-plugins-event-carrier-restclient-dir}/site-docs/adoc/fragments/ct-restclient-io.adoc[leveloffset=+1] + +include::{adsite-plugins-event-carrier-restserver-dir}/site-docs/adoc/fragments/ct-restserver-io.adoc[leveloffset=+1] + +include::{adsite-plugins-event-carrier-restrequestor-dir}/site-docs/adoc/fragments/ct-restrequestor-io.adoc[leveloffset=+1] diff --git a/src/site/asciidoc/user-manual/configuration/um-07-eventprotols.adoc b/src/site/asciidoc/user-manual/configuration/um-07-eventprotols.adoc new file mode 100644 index 000000000..cdb0df80c --- /dev/null +++ b/src/site/asciidoc/user-manual/configuration/um-07-eventprotols.adoc @@ -0,0 +1,24 @@ +// +// ============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) +// + +include::{adsite-plugins-event-protocol-dir}/site-docs/adoc/fragments/event-protocols.adoc[] + +include::{adsite-plugins-event-protocol-dir}/site-docs/adoc/fragments/ep-json.adoc[leveloffset=+1] + +include::{adsite-plugins-event-protocol-dir}/site-docs/adoc/fragments/ep-apex.adoc[leveloffset=+1] + +include::{adsite-plugins-event-protocol-jms-dir}/site-docs/adoc/fragments/ep-jms.adoc[leveloffset=+1] + +include::{adsite-plugins-event-protocol-yaml-dir}/site-docs/adoc/fragments/ep-yaml.adoc[leveloffset=+1] + +include::{adsite-plugins-event-protocol-xml-dir}/site-docs/adoc/fragments/ep-xml.adoc[leveloffset=+1] diff --git a/src/site/asciidoc/user-manual/configuration/um-99-config-example.adoc b/src/site/asciidoc/user-manual/configuration/um-99-config-example.adoc new file mode 100644 index 000000000..d429d2fb6 --- /dev/null +++ b/src/site/asciidoc/user-manual/configuration/um-99-config-example.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-services-engine-dir}/site-docs/adoc/fragments/config-example.adoc[] \ No newline at end of file diff --git a/src/site/asciidoc/user-manual/engine-apps/um-engapps-app-model-2-cli.adoc b/src/site/asciidoc/user-manual/engine-apps/um-engapps-app-model-2-cli.adoc new file mode 100644 index 000000000..92fd5e727 --- /dev/null +++ b/src/site/asciidoc/user-manual/engine-apps/um-engapps-app-model-2-cli.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-apex/app-model-2-cli.adoc[] diff --git a/src/site/asciidoc/user-manual/engine-apps/um-engapps-app-tpl-event-json.adoc b/src/site/asciidoc/user-manual/engine-apps/um-engapps-app-tpl-event-json.adoc new file mode 100644 index 000000000..4d25f91f3 --- /dev/null +++ b/src/site/asciidoc/user-manual/engine-apps/um-engapps-app-tpl-event-json.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-apex/app-tpl-event-json.adoc[] diff --git a/src/site/asciidoc/user-manual/engine-apps/um-engapps-app-ws.adoc b/src/site/asciidoc/user-manual/engine-apps/um-engapps-app-ws.adoc new file mode 100644 index 000000000..87c8e1ae3 --- /dev/null +++ b/src/site/asciidoc/user-manual/engine-apps/um-engapps-app-ws.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-apex/app-ws.adoc[] diff --git a/src/site/asciidoc/user-manual/engine-apps/um-engapps-application-launcher.adoc b/src/site/asciidoc/user-manual/engine-apps/um-engapps-application-launcher.adoc new file mode 100644 index 000000000..6211e5207 --- /dev/null +++ b/src/site/asciidoc/user-manual/engine-apps/um-engapps-application-launcher.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-apex/application-launcher.adoc[] diff --git a/src/site/asciidoc/user-manual/engine-apps/um-engapps-cli-editor.adoc b/src/site/asciidoc/user-manual/engine-apps/um-engapps-cli-editor.adoc new file mode 100644 index 000000000..c5cfbcc22 --- /dev/null +++ b/src/site/asciidoc/user-manual/engine-apps/um-engapps-cli-editor.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-apex/cli-editor.adoc[] diff --git a/src/site/asciidoc/user-manual/engine-apps/um-engapps-eng-deployment.adoc b/src/site/asciidoc/user-manual/engine-apps/um-engapps-eng-deployment.adoc new file mode 100644 index 000000000..1b1a51ebd --- /dev/null +++ b/src/site/asciidoc/user-manual/engine-apps/um-engapps-eng-deployment.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-apex/eng-deployment.adoc[] diff --git a/src/site/asciidoc/user-manual/engine-apps/um-engapps-eng-monitoring.adoc b/src/site/asciidoc/user-manual/engine-apps/um-engapps-eng-monitoring.adoc new file mode 100644 index 000000000..20482b9ec --- /dev/null +++ b/src/site/asciidoc/user-manual/engine-apps/um-engapps-eng-monitoring.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-apex/eng-monitoring.adoc[] diff --git a/src/site/asciidoc/user-manual/engine-apps/um-engapps-engine.adoc b/src/site/asciidoc/user-manual/engine-apps/um-engapps-engine.adoc new file mode 100644 index 000000000..25e92d82f --- /dev/null +++ b/src/site/asciidoc/user-manual/engine-apps/um-engapps-engine.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-apex/engine.adoc[] diff --git a/src/site/asciidoc/user-manual/engine-apps/um-engapps-full-client.adoc b/src/site/asciidoc/user-manual/engine-apps/um-engapps-full-client.adoc new file mode 100644 index 000000000..a192c9c35 --- /dev/null +++ b/src/site/asciidoc/user-manual/engine-apps/um-engapps-full-client.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-apex/full-client.adoc[] diff --git a/src/site/asciidoc/user-manual/engine-apps/um-engapps-rest-editor.adoc b/src/site/asciidoc/user-manual/engine-apps/um-engapps-rest-editor.adoc new file mode 100644 index 000000000..c9534c529 --- /dev/null +++ b/src/site/asciidoc/user-manual/engine-apps/um-engapps-rest-editor.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-apex/rest-editor.adoc[] diff --git a/src/site/asciidoc/user-manual/engine-apps/um-engapps.adoc b/src/site/asciidoc/user-manual/engine-apps/um-engapps.adoc new file mode 100644 index 000000000..96865c597 --- /dev/null +++ b/src/site/asciidoc/user-manual/engine-apps/um-engapps.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-apex/introduction.adoc[] diff --git a/src/site/asciidoc/user-manual/install/um-install-build-apex.adoc b/src/site/asciidoc/user-manual/install/um-install-build-apex.adoc new file mode 100644 index 000000000..e69caf531 --- /dev/null +++ b/src/site/asciidoc/user-manual/install/um-install-build-apex.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/build-apex.adoc[] diff --git a/src/site/asciidoc/user-manual/install/um-install-configure.adoc b/src/site/asciidoc/user-manual/install/um-install-configure.adoc new file mode 100644 index 000000000..fa5a6dfc7 --- /dev/null +++ b/src/site/asciidoc/user-manual/install/um-install-configure.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/configure.adoc[] diff --git a/src/site/asciidoc/user-manual/install/um-install-docker.adoc b/src/site/asciidoc/user-manual/install/um-install-docker.adoc new file mode 100644 index 000000000..7552fddd7 --- /dev/null +++ b/src/site/asciidoc/user-manual/install/um-install-docker.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/docker.adoc[] diff --git a/src/site/asciidoc/user-manual/install/um-install-get-source.adoc b/src/site/asciidoc/user-manual/install/um-install-get-source.adoc new file mode 100644 index 000000000..c53f3eee1 --- /dev/null +++ b/src/site/asciidoc/user-manual/install/um-install-get-source.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/get-source.adoc[] diff --git a/src/site/asciidoc/user-manual/install/um-install-install.adoc b/src/site/asciidoc/user-manual/install/um-install-install.adoc new file mode 100644 index 000000000..f3fff1d7a --- /dev/null +++ b/src/site/asciidoc/user-manual/install/um-install-install.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/install.adoc[] diff --git a/src/site/asciidoc/user-manual/install/um-install-layout.adoc b/src/site/asciidoc/user-manual/install/um-install-layout.adoc new file mode 100644 index 000000000..2f473edab --- /dev/null +++ b/src/site/asciidoc/user-manual/install/um-install-layout.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/layout.adoc[] diff --git a/src/site/asciidoc/user-manual/install/um-install-monitoring.adoc b/src/site/asciidoc/user-manual/install/um-install-monitoring.adoc new file mode 100644 index 000000000..79889ec97 --- /dev/null +++ b/src/site/asciidoc/user-manual/install/um-install-monitoring.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/install-monitoring.adoc[] diff --git a/src/site/asciidoc/user-manual/install/um-install-resteditor.adoc b/src/site/asciidoc/user-manual/install/um-install-resteditor.adoc new file mode 100644 index 000000000..1d2741ab5 --- /dev/null +++ b/src/site/asciidoc/user-manual/install/um-install-resteditor.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/install-resteditor.adoc[] diff --git a/src/site/asciidoc/user-manual/install/um-install-verify.adoc b/src/site/asciidoc/user-manual/install/um-install-verify.adoc new file mode 100644 index 000000000..0f6e8022c --- /dev/null +++ b/src/site/asciidoc/user-manual/install/um-install-verify.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/verify.adoc[] diff --git a/src/site/asciidoc/user-manual/install/um-install.adoc b/src/site/asciidoc/user-manual/install/um-install.adoc new file mode 100644 index 000000000..b70434d2e --- /dev/null +++ b/src/site/asciidoc/user-manual/install/um-install.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/install-guide/requirements.adoc[] diff --git a/src/site/asciidoc/user-manual/logging/um-logging-example-logic.adoc b/src/site/asciidoc/user-manual/logging/um-logging-example-logic.adoc new file mode 100644 index 000000000..340e843b7 --- /dev/null +++ b/src/site/asciidoc/user-manual/logging/um-logging-example-logic.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-logging/example-logic.adoc[] diff --git a/src/site/asciidoc/user-manual/logging/um-logging-example-server.adoc b/src/site/asciidoc/user-manual/logging/um-logging-example-server.adoc new file mode 100644 index 000000000..2b732c002 --- /dev/null +++ b/src/site/asciidoc/user-manual/logging/um-logging-example-server.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-logging/example-server.adoc[] diff --git a/src/site/asciidoc/user-manual/logging/um-logging-logback-status.adoc b/src/site/asciidoc/user-manual/logging/um-logging-logback-status.adoc new file mode 100644 index 000000000..b00e8832d --- /dev/null +++ b/src/site/asciidoc/user-manual/logging/um-logging-logback-status.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-logging/logback-status.adoc[] diff --git a/src/site/asciidoc/user-manual/logging/um-logging-logging-3pps.adoc b/src/site/asciidoc/user-manual/logging/um-logging-logging-3pps.adoc new file mode 100644 index 000000000..fd49e246f --- /dev/null +++ b/src/site/asciidoc/user-manual/logging/um-logging-logging-3pps.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-logging/logging-3pps.adoc[] diff --git a/src/site/asciidoc/user-manual/logging/um-logging-logging-policy-logic.adoc b/src/site/asciidoc/user-manual/logging/um-logging-logging-policy-logic.adoc new file mode 100644 index 000000000..ca2ab11e2 --- /dev/null +++ b/src/site/asciidoc/user-manual/logging/um-logging-logging-policy-logic.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-logging/logging-policy-logic.adoc[] diff --git a/src/site/asciidoc/user-manual/logging/um-logging-rolling-file-appenders.adoc b/src/site/asciidoc/user-manual/logging/um-logging-rolling-file-appenders.adoc new file mode 100644 index 000000000..21661198d --- /dev/null +++ b/src/site/asciidoc/user-manual/logging/um-logging-rolling-file-appenders.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-logging/rolling-file-appenders.adoc[] diff --git a/src/site/asciidoc/user-manual/logging/um-logging-standard-configuration.adoc b/src/site/asciidoc/user-manual/logging/um-logging-standard-configuration.adoc new file mode 100644 index 000000000..2ec3b2894 --- /dev/null +++ b/src/site/asciidoc/user-manual/logging/um-logging-standard-configuration.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-logging/standard-configuration.adoc[] diff --git a/src/site/asciidoc/user-manual/logging/um-logging.adoc b/src/site/asciidoc/user-manual/logging/um-logging.adoc new file mode 100644 index 000000000..c4a81005f --- /dev/null +++ b/src/site/asciidoc/user-manual/logging/um-logging.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-logging/introduction.adoc[] diff --git a/src/site/asciidoc/user-manual/my-first-policy/um-mfp-01-introduction.adoc b/src/site/asciidoc/user-manual/my-first-policy/um-mfp-01-introduction.adoc new file mode 100644 index 000000000..83fe34043 --- /dev/null +++ b/src/site/asciidoc/user-manual/my-first-policy/um-mfp-01-introduction.adoc @@ -0,0 +1,16 @@ +// +// ============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) +// + += HowTo: My First Policy + +include::{adsite-examples-myfirstpolicy-dir}/site-docs/adoc/fragments/01-introduction.adoc[] diff --git a/src/site/asciidoc/user-manual/my-first-policy/um-mfp-02-data-models.adoc b/src/site/asciidoc/user-manual/my-first-policy/um-mfp-02-data-models.adoc new file mode 100644 index 000000000..dca728dfa --- /dev/null +++ b/src/site/asciidoc/user-manual/my-first-policy/um-mfp-02-data-models.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-examples-myfirstpolicy-dir}/site-docs/adoc/fragments/02-data-models.adoc[] diff --git a/src/site/asciidoc/user-manual/my-first-policy/um-mfp-03-policy-step1.adoc b/src/site/asciidoc/user-manual/my-first-policy/um-mfp-03-policy-step1.adoc new file mode 100644 index 000000000..2bf3aa44c --- /dev/null +++ b/src/site/asciidoc/user-manual/my-first-policy/um-mfp-03-policy-step1.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-examples-myfirstpolicy-dir}/site-docs/adoc/fragments/03-policy-step1.adoc[] diff --git a/src/site/asciidoc/user-manual/my-first-policy/um-mfp-031-s1-new-model.adoc b/src/site/asciidoc/user-manual/my-first-policy/um-mfp-031-s1-new-model.adoc new file mode 100644 index 000000000..c3f05c5b0 --- /dev/null +++ b/src/site/asciidoc/user-manual/my-first-policy/um-mfp-031-s1-new-model.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-examples-myfirstpolicy-dir}/site-docs/adoc/fragments/031-s1-new-model.adoc[] diff --git a/src/site/asciidoc/user-manual/my-first-policy/um-mfp-032-s1-new-events.adoc b/src/site/asciidoc/user-manual/my-first-policy/um-mfp-032-s1-new-events.adoc new file mode 100644 index 000000000..044c21ecd --- /dev/null +++ b/src/site/asciidoc/user-manual/my-first-policy/um-mfp-032-s1-new-events.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-examples-myfirstpolicy-dir}/site-docs/adoc/fragments/032-s1-new-events.adoc[] diff --git a/src/site/asciidoc/user-manual/my-first-policy/um-mfp-033-s1-new-policy.adoc b/src/site/asciidoc/user-manual/my-first-policy/um-mfp-033-s1-new-policy.adoc new file mode 100644 index 000000000..d7d279b3d --- /dev/null +++ b/src/site/asciidoc/user-manual/my-first-policy/um-mfp-033-s1-new-policy.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-examples-myfirstpolicy-dir}/site-docs/adoc/fragments/033-s1-new-policy.adoc[] diff --git a/src/site/asciidoc/user-manual/my-first-policy/um-mfp-034-s1-test-policy.adoc b/src/site/asciidoc/user-manual/my-first-policy/um-mfp-034-s1-test-policy.adoc new file mode 100644 index 000000000..43a026a4c --- /dev/null +++ b/src/site/asciidoc/user-manual/my-first-policy/um-mfp-034-s1-test-policy.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-examples-myfirstpolicy-dir}/site-docs/adoc/fragments/034-s1-test-policy.adoc[] diff --git a/src/site/asciidoc/user-manual/my-first-policy/um-mfp-035-s1-clieditor.adoc b/src/site/asciidoc/user-manual/my-first-policy/um-mfp-035-s1-clieditor.adoc new file mode 100644 index 000000000..2c3063055 --- /dev/null +++ b/src/site/asciidoc/user-manual/my-first-policy/um-mfp-035-s1-clieditor.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-examples-myfirstpolicy-dir}/site-docs/adoc/fragments/035-s1-clieditor.adoc[] diff --git a/src/site/asciidoc/user-manual/my-first-policy/um-mfp-04-policy-step2.adoc b/src/site/asciidoc/user-manual/my-first-policy/um-mfp-04-policy-step2.adoc new file mode 100644 index 000000000..155c888e5 --- /dev/null +++ b/src/site/asciidoc/user-manual/my-first-policy/um-mfp-04-policy-step2.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-examples-myfirstpolicy-dir}/site-docs/adoc/fragments/04-policy-step2.adoc[] diff --git a/src/site/asciidoc/user-manual/my-first-policy/um-mfp-041-s2-extend-model.adoc b/src/site/asciidoc/user-manual/my-first-policy/um-mfp-041-s2-extend-model.adoc new file mode 100644 index 000000000..d2b4a9952 --- /dev/null +++ b/src/site/asciidoc/user-manual/my-first-policy/um-mfp-041-s2-extend-model.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-examples-myfirstpolicy-dir}/site-docs/adoc/fragments/041-s2-extend-model.adoc[] diff --git a/src/site/asciidoc/user-manual/my-first-policy/um-mfp-042-s2-test-policy.adoc b/src/site/asciidoc/user-manual/my-first-policy/um-mfp-042-s2-test-policy.adoc new file mode 100644 index 000000000..454fee841 --- /dev/null +++ b/src/site/asciidoc/user-manual/my-first-policy/um-mfp-042-s2-test-policy.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-examples-myfirstpolicy-dir}/site-docs/adoc/fragments/042-s2-test-policy.adoc[] diff --git a/src/site/asciidoc/user-manual/my-first-policy/um-mfp-043-s2-clieditor.adoc b/src/site/asciidoc/user-manual/my-first-policy/um-mfp-043-s2-clieditor.adoc new file mode 100644 index 000000000..ca39675c5 --- /dev/null +++ b/src/site/asciidoc/user-manual/my-first-policy/um-mfp-043-s2-clieditor.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-examples-myfirstpolicy-dir}/site-docs/adoc/fragments/043-s2-clieditor.adoc[] diff --git a/src/site/asciidoc/user-manual/websockets/um-websocket-demo-00.adoc b/src/site/asciidoc/user-manual/websockets/um-websocket-demo-00.adoc new file mode 100644 index 000000000..20bb791e8 --- /dev/null +++ b/src/site/asciidoc/user-manual/websockets/um-websocket-demo-00.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-websockets/demo-00.adoc[] diff --git a/src/site/asciidoc/user-manual/websockets/um-websocket-demo-01-vpn-wsconfig.adoc b/src/site/asciidoc/user-manual/websockets/um-websocket-demo-01-vpn-wsconfig.adoc new file mode 100644 index 000000000..97187768f --- /dev/null +++ b/src/site/asciidoc/user-manual/websockets/um-websocket-demo-01-vpn-wsconfig.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-websockets/demo-01-vpn-wsconfig.adoc[] diff --git a/src/site/asciidoc/user-manual/websockets/um-websocket-demo-02-start-engine.adoc b/src/site/asciidoc/user-manual/websockets/um-websocket-demo-02-start-engine.adoc new file mode 100644 index 000000000..ea6250263 --- /dev/null +++ b/src/site/asciidoc/user-manual/websockets/um-websocket-demo-02-start-engine.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-websockets/demo-02-start-engine.adoc[] diff --git a/src/site/asciidoc/user-manual/websockets/um-websocket-demo-03-start-echo-client.adoc b/src/site/asciidoc/user-manual/websockets/um-websocket-demo-03-start-echo-client.adoc new file mode 100644 index 000000000..e55c437ad --- /dev/null +++ b/src/site/asciidoc/user-manual/websockets/um-websocket-demo-03-start-echo-client.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-websockets/demo-03-start-echo-client.adoc[] diff --git a/src/site/asciidoc/user-manual/websockets/um-websocket-demo-04-start-console-client.adoc b/src/site/asciidoc/user-manual/websockets/um-websocket-demo-04-start-console-client.adoc new file mode 100644 index 000000000..fe0c2dd8e --- /dev/null +++ b/src/site/asciidoc/user-manual/websockets/um-websocket-demo-04-start-console-client.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-websockets/demo-04-start-console-client.adoc[] diff --git a/src/site/asciidoc/user-manual/websockets/um-websocket-demo-05-send-events.adoc b/src/site/asciidoc/user-manual/websockets/um-websocket-demo-05-send-events.adoc new file mode 100644 index 000000000..c2d541e1d --- /dev/null +++ b/src/site/asciidoc/user-manual/websockets/um-websocket-demo-05-send-events.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-main-dir}/site-docs/adoc/fragments/howto-websockets/demo-05-send-events.adoc[] diff --git a/src/site/asciidoc/user-manual/websockets/um-websocket-engine-config.adoc b/src/site/asciidoc/user-manual/websockets/um-websocket-engine-config.adoc new file mode 100644 index 000000000..bfa111b35 --- /dev/null +++ b/src/site/asciidoc/user-manual/websockets/um-websocket-engine-config.adoc @@ -0,0 +1,14 @@ +// +// ============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) +// + +include::{adsite-plugins-event-carrier-websocket-dir}/site-docs/adoc/fragments/engine-config-bcp.adoc[] diff --git a/src/site/asciidoc/user-manual/websockets/um-websocket-introduction.adoc b/src/site/asciidoc/user-manual/websockets/um-websocket-introduction.adoc new file mode 100644 index 000000000..d230c51bc --- /dev/null +++ b/src/site/asciidoc/user-manual/websockets/um-websocket-introduction.adoc @@ -0,0 +1,21 @@ +// +// ============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) +// + += HowTo: Building an APEX System with Websockets + +include::{adsite-plugins-event-carrier-websocket-dir}/site-docs/adoc/fragments/ws-intro.adoc[] + +include::{adsite-plugins-event-carrier-websocket-dir}/site-docs/adoc/fragments/ws-java.adoc[] + +include::{adsite-plugins-event-carrier-websocket-dir}/site-docs/adoc/fragments/ws-foss.adoc[] + diff --git a/src/site/css/site.css b/src/site/css/site.css new file mode 100644 index 000000000..ef8bd4d15 --- /dev/null +++ b/src/site/css/site.css @@ -0,0 +1,100 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2016-2018 Ericsson. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +@import url(http://cdnjs.cloudflare.com/ajax/libs/font-awesome/3.2.0/css/font-awesome.css); + + +/*************** Table definitions *******************/ + +tableblock > .title, .tableblock > caption { line-height: 1.4; color: #7a2518; font-weight: 300; margin-top: 0.2em; margin-bottom: 0.5em; } + +.tableblock > caption { text-align: left; font-weight: bold; white-space: nowrap; overflow: visible; max-width: 0; } + +table.tableblock { background: white; margin-bottom: 1.25em; border: solid 1px #dddddd; } +table.tableblock thead, table.tableblock tfoot { background: whitesmoke; font-weight: bold; } +table.tableblock thead tr th, table.tableblock thead tr td, table tfoot tr th, table tfoot tr td { padding: 0.5em 0.625em 0.625em; font-size: inherit; color: #222222; text-align: left; } +table.tableblock tr th, table.tableblock tr td { padding: 0.5625em 0.625em; font-size: inherit; color: #222222; } +table.tableblock tr.even, table.tableblock tr.alt, table.tableblock tr:nth-of-type(even) { background: #f9f9f9; } +table.tableblock thead tr th, table.tableblock tfoot tr th, table.tableblock tbody tr td, table.tableblock tr td, table.tableblock tfoot tr td { display: table-cell; line-height: 1.6; } + +table.tableblock #preamble > .sectionbody > .paragraph:first-of-type p { font-size: inherit; } + +table.tableblock.grid-all { border-collapse: separate; border-spacing: 1px; -webkit-border-radius: 4px; border-radius: 4px; border-top: 1px solid #dddddd; border-bottom: 1px solid #dddddd; } + +table.tableblock.frame-topbot, table.tableblock.frame-none { border-left: 0; border-right: 0; } + +table.tableblock.frame-sides, table.tableblock.frame-none { border-top: 0; border-bottom: 0; } + +table.tableblock td .paragraph:last-child p, table.tableblock td > p:last-child { margin-bottom: 0; } + +th.tableblock.halign-left, td.tableblock.halign-left { text-align: left; } + +th.tableblock.halign-right, td.tableblock.halign-right { text-align: right; } + +th.tableblock.halign-center, td.tableblock.halign-center { text-align: center; } + +th.tableblock.valign-top, td.tableblock.valign-top { vertical-align: top; } + +th.tableblock.valign-bottom, td.tableblock.valign-bottom { vertical-align: bottom; } + +th.tableblock.valign-middle, td.tableblock.valign-middle { vertical-align: middle; } + +p.tableblock.header { color: #222222; font-weight: bold; } + + + +/*************** KBD Macro definitions *******************/ + +kbd.keyseq { color: #555555; } + +kbd:not(.keyseq) { display: inline-block; color: #222222; font-size: 0.75em; line-height: 1.4; background-color: #F7F7F7; border: 1px solid #ccc; -webkit-border-radius: 3px; border-radius: 3px; -webkit-box-shadow: 0 1px 0 rgba(0, 0, 0, 0.2), 0 0 0 2px white inset; box-shadow: 0 1px 0 rgba(0, 0, 0, 0.2), 0 0 0 2px white inset; margin: -0.15em 0.15em 0 0.15em; padding: 0.2em 0.6em 0.2em 0.5em; vertical-align: middle; white-space: nowrap; } + +kbd kbd:first-child { margin-left: 0; } + +kbd kbd:last-child { margin-right: 0; } + + +/*************** Admontion Blocks definitions *******************/ +.admonitionblock td.content > .title, .exampleblock > .title, .imageblock > .title, .videoblock > .title, .listingblock > .title, .literalblock > .title, .openblock > .title, .paragraph > .title, .quoteblock > .title, .sidebarblock > .title, .tableblock > .title, .verseblock > .title, .dlist > .title, .olist > .title, .ulist > .title, .qlist > .title, .hdlist > .title { text-align: left; font-weight: bold; } + +.admonitionblock > table { border: 0; background: none; width: 100%; margin-top: 1em; margin-bottom: 1em;} +.admonitionblock > table td.icon { text-align: center; width: 80px; } +.admonitionblock > table td.icon img { max-width: none; } +.admonitionblock > table td.icon .title { font-weight: bold; text-transform: uppercase; } +.admonitionblock > table td.content { padding-left: 1.125em; padding-right: 1.25em; border-left: 1px solid #dddddd; color: #6f6f6f; } +.admonitionblock > table td.content > :last-child > :last-child { margin-bottom: 0; } + +.admonitionblock td.icon [class^="fa icon-"]:before {font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default} +.admonitionblock td.icon .icon-note:before { content: "\f05a"; color: #005498; color: #003f72; } +.admonitionblock td.icon .icon-tip:before { content: "\f0eb"; text-shadow: 1px 1px 2px rgba(155, 155, 0, 0.8); color: #111; } +.admonitionblock td.icon .icon-warning:before { content: "\f071"; color: #bf6900; } +.admonitionblock td.icon .icon-caution:before { content: "\f06d"; color: #bf3400; } +.admonitionblock td.icon .icon-important:before { content: "\f06a"; color: #bf0000; } + + + +/*************** Misc definitions *******************/ + +*:not(pre) > code { font-size: 0.9375em; padding: 1px 3px 0; white-space: nowrap; background-color: #f2f2f2; border: 1px solid #cccccc; -webkit-border-radius: 4px; border-radius: 4px; text-shadow: none; } + +pre, pre > code { line-height: 1.4; color: inherit; font-family: Consolas, "Liberation Mono", Courier, monospace; font-weight: normal; } + +code { font-family: Consolas, "Liberation Mono", Courier, monospace; font-weight: normal; color: #6d180b; } + diff --git a/src/site/images/logos.png b/src/site/images/logos.png new file mode 100644 index 000000000..915d6e59d Binary files /dev/null and b/src/site/images/logos.png differ diff --git a/src/site/site.xml b/src/site/site.xml new file mode 100644 index 000000000..20d77ae4e --- /dev/null +++ b/src/site/site.xml @@ -0,0 +1,226 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + org.apache.maven.skins + maven-fluido-skin + 1.5 + + \ No newline at end of file diff --git a/src/site/xdoc/developer-guide.xml b/src/site/xdoc/developer-guide.xml new file mode 100644 index 000000000..40e689739 --- /dev/null +++ b/src/site/xdoc/developer-guide.xml @@ -0,0 +1,93 @@ + + + + + + The APEX Developer Guide + Sven van der Meer + Liam Fallon + John Keeny + + + +
+ +

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

+ +

+ 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
Developer Guide + The complete APEX Developer Guide, including all HowTos and other documentation. + The stand-alone versions aggregate all other documents listed in this table. + + +
HowTo: Build APEX from source + 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. + + +
HowTo: Codestyle and Automated Style Checks + 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. + + +
+
+ + diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml new file mode 100644 index 000000000..55e3e58fb --- /dev/null +++ b/src/site/xdoc/index.xml @@ -0,0 +1,280 @@ + + + + + + + Welcome to APEX - The Adaptive Policy EXecution (Engine) + Sven van der Meer + Liam Fallon + John Keeny + + + +
+ +

+ The APEX (Adaptive Policy Execution) policy engine is a fully featured policy engine that executes anything from simple to adaptive policies. + An adaptive policy is one that can modify its behavior based on the current conditions of the network and systems. + Adaptive policies have the following characteristics: +

    +
  • Are able to make decisions at runtime rather than simply selecting decisions described at policy definition time
    • +
  • Can use additional context information that was not provided in the incoming event or request
    • +
  • Can be adapted or self-adapt at runtime to modify decision making
    • +
+

+ +

+ The APEX policy engine accepts input events and requests from other components, routes the input to the appropriate policies, computes the policy results, and generates response events or actions to be processed by other components. + The policies may be affected by information injected into the policy context as changes in business or domain goals, by information derived from previous executions of the policies, and by context information retrieved from other components (analytics, inventory, topology, etc.). +

+ +

+ APEX connects to a Trigger System to receive events that can trigger a policy and to an Actioning System to send the result of a policy. + The connection support various common technologies, such as messaging systems (Kafka, Websockets), file input/output, and standard input/output. + APEX supports context (as additional information) for all events as well as inside the engine to support policies. + Context information can be read from any outside source. +

+ +

+ A policy is defined in a Universal Execution Policy Specification (UEPS), directly executable in an APEX engine. + Higher-level policy specifications (or existing policy languages) can be easily translated in UEPS. +

+ +

+ An APEX system can use multiple policy engines with different policies deployed on each of them. + Context information is automatically shared between all engine instances. + A simple deployment component is provided. +

+ + +

APEX Documentation

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
DocumentDescription
APEX Introduction + This is a short introduction to APEX to show its features and capabilities. + +

+ Also available as + stand-alone HTML and + stand-alone PDF. +
Publications + APEX is based on a theor called Unifying Policy Theory (UPT). + Over the years, we have published a number of papers on APEX, context management, policy in general, and control loops. + This is the list of all APEX and the most relevant other publications. + We provide links to full text versions if possible. + +

+ Also available as + stand-alone HTML and + stand-alone PDF. +
APEX User Manual + 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. +
APEX Policy Guide + 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. +
APEX Development Guide + 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. +
+ + +

APEX Modules and Projects

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionUseful for
auth + Policy, state, and task authoring for APEX. + Important projects here are: + + Policy Designers
plugins + Plugins for APEX that can be implemented with various 3PPs are implemented here. + Most of the APEX engine and system functionality is realized using plug-ins. + These plug-ins are loaded when an APEX policy engine is started. + A configuration specifies which plugins to load. + Important projects here are: +
    +
  • plugins-executor - Execution environments for policy logic, such as Javascript, Java, JRuby, Jython, MVEL
    • +
  • plugins-event - All event-related plugins: carrier technologies (Kafka, Websocket), event protocols (XML, IBeam)
    • +
  • plugins-context - Everything for context: schema (for defining context) distribution (across policies and engines), locking (for writing to context items), persistence
    • +
  • plugins-persistence - Everything needed for persistence (beside context), mainly JPA plugins for Eclipselink and Hibernate
    • +
+ 		Plugin developers
services + The main services of APEX, deployment independent. + Important projects here are: + + Service developers, Deployers
core + The core of APEX, deployment independent. + Important projects here are: + + Core APEX developers
context + The context handling framework of APEX. + Important projects here are: + + Core APEX developers
model + The model for APEX, it comtains definitions of all APEX concepts, also has handling for APEX policy models. + Important projects here are: + + Core APEX developers, Application developers (Model API)
+ + +

APEX Resources

+ + + + + + + + + + + + + +
ResourceDescription
APEX Source (ONAP) + The source of APEX is hosted part of the ONAP Policy Framework. +
APEX Issue Management (Github) + Issues with the APEX software and integrated documentation are managed here. +
+ +
+ + 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 @@ + + + + + + The APEX Policy Guide + Sven van der Meer + Liam Fallon + John Keeny + + + +
+ +

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

+ +

+ 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 Policy Guide documentation

+ + + + + + + + + + + + + + + + + + + + + + + + +
NameDescriptionLinks
Policy Guide + The complete APEX Policy Guide, including all HowTos and other documentation. + The stand-alone versions aggregate all other documents listed in this table. + + +
The APEX Policy Model + A deep dive into the policy model defined and implemented in the APEX engine. + This model is the foundation for policy execution. + + +
HowTo: Policy Logic + 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. + + +
+
+ + \ No newline at end of file diff --git a/src/site/xdoc/user-manual.xml b/src/site/xdoc/user-manual.xml new file mode 100644 index 000000000..2b34610ff --- /dev/null +++ b/src/site/xdoc/user-manual.xml @@ -0,0 +1,150 @@ + + + + + + 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