From 6a2abc8402af63dd8941b4652278a6df404d781a Mon Sep 17 00:00:00 2001 From: Dinh Danh Le Date: Thu, 23 Aug 2018 00:41:47 +0100 Subject: Add docs for the examples package This review is big because it contains examples for the whole project. The big size is mainly due to the site.xml, logos and css files which are repeatedly created, and more aciidoc files are needed. The pom.xml files are changed properly. Change-Id: I42a94e4d898529f9249ef03de908c8b1a0142c7f Signed-off-by: Dinh Danh Le Issue-ID: POLICY-867 --- .../site-docs/adoc/fragments/apex-configuration.adoc | 20 ++++++++++++++++++++ .../src/site-docs/adoc/fragments/apex-model.adoc | 20 ++++++++++++++++++++ .../src/site-docs/adoc/fragments/dockerfile.adoc | 20 ++++++++++++++++++++ .../site-docs/adoc/fragments/logic-task-output.adoc | 20 ++++++++++++++++++++ .../adoc/fragments/logic-task-periodic.adoc | 20 ++++++++++++++++++++ 5 files changed, 100 insertions(+) create mode 100644 examples/examples-periodic/src/site-docs/adoc/fragments/apex-configuration.adoc create mode 100644 examples/examples-periodic/src/site-docs/adoc/fragments/apex-model.adoc create mode 100644 examples/examples-periodic/src/site-docs/adoc/fragments/dockerfile.adoc create mode 100644 examples/examples-periodic/src/site-docs/adoc/fragments/logic-task-output.adoc create mode 100644 examples/examples-periodic/src/site-docs/adoc/fragments/logic-task-periodic.adoc (limited to 'examples/examples-periodic/src/site-docs/adoc/fragments') diff --git a/examples/examples-periodic/src/site-docs/adoc/fragments/apex-configuration.adoc b/examples/examples-periodic/src/site-docs/adoc/fragments/apex-configuration.adoc new file mode 100644 index 000000000..612149818 --- /dev/null +++ b/examples/examples-periodic/src/site-docs/adoc/fragments/apex-configuration.adoc @@ -0,0 +1,20 @@ +// +// ============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 Configuration + +.APEX configuration +[source,json,options="nowrap"] +---- +include::{adsite-examples-periodic-dir}/main/resources/config/ApexConfigPeriodic.json[APEX configuration] +---- diff --git a/examples/examples-periodic/src/site-docs/adoc/fragments/apex-model.adoc b/examples/examples-periodic/src/site-docs/adoc/fragments/apex-model.adoc new file mode 100644 index 000000000..52550bbd6 --- /dev/null +++ b/examples/examples-periodic/src/site-docs/adoc/fragments/apex-model.adoc @@ -0,0 +1,20 @@ +// +// ============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 Configuration + +.APEX Model +[source,bash,options="nowrap"] +---- +include::{adsite-examples-periodic-dir}/main/resources/policy/PeriodicPolicyModel.apex[APEX Model] +---- diff --git a/examples/examples-periodic/src/site-docs/adoc/fragments/dockerfile.adoc b/examples/examples-periodic/src/site-docs/adoc/fragments/dockerfile.adoc new file mode 100644 index 000000000..3ee66b3bd --- /dev/null +++ b/examples/examples-periodic/src/site-docs/adoc/fragments/dockerfile.adoc @@ -0,0 +1,20 @@ +// +// ============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) +// + +== Dockerfile + +.Dockerfile +[source,bash,options="nowrap"] +---- +include::{adsite-examples-periodic-dir}/../Dockerfile[Dockerfile] +---- diff --git a/examples/examples-periodic/src/site-docs/adoc/fragments/logic-task-output.adoc b/examples/examples-periodic/src/site-docs/adoc/fragments/logic-task-output.adoc new file mode 100644 index 000000000..f31f5a9ad --- /dev/null +++ b/examples/examples-periodic/src/site-docs/adoc/fragments/logic-task-output.adoc @@ -0,0 +1,20 @@ +// +// ============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) +// + +== Logic: Output Task + +.Output Task Logic +[source,javascript,options="nowrap"] +---- +include::{adsite-examples-periodic-dir}/main/resources/logic/OutputTask.js[Output Task Logic] +---- diff --git a/examples/examples-periodic/src/site-docs/adoc/fragments/logic-task-periodic.adoc b/examples/examples-periodic/src/site-docs/adoc/fragments/logic-task-periodic.adoc new file mode 100644 index 000000000..1cc318f42 --- /dev/null +++ b/examples/examples-periodic/src/site-docs/adoc/fragments/logic-task-periodic.adoc @@ -0,0 +1,20 @@ +// +// ============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) +// + +== Logic: Periodic Task + +.Periodic Task Logic +[source,javascript,options="nowrap"] +---- +include::{adsite-examples-periodic-dir}/main/resources/logic/PeriodicTask.js[Periodic Task Logic] +---- -- cgit 1.2.3-korg