diff options
| author |   Dinh Danh Le <dinh.danh.le@ericsson.com> | 2018-08-23 00:41:47 +0100 |
|---|---|---|
| committer | Dinh Danh Le <dinh.danh.le@ericsson.com> | 2018-08-23 16:56:04 +0100 |
| commit | 6a2abc8402af63dd8941b4652278a6df404d781a (patch) | |
| tree | d806687cf4621527e471730192f2f26c256ac311 /examples/examples-decisionmaker/src/site-docs/adoc | |
| parent | a4a992216c40138cda8501ee9bed971038b530a9 (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-decisionmaker/src/site-docs/adoc')
16 files changed, 320 insertions, 0 deletions
diff --git a/examples/examples-decisionmaker/src/site-docs/adoc/fragments/AnswerInitTask.adoc b/examples/examples-decisionmaker/src/site-docs/adoc/fragments/AnswerInitTask.adoc new file mode 100644 index 000000000..802fe7fb4 --- /dev/null +++ b/examples/examples-decisionmaker/src/site-docs/adoc/fragments/AnswerInitTask.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) +// + +== Task Logic: Answer Init + +.Task Logic, Answer Init +[source,javascript,options="nowrap"] +---- +include::{adsite-examples-decisionmaker-dir}/main/resources/logic/AnswerInitTask.js[Task Logic: Answer Init] +----
\ No newline at end of file diff --git a/examples/examples-decisionmaker/src/site-docs/adoc/fragments/AnswerInitiationEvents.adoc b/examples/examples-decisionmaker/src/site-docs/adoc/fragments/AnswerInitiationEvents.adoc new file mode 100644 index 000000000..98a876a1a --- /dev/null +++ b/examples/examples-decisionmaker/src/site-docs/adoc/fragments/AnswerInitiationEvents.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) +// + +== Initiation Events + +.Initiation Events +[source,json,options="nowrap"] +---- +include::{adsite-examples-decisionmaker-dir}/main/resources/config/AnswerInitiationEvents.txt[Initiation Events] +----
\ No newline at end of file diff --git a/examples/examples-decisionmaker/src/site-docs/adoc/fragments/ApexConfigRESTClient.adoc b/examples/examples-decisionmaker/src/site-docs/adoc/fragments/ApexConfigRESTClient.adoc new file mode 100644 index 000000000..51d0139d7 --- /dev/null +++ b/examples/examples-decisionmaker/src/site-docs/adoc/fragments/ApexConfigRESTClient.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: Rest Client + +.Config REst Client +[source,json,options="nowrap"] +---- +include::{adsite-examples-decisionmaker-dir}/main/resources/config/ApexConfigRESTClient.json[Config Rest Client] +----
\ No newline at end of file diff --git a/examples/examples-decisionmaker/src/site-docs/adoc/fragments/ApexConfigRESTServer.adoc b/examples/examples-decisionmaker/src/site-docs/adoc/fragments/ApexConfigRESTServer.adoc new file mode 100644 index 000000000..28051195c --- /dev/null +++ b/examples/examples-decisionmaker/src/site-docs/adoc/fragments/ApexConfigRESTServer.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 Config: REST Server + +.Config REST Server +[source,json,options="nowrap"] +---- +include::{adsite-examples-decisionmaker-dir}/main/resources/config/ApexConfigRESTServer.json[Config REST Server] +----
\ No newline at end of file diff --git a/examples/examples-decisionmaker/src/site-docs/adoc/fragments/DecisionMakerPolicyModel.adoc b/examples/examples-decisionmaker/src/site-docs/adoc/fragments/DecisionMakerPolicyModel.adoc new file mode 100644 index 000000000..7051abc7d --- /dev/null +++ b/examples/examples-decisionmaker/src/site-docs/adoc/fragments/DecisionMakerPolicyModel.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 Model (Policies) + +.APEX Model, Policies +[source,bash,options="nowrap"] +---- +include::{adsite-examples-decisionmaker-dir}/main/resources/policy/DecisionMakerPolicyModel.apex[APEX Model, Policies] +----
\ No newline at end of file diff --git a/examples/examples-decisionmaker/src/site-docs/adoc/fragments/DitheringAnswerTask.adoc b/examples/examples-decisionmaker/src/site-docs/adoc/fragments/DitheringAnswerTask.adoc new file mode 100644 index 000000000..c9322f837 --- /dev/null +++ b/examples/examples-decisionmaker/src/site-docs/adoc/fragments/DitheringAnswerTask.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) +// + +== Task Logic: Dithering Answer + +.Task Logic, Dithering Answer +[source,javascript,options="nowrap"] +---- +include::{adsite-examples-decisionmaker-dir}/main/resources/logic/DitheringAnswerTask.js[Task Logic: Dithering Answer] +----
\ No newline at end of file diff --git a/examples/examples-decisionmaker/src/site-docs/adoc/fragments/MakeDecisionExtraMode_Client.adoc b/examples/examples-decisionmaker/src/site-docs/adoc/fragments/MakeDecisionExtraMode_Client.adoc new file mode 100644 index 000000000..ee962481d --- /dev/null +++ b/examples/examples-decisionmaker/src/site-docs/adoc/fragments/MakeDecisionExtraMode_Client.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) +// + +== HTML Client: Extra Mode + +.HTML Client, Extra Mode +[source,html,options="nowrap"] +---- +include::{adsite-examples-decisionmaker-dir}/main/resources/html/MakeDecisionExtraMode_Client.html[HTML Client, Extra Mode] +----
\ No newline at end of file diff --git a/examples/examples-decisionmaker/src/site-docs/adoc/fragments/MakeDecisionExtraMode_Server.adoc b/examples/examples-decisionmaker/src/site-docs/adoc/fragments/MakeDecisionExtraMode_Server.adoc new file mode 100644 index 000000000..035e855ca --- /dev/null +++ b/examples/examples-decisionmaker/src/site-docs/adoc/fragments/MakeDecisionExtraMode_Server.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) +// + +== HTML Server: Extra Mode + +.HTML Server, Extra Mode +[source,html,options="nowrap"] +---- +include::{adsite-examples-decisionmaker-dir}/main/resources/html/MakeDecisionExtraMode_Server.html[HTML Server, Extra Mode] +----
\ No newline at end of file diff --git a/examples/examples-decisionmaker/src/site-docs/adoc/fragments/MakeDecisionStateTSL.adoc b/examples/examples-decisionmaker/src/site-docs/adoc/fragments/MakeDecisionStateTSL.adoc new file mode 100644 index 000000000..a74cc929d --- /dev/null +++ b/examples/examples-decisionmaker/src/site-docs/adoc/fragments/MakeDecisionStateTSL.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) +// + +== Task Selection Logic: Make Decision State + +.Task Selection Logic, Make Decision State +[source,javascript,options="nowrap"] +---- +include::{adsite-examples-decisionmaker-dir}/main/resources/logic/MakeDecisionStateTSL.js[Task Selection Logic: Make Decision State] +----
\ No newline at end of file diff --git a/examples/examples-decisionmaker/src/site-docs/adoc/fragments/MakeDecision_Client.adoc b/examples/examples-decisionmaker/src/site-docs/adoc/fragments/MakeDecision_Client.adoc new file mode 100644 index 000000000..deab6a86e --- /dev/null +++ b/examples/examples-decisionmaker/src/site-docs/adoc/fragments/MakeDecision_Client.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) +// + +== HTML Client + +.HTML Client +[source,html,options="nowrap"] +---- +include::{adsite-examples-decisionmaker-dir}/main/resources/html/MakeDecision_Client.html[HTML Client] +----
\ No newline at end of file diff --git a/examples/examples-decisionmaker/src/site-docs/adoc/fragments/MakeDecision_Server.adoc b/examples/examples-decisionmaker/src/site-docs/adoc/fragments/MakeDecision_Server.adoc new file mode 100644 index 000000000..25e624a19 --- /dev/null +++ b/examples/examples-decisionmaker/src/site-docs/adoc/fragments/MakeDecision_Server.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) +// + +== HTML Server + +.HTML Server +[source,html,options="nowrap"] +---- +include::{adsite-examples-decisionmaker-dir}/main/resources/html/MakeDecision_Server.html[HTML Server] +----
\ No newline at end of file diff --git a/examples/examples-decisionmaker/src/site-docs/adoc/fragments/OptimisticAnswerTask.adoc b/examples/examples-decisionmaker/src/site-docs/adoc/fragments/OptimisticAnswerTask.adoc new file mode 100644 index 000000000..8e889ed78 --- /dev/null +++ b/examples/examples-decisionmaker/src/site-docs/adoc/fragments/OptimisticAnswerTask.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) +// + +== Task Logic: Optimistic Answer + +.Task Logic, Optimistic Answer +[source,javascript,options="nowrap"] +---- +include::{adsite-examples-decisionmaker-dir}/main/resources/logic/OptimisticAnswerTask.js[Task Logic: Optimistic Answer] +----
\ No newline at end of file diff --git a/examples/examples-decisionmaker/src/site-docs/adoc/fragments/PessimisticAnswerTask.adoc b/examples/examples-decisionmaker/src/site-docs/adoc/fragments/PessimisticAnswerTask.adoc new file mode 100644 index 000000000..8bb8c8a08 --- /dev/null +++ b/examples/examples-decisionmaker/src/site-docs/adoc/fragments/PessimisticAnswerTask.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) +// + +== Task Logic: Pessimistic Answer + +.Task Logic, Pessimistic Answer +[source,javascript,options="nowrap"] +---- +include::{adsite-examples-decisionmaker-dir}/main/resources/logic/PessimisticAnswerTask.js[Task Logic: Pessimistic Answer] +----
\ No newline at end of file diff --git a/examples/examples-decisionmaker/src/site-docs/adoc/fragments/RandomAnswerTask.adoc b/examples/examples-decisionmaker/src/site-docs/adoc/fragments/RandomAnswerTask.adoc new file mode 100644 index 000000000..e75102e8d --- /dev/null +++ b/examples/examples-decisionmaker/src/site-docs/adoc/fragments/RandomAnswerTask.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) +// + +== Task Logic: Random Answer + +.Task Logic, Random Answer +[source,javascript,options="nowrap"] +---- +include::{adsite-examples-decisionmaker-dir}/main/resources/logic/RandomAnswerTask.js[Task Logic: Random Answer] +----
\ No newline at end of file diff --git a/examples/examples-decisionmaker/src/site-docs/adoc/fragments/RoundRobinAnswerTask.adoc b/examples/examples-decisionmaker/src/site-docs/adoc/fragments/RoundRobinAnswerTask.adoc new file mode 100644 index 000000000..f25e74c0a --- /dev/null +++ b/examples/examples-decisionmaker/src/site-docs/adoc/fragments/RoundRobinAnswerTask.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) +// + +== Task Logic: RoundRobin Answer + +.Task Logic, RoundRobin Answer +[source,javascript,options="nowrap"] +---- +include::{adsite-examples-decisionmaker-dir}/main/resources/logic/RoundRobinAnswerTask.js[Task Logic: RoundRobin Answer] +----
\ No newline at end of file diff --git a/examples/examples-decisionmaker/src/site-docs/adoc/fragments/dockerfile.adoc b/examples/examples-decisionmaker/src/site-docs/adoc/fragments/dockerfile.adoc new file mode 100644 index 000000000..14e40b2c2 --- /dev/null +++ b/examples/examples-decisionmaker/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-decisionmaker-dir}/../Dockerfile[Dockerfile] +----
\ No newline at end of file |