summaryrefslogtreecommitdiffstats
path: root/examples/examples-periodic
diff options
context:
space:
mode:
authorDinh Danh Le <dinh.danh.le@ericsson.com>2018-08-23 00:41:47 +0100
committerDinh Danh Le <dinh.danh.le@ericsson.com>2018-08-23 16:56:04 +0100
commit6a2abc8402af63dd8941b4652278a6df404d781a (patch)
treed806687cf4621527e471730192f2f26c256ac311 /examples/examples-periodic
parenta4a992216c40138cda8501ee9bed971038b530a9 (diff)
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 <dinh.danh.le@ericsson.com> Issue-ID: POLICY-867
Diffstat (limited to 'examples/examples-periodic')
-rw-r--r--examples/examples-periodic/pom.xml20
-rw-r--r--examples/examples-periodic/src/site-docs/adoc/fragments/apex-configuration.adoc20
-rw-r--r--examples/examples-periodic/src/site-docs/adoc/fragments/apex-model.adoc20
-rw-r--r--examples/examples-periodic/src/site-docs/adoc/fragments/dockerfile.adoc20
-rw-r--r--examples/examples-periodic/src/site-docs/adoc/fragments/logic-task-output.adoc20
-rw-r--r--examples/examples-periodic/src/site-docs/adoc/fragments/logic-task-periodic.adoc20
-rw-r--r--examples/examples-periodic/src/site/asciidoc/apex-configuration.adoc14
-rw-r--r--examples/examples-periodic/src/site/asciidoc/apex-model.adoc14
-rw-r--r--examples/examples-periodic/src/site/asciidoc/dockerfile.adoc14
-rw-r--r--examples/examples-periodic/src/site/asciidoc/logic-task-output.adoc14
-rw-r--r--examples/examples-periodic/src/site/asciidoc/logic-task-periodic.adoc14
-rw-r--r--examples/examples-periodic/src/site/css/site.css100
-rw-r--r--examples/examples-periodic/src/site/images/logos.pngbin0 -> 162383 bytes
-rw-r--r--examples/examples-periodic/src/site/site.xml32
14 files changed, 322 insertions, 0 deletions
diff --git a/examples/examples-periodic/pom.xml b/examples/examples-periodic/pom.xml
index ed0e5b19f..8894e71d7 100644
--- a/examples/examples-periodic/pom.xml
+++ b/examples/examples-periodic/pom.xml
@@ -71,4 +71,24 @@
</plugin>
</plugins>
</build>
+
+ <profiles>
+ <profile>
+ <id>apexSite</id>
+ <activation>
+ <property>
+ <name>apexSite</name>
+ </property>
+ </activation>
+ <properties>
+ <adsite-examples-periodic-dir>${project.basedir}/src</adsite-examples-periodic-dir>
+ </properties>
+ <distributionManagement>
+ <site>
+ <id>${project.artifactId}-site</id>
+ <url>${apex.adsite.prefix}/modules/${project.parent.artifactId}/${project.artifactId}/</url>
+ </site>
+ </distributionManagement>
+ </profile>
+ </profiles>
</project> \ No newline at end of file
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]
+----
diff --git a/examples/examples-periodic/src/site/asciidoc/apex-configuration.adoc b/examples/examples-periodic/src/site/asciidoc/apex-configuration.adoc
new file mode 100644
index 000000000..dd244807a
--- /dev/null
+++ b/examples/examples-periodic/src/site/asciidoc/apex-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-examples-periodic-dir}/site-docs/adoc/fragments/apex-configuration.adoc[]
diff --git a/examples/examples-periodic/src/site/asciidoc/apex-model.adoc b/examples/examples-periodic/src/site/asciidoc/apex-model.adoc
new file mode 100644
index 000000000..4a25a7b0a
--- /dev/null
+++ b/examples/examples-periodic/src/site/asciidoc/apex-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-periodic-dir}/site-docs/adoc/fragments/apex-model.adoc[]
diff --git a/examples/examples-periodic/src/site/asciidoc/dockerfile.adoc b/examples/examples-periodic/src/site/asciidoc/dockerfile.adoc
new file mode 100644
index 000000000..ba5e19bef
--- /dev/null
+++ b/examples/examples-periodic/src/site/asciidoc/dockerfile.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-periodic-dir}/site-docs/adoc/fragments/dockerfile.adoc[]
diff --git a/examples/examples-periodic/src/site/asciidoc/logic-task-output.adoc b/examples/examples-periodic/src/site/asciidoc/logic-task-output.adoc
new file mode 100644
index 000000000..9418a817e
--- /dev/null
+++ b/examples/examples-periodic/src/site/asciidoc/logic-task-output.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-periodic-dir}/site-docs/adoc/fragments/logic-task-output.adoc[]
diff --git a/examples/examples-periodic/src/site/asciidoc/logic-task-periodic.adoc b/examples/examples-periodic/src/site/asciidoc/logic-task-periodic.adoc
new file mode 100644
index 000000000..eec55f1d1
--- /dev/null
+++ b/examples/examples-periodic/src/site/asciidoc/logic-task-periodic.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-periodic-dir}/site-docs/adoc/fragments/logic-task-periodic.adoc[]
diff --git a/examples/examples-periodic/src/site/css/site.css b/examples/examples-periodic/src/site/css/site.css
new file mode 100644
index 000000000..ef8bd4d15
--- /dev/null
+++ b/examples/examples-periodic/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/examples/examples-periodic/src/site/images/logos.png b/examples/examples-periodic/src/site/images/logos.png
new file mode 100644
index 000000000..915d6e59d
--- /dev/null
+++ b/examples/examples-periodic/src/site/images/logos.png
Binary files differ
diff --git a/examples/examples-periodic/src/site/site.xml b/examples/examples-periodic/src/site/site.xml
new file mode 100644
index 000000000..fc2b846cb
--- /dev/null
+++ b/examples/examples-periodic/src/site/site.xml
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ============LICENSE_START=======================================================
+ Copyright (C) 2016-2018 Ericsson. All rights reserved.
+ ================================================================================
+ This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE
+ Full license text at https://creativecommons.org/licenses/by/4.0/legalcode
+
+ SPDX-License-Identifier: CC-BY-4.0
+ ============LICENSE_END=========================================================
+
+ @author Sven van der Meer (sven.van.der.meer@ericsson.com)
+
+-->
+
+<project name="APEX Examples Periodic Policy">
+ <body>
+ <menu name="APEX Domains Periodic Policy">
+ <item href="apex-configuration.html" name="APEX Configuration" />
+ <item href="apex-model.html" name="APEX Model (Policy)" />
+ <item href="logic-task-output.html" name="Logic: Output Task" />
+ <item href="logic-task-periodic.html" name="Logic: Periodic Task" />
+ <item href="dockerfile.html" name="Dockerfile" />
+ </menu>
+ <menu ref="reports" inherit="top" />
+ <menu ref="modules" />
+
+ <breadcrumbs>
+ <item name="Periodic Policy" href="index.html" />
+ </breadcrumbs>
+ </body>
+</project> \ No newline at end of file