You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@unomi.apache.org by sh...@apache.org on 2020/02/16 20:42:35 UTC
[unomi] branch UNOMI-270-UNOMI-175-DATAMODEL-AND-PLUGIN-DOC
updated: UNOMI-270 & UNOMI-175 Data Model Documentation & Plugin vs
Extension clarification - Fix all internal references
This is an automated email from the ASF dual-hosted git repository.
shuber pushed a commit to branch UNOMI-270-UNOMI-175-DATAMODEL-AND-PLUGIN-DOC
in repository https://gitbox.apache.org/repos/asf/unomi.git
The following commit(s) were added to refs/heads/UNOMI-270-UNOMI-175-DATAMODEL-AND-PLUGIN-DOC by this push:
new 07113c0 UNOMI-270 & UNOMI-175 Data Model Documentation & Plugin vs Extension clarification - Fix all internal references
07113c0 is described below
commit 07113c0cd5c359cc3cbe15d01e60a4e0965c7fe9
Author: Serge Huber <sh...@apache.org>
AuthorDate: Sun Feb 16 21:42:25 2020 +0100
UNOMI-270 & UNOMI-175 Data Model Documentation & Plugin vs Extension clarification
- Fix all internal references
Signed-off-by: Serge Huber <sh...@apache.org>
---
manual/src/main/asciidoc/5-min-quickstart.adoc | 6 +++---
.../asciidoc/{action-types.adoc => builtin-action-types.adoc} | 0
.../asciidoc/{conditions.adoc => builtin-condition-types.adoc} | 0
manual/src/main/asciidoc/connectors/connectors.adoc | 4 ++--
manual/src/main/asciidoc/connectors/salesforce-connector.adoc | 2 +-
manual/src/main/asciidoc/datamodel.adoc | 8 ++++----
manual/src/main/asciidoc/getting-started.adoc | 10 +++++-----
manual/src/main/asciidoc/index.adoc | 4 ++--
manual/src/main/asciidoc/request-examples.adoc | 6 +++---
manual/src/main/asciidoc/samples/samples.adoc | 4 ++--
manual/src/main/asciidoc/writing-plugins.adoc | 4 ++--
11 files changed, 24 insertions(+), 24 deletions(-)
diff --git a/manual/src/main/asciidoc/5-min-quickstart.adoc b/manual/src/main/asciidoc/5-min-quickstart.adoc
index 98982f3..3725874 100644
--- a/manual/src/main/asciidoc/5-min-quickstart.adoc
+++ b/manual/src/main/asciidoc/5-min-quickstart.adoc
@@ -14,7 +14,7 @@
=== Five Minutes QuickStart
1) Install JDK 8 (https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) and make sure you set the
-JAVA_HOME variable https://docs.oracle.com/cd/E19182-01/820-7851/inst_cli_jdk_javahome_t/ (see our <<_jdk_compatibility,Getting Started>> guide for more information on JDK compatibility)
+JAVA_HOME variable https://docs.oracle.com/cd/E19182-01/820-7851/inst_cli_jdk_javahome_t/ (see our <<JDK compatibility,Getting Started>> guide for more information on JDK compatibility)
2) Download ElasticSearch here : https://www.elastic.co/downloads/past-releases/elasticsearch-7-4-2 (please <strong>make sure</strong> you use the proper version : 7.4.2)
@@ -40,5 +40,5 @@ make sure you are using the proper version.
Next steps:
- Connect to http://localhost:8181 to try our some live examples (such as the web tracker)
-- Trying our integration <<_samples,samples page>>
-- Learning more about the <<_web_tracker,web tracker>>
\ No newline at end of file
+- Trying our integration <<Samples,samples page>>
+- Learning more about the <<Web Tracker,web tracker>>
\ No newline at end of file
diff --git a/manual/src/main/asciidoc/action-types.adoc b/manual/src/main/asciidoc/builtin-action-types.adoc
similarity index 100%
rename from manual/src/main/asciidoc/action-types.adoc
rename to manual/src/main/asciidoc/builtin-action-types.adoc
diff --git a/manual/src/main/asciidoc/conditions.adoc b/manual/src/main/asciidoc/builtin-condition-types.adoc
similarity index 100%
rename from manual/src/main/asciidoc/conditions.adoc
rename to manual/src/main/asciidoc/builtin-condition-types.adoc
diff --git a/manual/src/main/asciidoc/connectors/connectors.adoc b/manual/src/main/asciidoc/connectors/connectors.adoc
index 961fc6a..b15e5ca 100644
--- a/manual/src/main/asciidoc/connectors/connectors.adoc
+++ b/manual/src/main/asciidoc/connectors/connectors.adoc
@@ -15,9 +15,9 @@
Apache Unomi provides the following connectors:
-* <<_salesforce_connector,Salesforce CRM connector>>
+* <<Salesforce Connector,Salesforce CRM connector>>
-* <<_mailchimp_connector,Mailchimp connector>>
+* <<MailChimp Connector,Mailchimp connector>>
==== Call for contributors
diff --git a/manual/src/main/asciidoc/connectors/salesforce-connector.adoc b/manual/src/main/asciidoc/connectors/salesforce-connector.adoc
index c1f6b6c..afb732b 100644
--- a/manual/src/main/asciidoc/connectors/salesforce-connector.adoc
+++ b/manual/src/main/asciidoc/connectors/salesforce-connector.adoc
@@ -112,7 +112,7 @@ Both URLs are password protected by the Apache Unomi (Karaf) password. You can f
in the etc/users.properties file.
You can now use the connectors's defined actions in rules to push or pull data to/from the Salesforce CRM. You can
-find more information about rules in the <<_concepts,Concepts>> and the <<_getting_started_with_unomi,Getting Started>> pages.
+find more information about rules in the <<Data Model Overview,Data Model>> and the <<Getting started with Unomi,Getting Started>> pages.
==== Properties
diff --git a/manual/src/main/asciidoc/datamodel.adoc b/manual/src/main/asciidoc/datamodel.adoc
index 507b6f7..fe484d0 100755
--- a/manual/src/main/asciidoc/datamodel.adoc
+++ b/manual/src/main/asciidoc/datamodel.adoc
@@ -555,7 +555,7 @@ Inherits all the fields from: MetadataItem
|===
| *Field name* | *Type* | *Description*
-| condition | Condition | The root condition for the segment. Conditions may be composed by using built-in conditions such as `booleanCondition` that can accept sub-conditions.
+| condition | Condition | The root condition for the segment. Conditions may be composed by using built-in condition types such as `booleanCondition` that can accept sub-conditions.
|===
@@ -658,7 +658,7 @@ The result of a condition is always a boolean value of true or false.
Apache Unomi provides quite a lot of built-in condition types, including boolean types that make it possible to compose conditions using operators such as `and`, `or` or `not`.
Composition is an essential element of building more complex conditions.
-For a more complete list of available conditions, see the <<Built-in conditions>> reference section.
+For a more complete list of available condition types, see the <<Built-in condition types>> reference section.
==== Structure definition
@@ -737,7 +737,7 @@ Inherits all the fields from: MetadataItem
|===
| *Field name* | *Type* | *Description*
-| condition | Condition | The root condition for the rule. Conditions may be composed by using built-in conditions such as `booleanCondition` that can accept sub-conditions.
+| condition | Condition | The root condition for the rule. Conditions may be composed by using built-in condition types such as `booleanCondition` that can accept sub-conditions.
| action | Action array | A list of <<Action>> object that will be executed if the condition is true.
@@ -801,7 +801,7 @@ calling web hooks, setting profile properties, extracting data from the incoming
an IP address), or even pulling and/or pushing data to third-party systems such as a CRM server.
Apache Unomi also comes with built-in actions.
-You may find the list of built-in actions in the <<Built-in actions>> section.
+You may find the list of built-in actions in the <<Built-in action types>> section.
==== Structure definition
diff --git a/manual/src/main/asciidoc/getting-started.adoc b/manual/src/main/asciidoc/getting-started.adoc
index d5fb13a..52f5d0c 100644
--- a/manual/src/main/asciidoc/getting-started.adoc
+++ b/manual/src/main/asciidoc/getting-started.adoc
@@ -18,8 +18,7 @@ in greater details what just happened.
==== Prerequisites
-This document assumes that you are already familiar with Unomi's <<_concepts,concepts>>. On the technical side, we
-also assume working knowledge of https://git-scm.com/[git] to be able to retrieve the code for Unomi and the example.
+This document assumes working knowledge of https://git-scm.com/[git] to be able to retrieve the code for Unomi and the example.
Additionally, you will require a working Java 8 or above install. Refer to http://www.oracle.com/technetwork/java/javase/[http://www.oracle.com/technetwork/java/javase/] for details on how to download and install Java SE 8 or greater.
===== JDK compatibility
@@ -45,8 +44,8 @@ to get the latest information about ElasticSearch version compatibility.
===== Start Unomi
-Start Unomi according to the <<_five_minutes_quickstart,five minutes quick start>> or by compiling using the
-<<_building,building instructions>>. Once you have Karaf running,
+Start Unomi according to the <<Five Minutes QuickStart,five minutes quick start>> or by compiling using the
+<<Building,building instructions>>. Once you have Karaf running,
you should wait until you see the following messages on the Karaf console:
[source]
@@ -66,5 +65,6 @@ available RESTful services or retrieve an initial context at `http://localhost:8
You can now find an introduction page at the following location: http://localhost:8181
-Also now that your service is up and running you can go look at the <<_request-examples,request examples>> to learn basic
+Also now that your service is up and running you can go look at the
+<<Request examples,request examples>> to learn basic
requests you can do once your server is up and running.
\ No newline at end of file
diff --git a/manual/src/main/asciidoc/index.adoc b/manual/src/main/asciidoc/index.adoc
index a88b793..49fb4fb 100644
--- a/manual/src/main/asciidoc/index.adoc
+++ b/manual/src/main/asciidoc/index.adoc
@@ -74,9 +74,9 @@ include::new-data-model.adoc[]
include::builtin-event-types.adoc[]
-include::conditions.adoc[]
+include::builtin-condition-types.adoc[]
-include::action-types.adoc[]
+include::builtin-action-types.adoc[]
== Integration samples
diff --git a/manual/src/main/asciidoc/request-examples.adoc b/manual/src/main/asciidoc/request-examples.adoc
index d4afd5a..49fba3f 100644
--- a/manual/src/main/asciidoc/request-examples.adoc
+++ b/manual/src/main/asciidoc/request-examples.adoc
@@ -154,6 +154,6 @@ to send additional events.
==== Where to go from here
-* You can find more <<_useful_apache_unomi_urls,useful Apache Unomi URLs>> that can be used in the same way as the above examples.
-* You may want to know integrate the provided <<_web_tracker,web tracker>> into your web site.
-* Read the <<_twitter_sample,Twitter sample>> documentation that contains a detailed example of how to integrate with Apache Unomi.
\ No newline at end of file
+* You can find more <<Useful Apache Unomi URLs,useful Apache Unomi URLs>> that can be used in the same way as the above examples.
+* You may want to know integrate the provided <<Web Tracker,web tracker>> into your web site.
+* Read the <<Twitter sample,Twitter sample>> documentation that contains a detailed example of how to integrate with Apache Unomi.
\ No newline at end of file
diff --git a/manual/src/main/asciidoc/samples/samples.adoc b/manual/src/main/asciidoc/samples/samples.adoc
index 39fdd76..fc44885 100644
--- a/manual/src/main/asciidoc/samples/samples.adoc
+++ b/manual/src/main/asciidoc/samples/samples.adoc
@@ -15,5 +15,5 @@
Apache Unomi provides the following samples:
-* <<_twitter_sample,Twitter integration>>
-* <<_login_sample,Login integration>>
+* <<Twitter sample,Twitter integration>>
+* <<Login sample,Login integration>>
diff --git a/manual/src/main/asciidoc/writing-plugins.adoc b/manual/src/main/asciidoc/writing-plugins.adoc
index f29daf8..8d2783c 100644
--- a/manual/src/main/asciidoc/writing-plugins.adoc
+++ b/manual/src/main/asciidoc/writing-plugins.adoc
@@ -135,8 +135,8 @@ Definition for values that can be assigned to properties ("primitive" types).
=== Custom plugins
Apache Unomi is a pluggeable server that may be extended in many ways. This document assumes you are familiar with the
-<<_concepts,Apache Unomi concepts>> . This document is mostly a reference document on the different things that may
-be used inside an extension. If you are looking for complete samples, please see the <<_samples,samples page>>.
+<<Data Model Overview,Apache Unomi Data Model>> . This document is mostly a reference document on the different things that may
+be used inside an extension. If you are looking for complete samples, please see the <<Samples,samples page>>.
==== Creating a plugin