You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flagon.apache.org by po...@apache.org on 2019/06/29 02:22:28 UTC
[incubator-flagon] branch master updated: copying over _site to
content
This is an automated email from the ASF dual-hosted git repository.
poorejc pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-flagon.git
The following commit(s) were added to refs/heads/master by this push:
new 8aa28a9 copying over _site to content
8aa28a9 is described below
commit 8aa28a9da7fd2bb7e77e0bdc99dd692c182598fc
Author: poorejc <po...@apache.org>
AuthorDate: Fri Jun 28 22:22:12 2019 -0400
copying over _site to content
---
content/community/index.html | 2 +-
content/distill/index.html | 2 +-
content/docs/contributing/index.html | 12 +-
content/docs/distill/analytics.html | 12 +-
content/docs/distill/api.html | 12 +-
content/docs/distill/changelog.html | 12 +-
content/docs/distill/http.html | 12 +-
content/docs/distill/index.html | 12 +-
content/docs/distill/models.html | 12 +-
content/docs/distill/start.html | 12 +-
content/docs/distill/utilities.html | 12 +-
content/docs/index.html | 12 +-
content/docs/stack/index.html | 12 +-
content/docs/stack/scaling/index.html | 12 +-
content/docs/stout/index.html | 12 +-
content/docs/stout/start.html | 12 +-
content/docs/tap/index.html | 12 +-
content/docs/userale/index.html | 12 +-
content/docs/useralejs/API/index.html | 476 ++++++++++++++++
.../docs/useralejs/build/index.html | 211 +++----
content/docs/useralejs/dataschema/index.html | 604 +++++++++++++++++++++
content/docs/useralejs/index.html | 16 +-
content/docs/useralejs/modifying/index.html | 463 ++++++++++++++++
.../docs/useralejs/troubleshooting/index.html | 40 +-
content/docs/useralepy/api.html | 12 +-
content/docs/useralepy/changelog.html | 12 +-
content/docs/useralepy/index.html | 12 +-
content/docs/useralepy/start.html | 12 +-
content/feed.xml | 2 +-
content/index.html | 2 +-
content/releases/index.html | 36 +-
content/stack/index.html | 2 +-
content/stout/index.html | 2 +-
content/tap/index.html | 2 +-
content/userale/index.html | 2 +-
site/_site/community/index.html | 2 +-
site/_site/distill/index.html | 2 +-
site/_site/docs/contributing/index.html | 12 +-
site/_site/docs/distill/analytics.html | 12 +-
site/_site/docs/distill/api.html | 12 +-
site/_site/docs/distill/changelog.html | 12 +-
site/_site/docs/distill/http.html | 12 +-
site/_site/docs/distill/index.html | 12 +-
site/_site/docs/distill/models.html | 12 +-
site/_site/docs/distill/start.html | 12 +-
site/_site/docs/distill/utilities.html | 12 +-
site/_site/docs/index.html | 12 +-
site/_site/docs/stack/index.html | 12 +-
site/_site/docs/stack/scaling/index.html | 12 +-
site/_site/docs/stout/index.html | 12 +-
site/_site/docs/stout/start.html | 12 +-
site/_site/docs/tap/index.html | 12 +-
site/_site/docs/userale/index.html | 12 +-
site/_site/docs/useralejs/API/index.html | 476 ++++++++++++++++
.../utilities.html => useralejs/build/index.html} | 211 +++----
site/_site/docs/useralejs/dataschema/index.html | 604 +++++++++++++++++++++
site/_site/docs/useralejs/index.html | 16 +-
site/_site/docs/useralejs/modifying/index.html | 463 ++++++++++++++++
.../troubleshooting/index.html} | 40 +-
site/_site/docs/useralepy/api.html | 12 +-
site/_site/docs/useralepy/changelog.html | 12 +-
site/_site/docs/useralepy/index.html | 12 +-
site/_site/docs/useralepy/start.html | 12 +-
site/_site/feed.xml | 2 +-
site/_site/index.html | 2 +-
site/_site/releases/index.html | 36 +-
site/_site/stack/index.html | 2 +-
site/_site/stout/index.html | 2 +-
site/_site/tap/index.html | 2 +-
site/_site/userale/index.html | 2 +-
70 files changed, 3650 insertions(+), 554 deletions(-)
diff --git a/content/community/index.html b/content/community/index.html
index bdd134c..6f7099a 100644
--- a/content/community/index.html
+++ b/content/community/index.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
diff --git a/content/distill/index.html b/content/distill/index.html
index 32e1e74..e52868d 100644
--- a/content/distill/index.html
+++ b/content/distill/index.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
diff --git a/content/docs/contributing/index.html b/content/docs/contributing/index.html
index 24d6254..2abc170 100644
--- a/content/docs/contributing/index.html
+++ b/content/docs/contributing/index.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/content/docs/distill/analytics.html b/content/docs/distill/analytics.html
index 90bc760..4e8620e 100644
--- a/content/docs/distill/analytics.html
+++ b/content/docs/distill/analytics.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/content/docs/distill/api.html b/content/docs/distill/api.html
index cc7e1a9..78ea91a 100644
--- a/content/docs/distill/api.html
+++ b/content/docs/distill/api.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/content/docs/distill/changelog.html b/content/docs/distill/changelog.html
index 39c543f..802a8c7 100644
--- a/content/docs/distill/changelog.html
+++ b/content/docs/distill/changelog.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/content/docs/distill/http.html b/content/docs/distill/http.html
index 80d94f5..e2171a8 100644
--- a/content/docs/distill/http.html
+++ b/content/docs/distill/http.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/content/docs/distill/index.html b/content/docs/distill/index.html
index dcc37bd..7268156 100644
--- a/content/docs/distill/index.html
+++ b/content/docs/distill/index.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/content/docs/distill/models.html b/content/docs/distill/models.html
index 1ec0761..a4112d1 100644
--- a/content/docs/distill/models.html
+++ b/content/docs/distill/models.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/content/docs/distill/start.html b/content/docs/distill/start.html
index d4562fe..a546d67 100644
--- a/content/docs/distill/start.html
+++ b/content/docs/distill/start.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/content/docs/distill/utilities.html b/content/docs/distill/utilities.html
index e688eac..3cff8fc 100644
--- a/content/docs/distill/utilities.html
+++ b/content/docs/distill/utilities.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/content/docs/index.html b/content/docs/index.html
index 4b5be6e..43e647c 100644
--- a/content/docs/index.html
+++ b/content/docs/index.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/content/docs/stack/index.html b/content/docs/stack/index.html
index e71a83a..c8c1f89 100644
--- a/content/docs/stack/index.html
+++ b/content/docs/stack/index.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/content/docs/stack/scaling/index.html b/content/docs/stack/scaling/index.html
index b58dc5d..6b544ab 100644
--- a/content/docs/stack/scaling/index.html
+++ b/content/docs/stack/scaling/index.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/content/docs/stout/index.html b/content/docs/stout/index.html
index 13b6ac9..b12ebe4 100644
--- a/content/docs/stout/index.html
+++ b/content/docs/stout/index.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/content/docs/stout/start.html b/content/docs/stout/start.html
index 137e72c..ad8b1b3 100644
--- a/content/docs/stout/start.html
+++ b/content/docs/stout/start.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/content/docs/tap/index.html b/content/docs/tap/index.html
index 091d3cd..37dfa06 100644
--- a/content/docs/tap/index.html
+++ b/content/docs/tap/index.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/content/docs/userale/index.html b/content/docs/userale/index.html
index 377e683..03d8c34 100644
--- a/content/docs/userale/index.html
+++ b/content/docs/userale/index.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/content/docs/useralejs/API/index.html b/content/docs/useralejs/API/index.html
new file mode 100644
index 0000000..96f1f9a
--- /dev/null
+++ b/content/docs/useralejs/API/index.html
@@ -0,0 +1,476 @@
+<!DOCTYPE html>
+<html lang="en">
+
+ <head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1">
+
+ <title>The UserALE.js API</title>
+ <meta name="description" content="Apache UserALE.js features a robust API that allows you customize official Apache Flagon UserALE.js builds page-by-page to suite your needs.">
+
+ <link rel="stylesheet" type="text/css" href="/semantic/dist/semantic.min.css">
+ <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.1/jquery.min.js"></script>
+ <script src="/semantic/dist/semantic.min.js"></script>
+ <script src="https://d3js.org/d3.v4.min.js"></script>
+ <script src="/js/main.js"></script>
+
+ <link rel="stylesheet" href="/assets/main.css">
+ <link rel="canonical" href="http://flagon.incubator.apache.org/docs/useralejs/API/">
+ <link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
+
+
+</head>
+
+
+ <body>
+
+ <div class="site-header">
+ <div id="main-menu" class="ui inverted padded fixed top borderless menu">
+ <a class="site-title" href="/">
+ <h3 class="ui inverted header item">Apache Flagon</h3>
+ </a>
+
+ <div class="right menu">
+ <div class="ui dropdown item">
+ Products
+ <div class="menu">
+ <a class="item" href="/stack">Stack</a>
+ <a class="item" href="/userale">UserALE</a>
+ <a class="item" href="/distill">Distill</a>
+ <a class="item" href="/tap">Tap</a>
+ <a class="item" href="/stout">Stout</a>
+ </div>
+ </div>
+ <div class="ui dropdown item">
+ <a href="/docs">Docs</a>
+ <div class="menu">
+ <a class="item" href="/docs/stack">Stack</a>
+ <a class="item" href="/docs/userale">UserALE</a>
+ <a class="item" href="/docs/useralejs">UserALE.js</a>
+ <a class="item" href="/docs/useralepy">UserALE.py</a>
+ <a class="item" href="/docs/distill">Distill</a>
+ <a class="item" href="/docs/tap">Tap</a>
+ <a class="item" href="/docs/stout">Stout</a>
+ </div>
+ </div>
+ <a class="item" href="/releases">Releases</a>
+ <a class="item" href="/community">Community</a>
+ </div>
+ </div>
+</div>
+
+
+ <div class="main-wrapper">
+ <div class="docs-wrapper">
+ <div class="docs-sidebar">
+
+
+
+
+
+
+
+
+
+<!-- <div class="ui inverted list">
+ <a class="item" href="/docs">About the Docs</a>
+</div> -->
+<div id="docs-nav" class="ui inverted accordion">
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ Apache Flagon
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/">About the Docs</a>
+
+ <a class="item" href="/docs/contributing/">Contributing</a>
+
+ </div>
+ </div>
+
+
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ Stack
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/stack/">Getting Started</a>
+
+ <a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
+
+ </div>
+ </div>
+
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ UserALE
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/userale/">About UserALE</a>
+
+ </div>
+ </div>
+
+
+ <div class="active title">
+
+ <i class="dropdown icon"></i>
+ UserALE.js
+ </div>
+
+ <div class="active content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/useralejs/">Getting Started</a>
+
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
+
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
+
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
+
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
+
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
+
+ </div>
+ </div>
+
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ UserALE.py
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/useralepy/">Installation</a>
+
+ <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
+
+ <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
+
+ <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
+
+ </div>
+ </div>
+
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ Distill
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/distill/">Installation</a>
+
+ <a class="item" href="/docs/distill/start.html">Getting Started</a>
+
+ <a class="item" href="/docs/distill/api.html">API Documentation</a>
+
+ <a class="item" href="/docs/distill/analytics.html">Apache Distill Analytics</a>
+
+ <a class="item" href="/docs/distill/http.html">Apache Distill HTTP Client</a>
+
+ <a class="item" href="/docs/distill/models.html">Apache Distill Models</a>
+
+ <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a>
+
+ <a class="item" href="/docs/distill/changelog.html">Changelog</a>
+
+ </div>
+ </div>
+
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ Tap
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/tap/">Getting Started</a>
+
+ </div>
+ </div>
+
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ Stout
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/stout/">About Stout</a>
+
+ <a class="item" href="/docs/stout/start.html">Getting Started</a>
+
+ </div>
+ </div>
+</div>
+
+ </div>
+ <div class="docs-content">
+ <h2 class="ui header">The UserALE.js API</h2>
+ <p><a href="https://github.com/apache/incubator-flagon-useralejs">Apache UserALE.js</a> features a robust API that allows you
+customize official Apache Flagon UserALE.js <a href="https://github.com/apache/incubator-flagon-useralejs/tree/master/build">builds</a> page-by-page to suite your needs.</p>
+
+<p>The API exposes two functions: <code class="highlighter-rouge">setLogFilter</code> & <code class="highlighter-rouge">setLogMapper</code>. With these two powerful functions, you have a lot of
+latitude in customizing and curating your logs.</p>
+
+<h1 id="api-usage">API Usage</h1>
+
+<p>To invoke the API, simply add additional javascript code blocks under your UserALE.js script tag.</p>
+
+<p>Don’t forget to add the UserALE.js script tag:</p>
+
+<div class="language-html highlighter-rouge"><pre class="highlight"><code><span class="nt"><head></span>
+ <span class="nt"><title></span>UserAleJS - Example Page<span class="nt"></title></span>
+ <span class="c"><!--
+ Add the UserALE.js script tag to the top of your doc
+ --></span>
+ <span class="nt"><script </span><span class="na">src=</span><span class="s">"/path/to/userale-1.0.0.min.js"</span> <span class="na">data-url=</span><span class="s">"http://yourLoggingUrl"</span><span class="nt">></script></span>
+</code></pre>
+</div>
+
+<h2 id="setlogfilter-examples"><code class="highlighter-rouge">setLogFilter</code> Examples</h2>
+
+<p><code class="highlighter-rouge">setLogFilter</code> allows you to eliminate log data you don’t need or want from your log stream:</p>
+
+<div class="language-html highlighter-rouge"><pre class="highlight"><code><span class="c"><!--
+Add additional code blocks to set the filters you want
+This simple array filter pulls mouseover data out of your log stream
+--></span>
+ <span class="nt"><script </span><span class="na">type=</span><span class="s">"text/javascript"</span><span class="nt">></span>
+ <span class="nb">window</span><span class="p">.</span><span class="nx">userale</span><span class="p">.</span><span class="nx">filter</span><span class="p">(</span><span class="kd">function</span> <span class="p">(</span><span class="nx">log</span><span class="p">)</span> <span class="p">{</span>
+ <span class="k">return</span> <span class="p">(</span><span class="nx">log</span><span class="p">.</span><span class="nx">type</span> <span class="o">!=</span> <span class="s1">'mouseover'</span><span class="p">);</span>
+ <span class="p">});</span>
+ <span class="nt"></script></span>
+</code></pre>
+</div>
+
+<p>Here is one UserALE.js filter to rule them all!</p>
+
+<div class="language-html highlighter-rouge"><pre class="highlight"><code><span class="c"><!--
+Modify the array page-by-page to curate your log stream:
+by adding unwanted event 'types' in type_array;
+by adding unwanted log classes to eliminate 'raw' or 'interval' logs from your stream.
+--></span>
+ <span class="nt"><script </span><span class="na">type=</span><span class="s">"text/javascript"</span><span class="nt">></span>
+ <span class="kd">var</span> <span class="nx">type_array</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'mouseup'</span><span class="p">,</span> <span class="s1">'mouseover'</span><span class="p">,</span> <span class="s1">'dblclick'</span><span class="p">,</span> <span class="s1">'blur'</span><span class="p">,</span> <span class="s1">'focus'</span><span class="p">]</span>
+ <span class="kd">var</span> <span class="nx">logType_array</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'interval'</span><span class="p">]</span>
+ <span class="nb">window</span><span class="p">.</span><span class="nx">userale</span><span class="p">.</span><span class="nx">filter</span><span class="p">(</span><span class="kd">function</span> <span class="p">(</span><span class="nx">log</span><span class="p">)</span> <span class="p">{</span>
+ <span class="k">return</span> <span class="o">!</span><span class="nx">type_array</span><span class="p">.</span><span class="nx">includes</span><span class="p">(</span><span class="nx">log</span><span class="p">.</span><span class="nx">type</span><span class="p">)</span> <span class="o">&&</span> <span class="o">!</span><span class="nx">logType_array</span><span class="p">.</span><span class="nx">includes</span><span class="p">(</span><span class="nx">log</span><span class= [...]
+ <span class="p">});</span>
+ <span class="nt"></script></span>
+</code></pre>
+</div>
+
+<p>You can also use the <code class="highlighter-rouge">setLogFilter</code> function to do other cool stuff. Below is an example for how to further modify the
+rate at which UserALE.js collects data, but dropping every other log (odd-even) in the logging queue.</p>
+
+<div class="language-html highlighter-rouge"><pre class="highlight"><code> <span class="nt"><script </span><span class="na">type=</span><span class="s">"text/javascript"</span><span class="nt">></span>
+ <span class="kd">var</span> <span class="nx">logCounter</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
+ <span class="nb">window</span><span class="p">.</span><span class="nx">userale</span><span class="p">.</span><span class="nx">filter</span><span class="p">(</span><span class="kd">function</span> <span class="p">(</span><span class="nx">log</span><span class="p">)</span> <span class="p">{</span>
+ <span class="k">return</span> <span class="p">(</span><span class="nx">logCounter</span><span class="o">++</span> <span class="o">%</span> <span class="mi">2</span><span class="p">);</span>
+ <span class="p">});</span>
+ <span class="nt"></script></span>
+</code></pre>
+</div>
+
+<h2 id="setlogmapper-examples"><code class="highlighter-rouge">setLogMapper</code> Examples</h2>
+
+<p><code class="highlighter-rouge">setLogMapper</code> allows you to modify or add new fields to UserALE.js logs.</p>
+
+<p>This simple mapping function adds a new log field for custom labels you want to attach to certain elements:</p>
+
+<div class="language-html highlighter-rouge"><pre class="highlight"><code><span class="c"><!--
+This will add your label to all event logs that reference a particular DOM target.
+--></span>
+ <span class="nt"><script </span><span class="na">type=</span><span class="s">"text/javascript"</span><span class="nt">></span>
+ <span class="nb">window</span><span class="p">.</span><span class="nx">userale</span><span class="p">.</span><span class="nx">map</span><span class="p">(</span><span class="kd">function</span> <span class="p">(</span><span class="nx">log</span><span class="p">)</span> <span class="p">{</span>
+ <span class="kd">var</span> <span class="nx">targetsForLabels</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"button#test_button"</span><span class="p">];</span>
+ <span class="k">if</span> <span class="p">(</span><span class="nx">targetsForLabels</span><span class="p">.</span><span class="nx">includes</span><span class="p">(</span><span class="nx">log</span><span class="p">.</span><span class="nx">target</span><span class="p">))</span> <span class="p">{</span>
+ <span class="k">return</span> <span class="nb">Object</span><span class="p">.</span><span class="nx">assign</span><span class="p">({},</span> <span class="nx">log</span><span class="p">,</span> <span class="p">{</span> <span class="na">CustomLabel</span><span class="p">:</span> <span class="s2">"Click me!"</span> <span class="p">});</span>
+ <span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
+ <span class="k">return</span> <span class="nx">log</span><span class="p">;</span>
+ <span class="p">}</span>
+ <span class="p">});</span>
+ <span class="nt"></script></span>
+</code></pre>
+</div>
+
+<p>This cool mapping function adds a progressive count on a given element (“app”) and writes to a new log field
+called “score”</p>
+
+<div class="language-html highlighter-rouge"><pre class="highlight"><code> <span class="nt"></head></span>
+ <span class="nt"><body></span>
+ <span class="nt"><div</span> <span class="na">id=</span><span class="s">"app"</span><span class="nt">></span>
+ <span class="nt"><button</span> <span class="na">id=</span><span class="s">"increment"</span><span class="nt">></span>+<span class="nt"></button></span>
+ <span class="nt"><button</span> <span class="na">id=</span><span class="s">"decrement"</span><span class="nt">></span>-<span class="nt"></button></span>
+ <span class="nt"><div</span> <span class="na">id=</span><span class="s">"scoreboard"</span><span class="nt">></div></span>
+ <span class="nt"></div></span>
+ <span class="nt"></script></span>
+
+ <span class="nt"><script </span><span class="na">type=</span><span class="s">"text/javascript"</span><span class="nt">></span>
+ <span class="kd">var</span> <span class="nx">score</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
+ <span class="kd">var</span> <span class="nx">scoreBoard</span> <span class="o">=</span> <span class="nb">document</span><span class="p">.</span><span class="nx">getElementById</span><span class="p">(</span><span class="s1">'scoreboard'</span><span class="p">);</span>
+ <span class="nx">scoreBoard</span><span class="p">.</span><span class="nx">innerText</span> <span class="o">=</span> <span class="s1">'0'</span><span class="p">;</span>
+
+ <span class="kd">function</span> <span class="nx">setScore</span><span class="p">(</span><span class="nx">nextScore</span><span class="p">)</span> <span class="p">{</span>
+ <span class="nx">score</span> <span class="o">=</span> <span class="nx">nextScore</span><span class="p">;</span>
+ <span class="nx">scoreBoard</span><span class="p">.</span><span class="nx">innerText</span> <span class="o">=</span> <span class="nb">String</span><span class="p">(</span><span class="nx">score</span><span class="p">);</span>
+ <span class="p">}</span>
+
+ <span class="nb">document</span><span class="p">.</span><span class="nx">getElementById</span><span class="p">(</span><span class="s1">'increment'</span><span class="p">).</span><span class="nx">addEventListener</span><span class="p">(</span><span class="s1">'click'</span><span class="p">,</span> <span class="kd">function</span> <span class="p">()</span> <span class="p">{</span>
+ <span class="nx">setScore</span><span class="p">(</span><span class="nx">score</span> <span class="o">+</span> <span class="mi">1</span><span class="p">);</span>
+ <span class="p">});</span>
+
+ <span class="nb">document</span><span class="p">.</span><span class="nx">getElementById</span><span class="p">(</span><span class="s1">'decrement'</span><span class="p">).</span><span class="nx">addEventListener</span><span class="p">(</span><span class="s1">'click'</span><span class="p">,</span> <span class="kd">function</span> <span class="p">()</span> <span class="p">{</span>
+ <span class="k">if</span> <span class="p">(</span><span class="nx">score</span><span class="p">)</span> <span class="p">{</span>
+ <span class="nx">setScore</span><span class="p">(</span><span class="nx">score</span> <span class="o">-</span> <span class="mi">1</span><span class="p">);</span>
+ <span class="p">}</span>
+ <span class="p">});</span>
+
+ <span class="nb">window</span><span class="p">.</span><span class="nx">userale</span><span class="p">.</span><span class="nx">map</span><span class="p">(</span><span class="kd">function</span> <span class="p">(</span><span class="nx">log</span><span class="p">)</span> <span class="p">{</span>
+ <span class="k">return</span> <span class="nb">Object</span><span class="p">.</span><span class="nx">assign</span><span class="p">({},</span> <span class="nx">log</span><span class="p">,</span> <span class="p">{</span> <span class="na">score</span><span class="p">:</span> <span class="nx">score</span> <span class="p">});</span> <span class="c1">// Add the "score" property to the log</span>
+ <span class="p">});</span>
+ <span class="nt"></script></span>
+ <span class="nt"></body></span>
+<span class="nt"></html></span>
+
+</code></pre>
+</div>
+
+<p>Test these examples out in our UserALE.js <a href="https://github.com/apache/incubator-flagon-useralejs/blob/master/example/index.html">example page</a> test utility!</p>
+
+<h3 id="benefits-of-the-useralejs-api">Benefits of the UserALE.js API</h3>
+<ul>
+ <li>No need to dig into our source code</li>
+ <li>Version control is easy and no need to sweat merges–just download the latest <a href="/releases">release</a>,
+ or update via <a href="https://www.npmjs.com/package/flagon-userale">npm</a>.</li>
+ <li>Manage logs page-by-page, ideal for large or complex sites</li>
+ <li>Use basic or best-practice JS styles and methods to build your own filters, no need to learn weird custom syntax.</li>
+</ul>
+
+<h2 id="contributing">Contributing</h2>
+
+<p>Contributions are welcome! Simply <a href="https://issues.apache.org/jira/browse/FLAGON">submit an issue report</a> for problems
+you encounter or a pull request for your feature or bug fix. The core team will review it and work with you to
+incorporate it into UserALE.js.</p>
+
+ </div>
+</div>
+
+ </div>
+
+ <div class="footer ui inverted very padded vertical segment">
+ <div class="ui vertical segment">
+ <div class="ui four column grid">
+ <div class="column">
+ <h4 class="ui inverted header">About</h4>
+ <div class="ui inverted link list">
+ <a class="item" href="/stack">Stack</a>
+ <a class="item" href="/userale">UserALE</a>
+ <a class="item" href="/distill">Distill</a>
+ <a class="item" href="/tap">Tap</a>
+ <a class="item" href="/stout">Stout</a>
+ </div>
+ </div>
+ <div class="column">
+ <h4 class="ui inverted header">Docs</h4>
+ <div class="ui inverted link list">
+ <a class="item" href="/docs/stack">Stack</a>
+ <a class="item" href="/docs/userale">UserALE</a>
+ <a class="item" href="/docs/useralejs">UserAle.js</a>
+ <a class="item" href="/docs/useralepy">UserAle.py</a>
+ <a class="item" href="/docs/distill">Distill</a>
+ <a class="item" href="/docs/tap">Tap</a>
+ <a class="item" href="/docs/stout">Stout</a>
+ </div>
+ </div>
+ <div class="column">
+ <h4 class="ui inverted header">Community</h4>
+ <div class="ui inverted link list">
+ <a class="item" href="https://github.com/apache?q=flagon">GitHub</a>
+ <a class="item" href="http://stackoverflow.com/questions/tagged/apache-flagon">StackOverflow</a>
+ <a class="item" href="https://issues.apache.org/jira/browse/FLAGON">Jira Issue Tracker</a>
+ <a class="item" href="https://cwiki.apache.org/confluence/display/FLAGON">Project Wiki</a>
+ <a class="item" href="https://twitter.com/ApacheFlagon">Twitter</a>
+ </div>
+ </div>
+ <div class="column">
+ <h4 class="ui inverted header">Apache</h4>
+ <div class="ui inverted link list">
+ <a class="item" href="http://www.apache.org/">Apache Software Foundation</a>
+ <a class="item" href="http://www.apache.org/licenses/">License</a>
+ <a class="item" href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
+ <a class="item" href="http://www.apache.org/foundation/thanks.html">Thanks</a>
+ <a class="item" href="http://www.apache.org/security/">Security</a>
+ </div>
+ </div>
+ </div>
+ </div>
+ <div class="ui inverted vertical segment">
+ <div class="ui two column middle aligned grid">
+ <div class="column">
+ Apache Flagon is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the [...]
+ </div>
+ <div class="center aligned column">
+ Copyright © 2019 The Apache Software Foundation, Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.<br>
+ Apache Flagon, Flagon, Apache, the Apache feather logo, the Apache Flagon logo and the Apache Incubator logo are trademarks of The Apache Software Foundation.
+ </div>
+ </div>
+ </div>
+ <div class="ui inverted vertical segment">
+ <div class="ui one column middle aligned grid">
+ <div class="center aligned column">
+ <a href="http://incubator.apache.org/">
+ <img src="/images/incubator-logo-white.jpg">
+ </a>
+ <a href="https://www.apache.org/events/current-event.html">
+ <img src="https://www.apache.org/events/current-event-234x60.png" alt="ASF Current Event">
+ </a>
+ </div>
+ </div>
+ </div>
+</div>
+
+
+ </body>
+
+</html>
diff --git a/site/_site/docs/distill/utilities.html b/content/docs/useralejs/build/index.html
similarity index 67%
copy from site/_site/docs/distill/utilities.html
copy to content/docs/useralejs/build/index.html
index e688eac..acf5509 100644
--- a/site/_site/docs/distill/utilities.html
+++ b/content/docs/useralejs/build/index.html
@@ -6,8 +6,8 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
- <title>Apache Distill Utilities</title>
- <meta name="description" content="Query Builder class distill.utils.query_builder.QueryBuilder(query=None)">
+ <title>UserALE.js Build and Test</title>
+ <meta name="description" content="To build Apache UserALE.js, you will need to clone our repo and install NPM and Node.js.">
<link rel="stylesheet" type="text/css" href="/semantic/dist/semantic.min.css">
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.1/jquery.min.js"></script>
@@ -16,7 +16,7 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://flagon.incubator.apache.org/docs/distill/utilities.html">
+ <link rel="canonical" href="http://flagon.incubator.apache.org/docs/useralejs/build/">
<link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -131,27 +131,27 @@
</div>
- <div class="title">
+ <div class="active title">
<i class="dropdown icon"></i>
UserALE.js
</div>
- <div class="content">
+ <div class="active content">
<div class="ui inverted bulleted list docs-list">
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
@@ -179,13 +179,13 @@
</div>
- <div class="active title">
+ <div class="title">
<i class="dropdown icon"></i>
Distill
</div>
- <div class="active content">
+ <div class="content">
<div class="ui inverted bulleted list docs-list">
@@ -245,105 +245,116 @@
</div>
<div class="docs-content">
- <h2 class="ui header">Apache Distill Utilities</h2>
- <h3 id="query-builder">Query Builder</h3>
-<blockquote>
-
- <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="k">class</span> <span class="nc">distill</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">query_builder</span><span class="o">.</span><span class="n">QueryBuilder</span><span class="p">(</span><span class="n">query</span><span class="o">=</span><span class="bp">None</span><span class="p">)</span>
-</code></pre>
- </div>
-</blockquote>
-
-<blockquote>
- <p><strong>Bases:</strong> object</p>
-</blockquote>
-
-<h4 id="add_filtersfilters">add_filters(filters)</h4>
+ <h2 class="ui header">UserALE.js Build and Test</h2>
+ <p>To build <a href="https://github.com/apache/incubator-flagon-useralejs/tree/master">Apache UserALE.js</a>, you will need to clone our repo and install <a href="https://nodejs.org/">NPM and Node.js</a>.</p>
-<h4 id="add_sortingsort_field-sort_order">add_sorting(sort_field=’’, sort_order=’’)</h4>
+<p>UserALE.js utilizes NPM for package and dependency management. Execute the following to install dependencies.</p>
+<div class="highlighter-rouge"><pre class="highlight"><code>#install required packages
+npm install
-<h3 id="exception-handling">Exception Handling</h3>
-<blockquote>
-
- <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="n">exception</span> <span class="n">distill</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">exceptions</span><span class="o">.</span><span class="n">Error</span>
+#review major dependencies
+npm ls --depth=0
</code></pre>
- </div>
-</blockquote>
-
-<blockquote>
- <p><strong>Bases:</strong> exceptions.Exception</p>
-</blockquote>
+</div>
-<blockquote>
- <p>Base class for exceptions.</p>
-</blockquote>
+<h2 id="build">Build</h2>
-<blockquote>
+<p>UserALE.js uses Gulp to manage build tasking. These tasks are executed through our build script; use the following to execute:</p>
- <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="n">exception</span> <span class="n">distill</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">exceptions</span><span class="o">.</span><span class="n">ValidationError</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">msg</span><span class="p">)</span>
+<div class="highlighter-rouge"><pre class="highlight"><code>#Build UserALE.js
+npm run build
</code></pre>
- </div>
-</blockquote>
-
-<blockquote>
- <p><strong>Bases:</strong> distill.utils.exceptions.Error</p>
-</blockquote>
+</div>
-<blockquote>
- <p>Exceptions raised for errors in validated a url.</p>
-</blockquote>
+<h2 id="test">Test</h2>
-<h3 id="validation-library">Validation Library</h3>
-<blockquote>
+<p>UserALE.js uses JSDOM and Mocha to execute unit tests, which are integrated into our build pipeline. See <code class="highlighter-rouge">package.json</code> for full script options.</p>
- <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="n">distill</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">validation</span><span class="o">.</span><span class="n">str2bool</span><span class="p">(</span><span class="n">v</span><span class="p">)</span>
+<p>To run tests:</p>
+<div class="highlighter-rouge"><pre class="highlight"><code>#Run UserALE.js unit tests
+npm run test
</code></pre>
- </div>
-</blockquote>
-
-<blockquote>
- <p>Convert string expression to boolean</p>
-</blockquote>
-
-<blockquote>
- <p><strong>Parameters:</strong></p>
- <ul>
- <li>v – Input value</li>
- </ul>
-</blockquote>
-
-<blockquote>
- <p><strong>Returns:</strong></p>
- <ul>
- <li>Converted message as boolean type</li>
- <li>Return type: bool</li>
- </ul>
-</blockquote>
-
-<blockquote>
-
- <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="n">distill</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">validation</span><span class="o">.</span><span class="n">validate_request</span><span class="p">(</span><span class="n">q</span><span class="p">)</span>
+</div>
+<p>… you’ll see something like:</p>
+<div class="highlighter-rouge"><pre class="highlight"><code>...
+ attachHandlers
+ ✓ attaches all the event handlers without duplicates
+ ✓ debounces bufferedEvents (505ms)
+ defineDetails
+ - configures high detail events correctly
+
+ configure
+ ✓ merges new configs into main config object
+ ✓ includes a userid if present in the window.location
+ getUserIdFromParams
+ ✓ fetches userId from URL params
+ ✓ returns null if no matching param
+
+ getInitialSettings
+ timeStampScale
+ ✓ no event.timestamp
+ ✓ zero
+ ✓ epoch milliseconds
+ ✓ epoch microseconds
+ ✓ performance navigation time
+ getInitialSettings
+ ✓ fetches all settings from a script tag (122ms)
+ ✓ grabs user id from params
+
+ Userale API
+ ✓ provides configs
+ ✓ edits configs
+ ✓ starts + stops (214ms)
+ ✓ sends custom logs
+
+ packageLogs
+ setLogFilter
+ ✓ assigns the handler to the provided value
+ ✓ allows the handler to be nulled
+ setLogMapper
+ ✓ assigns the handler to the provided value
+ ✓ allows the handler to be nulled
+ packageLog
+ ✓ only executes if on
+ ✓ calls detailFcn with the event as an argument if provided
+ ✓ packages logs
+ ✓ filters logs when a handler is assigned and returns false
+ ✓ assigns logs to the mapper's return value if a handler is assigned
+ ✓ does not call the map handler if the log is filtered out
+ ✓ does not attempt to call a non-function filter/mapper
+ extractTimeFields
+ ✓ returns the millisecond and microsecond portions of a timestamp
+ ✓ sets micro to 0 when no decimal is present
+ ✓ always returns an object
+ getLocation
+ ✓ returns event page location
+ ✓ calculates page location if unavailable
+ ✓ fails to null
+ selectorizePath
+ ✓ returns a new array of the same length provided
+ getSelector
+ ✓ builds a selector
+ ✓ identifies window
+ ✓ handles a non-null unknown value
+ buildPath
+ ✓ builds a path
+ ✓ defaults to path if available
+
+ sendLogs
+ ✓ sends logs on an interval
+ ✓ does not send logs if the config is off
+ ✓ sends logs on page exit with navigator
+ ✓ sends logs on page exit without navigator
+ ✓ does not send logs on page exit if config is off
+
+
+ 45 passing (954ms)
+ 1 pending
</code></pre>
- </div>
-</blockquote>
-
-<blockquote>
- <p>Parse out request message and validate inputs</p>
-</blockquote>
-
-<blockquote>
- <p><strong>Parameters:</strong></p>
- <ul>
- <li>q – Url query string</li>
- </ul>
-</blockquote>
-
-<blockquote>
- <p><strong>Raises:</strong></p>
- <ul>
- <li>ValidationError – if the query is missing required parameters</li>
- </ul>
-</blockquote>
+</div>
+<p>Any failing tests will also be logged in the terminal. If there are failing tests, please consider <a href="https://issues.apache.org/jira/projects/FLAGON">logging an issue in JIRA</a>.</p>
+
+<p>Further instructions can be found in our <a href="https://github.com/apache/incubator-flagon-useralejs/blob/master/README.md">README</a></p>
</div>
</div>
diff --git a/content/docs/useralejs/dataschema/index.html b/content/docs/useralejs/dataschema/index.html
new file mode 100644
index 0000000..ba0482b
--- /dev/null
+++ b/content/docs/useralejs/dataschema/index.html
@@ -0,0 +1,604 @@
+<!DOCTYPE html>
+<html lang="en">
+
+ <head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1">
+
+ <title>UserALE.js' Data Schema</title>
+ <meta name="description" content="This guide describes the structure of content of Apache UserALE.js logs, including: which behaviors UserALE.js listens to; which meta data UserALE.js attache...">
+
+ <link rel="stylesheet" type="text/css" href="/semantic/dist/semantic.min.css">
+ <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.1/jquery.min.js"></script>
+ <script src="/semantic/dist/semantic.min.js"></script>
+ <script src="https://d3js.org/d3.v4.min.js"></script>
+ <script src="/js/main.js"></script>
+
+ <link rel="stylesheet" href="/assets/main.css">
+ <link rel="canonical" href="http://flagon.incubator.apache.org/docs/useralejs/dataschema/">
+ <link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
+
+
+</head>
+
+
+ <body>
+
+ <div class="site-header">
+ <div id="main-menu" class="ui inverted padded fixed top borderless menu">
+ <a class="site-title" href="/">
+ <h3 class="ui inverted header item">Apache Flagon</h3>
+ </a>
+
+ <div class="right menu">
+ <div class="ui dropdown item">
+ Products
+ <div class="menu">
+ <a class="item" href="/stack">Stack</a>
+ <a class="item" href="/userale">UserALE</a>
+ <a class="item" href="/distill">Distill</a>
+ <a class="item" href="/tap">Tap</a>
+ <a class="item" href="/stout">Stout</a>
+ </div>
+ </div>
+ <div class="ui dropdown item">
+ <a href="/docs">Docs</a>
+ <div class="menu">
+ <a class="item" href="/docs/stack">Stack</a>
+ <a class="item" href="/docs/userale">UserALE</a>
+ <a class="item" href="/docs/useralejs">UserALE.js</a>
+ <a class="item" href="/docs/useralepy">UserALE.py</a>
+ <a class="item" href="/docs/distill">Distill</a>
+ <a class="item" href="/docs/tap">Tap</a>
+ <a class="item" href="/docs/stout">Stout</a>
+ </div>
+ </div>
+ <a class="item" href="/releases">Releases</a>
+ <a class="item" href="/community">Community</a>
+ </div>
+ </div>
+</div>
+
+
+ <div class="main-wrapper">
+ <div class="docs-wrapper">
+ <div class="docs-sidebar">
+
+
+
+
+
+
+
+
+
+<!-- <div class="ui inverted list">
+ <a class="item" href="/docs">About the Docs</a>
+</div> -->
+<div id="docs-nav" class="ui inverted accordion">
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ Apache Flagon
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/">About the Docs</a>
+
+ <a class="item" href="/docs/contributing/">Contributing</a>
+
+ </div>
+ </div>
+
+
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ Stack
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/stack/">Getting Started</a>
+
+ <a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
+
+ </div>
+ </div>
+
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ UserALE
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/userale/">About UserALE</a>
+
+ </div>
+ </div>
+
+
+ <div class="active title">
+
+ <i class="dropdown icon"></i>
+ UserALE.js
+ </div>
+
+ <div class="active content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/useralejs/">Getting Started</a>
+
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
+
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
+
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
+
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
+
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
+
+ </div>
+ </div>
+
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ UserALE.py
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/useralepy/">Installation</a>
+
+ <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
+
+ <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
+
+ <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
+
+ </div>
+ </div>
+
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ Distill
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/distill/">Installation</a>
+
+ <a class="item" href="/docs/distill/start.html">Getting Started</a>
+
+ <a class="item" href="/docs/distill/api.html">API Documentation</a>
+
+ <a class="item" href="/docs/distill/analytics.html">Apache Distill Analytics</a>
+
+ <a class="item" href="/docs/distill/http.html">Apache Distill HTTP Client</a>
+
+ <a class="item" href="/docs/distill/models.html">Apache Distill Models</a>
+
+ <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a>
+
+ <a class="item" href="/docs/distill/changelog.html">Changelog</a>
+
+ </div>
+ </div>
+
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ Tap
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/tap/">Getting Started</a>
+
+ </div>
+ </div>
+
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ Stout
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/stout/">About Stout</a>
+
+ <a class="item" href="/docs/stout/start.html">Getting Started</a>
+
+ </div>
+ </div>
+</div>
+
+ </div>
+ <div class="docs-content">
+ <h2 class="ui header">UserALE.js' Data Schema</h2>
+ <p>This guide describes the structure of content of <a href="https://github.com/apache/incubator-flagon-useralejs">Apache UserALE.js</a>
+logs, including:</p>
+<ul>
+ <li>which behaviors UserALE.js listens to;</li>
+ <li>which meta data UserALE.js attaches to logs, for context:</li>
+ <li>different types of UserALE.js logs, and their usage.</li>
+</ul>
+
+<h2 id="useralejs-logs">UserALE.js Logs</h2>
+
+<p>UserALE.js logs, by default, contain a lot more data than other business analytics products because it is powerful enough for <em>workflow analysis</em>.</p>
+
+<p>Workflow analysis is about understanding the complex interdependency between elements and behaviors within and across
+pages. Workflow analysis at this level is really crucial for understanding:</p>
+<ul>
+ <li>how people think about the information on your site or app</li>
+ <li>understanding efficiency in information discovery</li>
+ <li>and for gauging how novices explore pages compared to experts or superusers.</li>
+</ul>
+
+<p>In order to do workflow analysis, UserALE.js generates granular data about interactions with page elements.</p>
+
+<p>This is a standard UserALE.js log from our <a href="https://github.com/apache/incubator-flagon-useralejs/blob/master/example/index.html">example test utility</a>:</p>
+
+<div class="language-html highlighter-rouge"><pre class="highlight"><code> "microTime": 0.185,
+ "minor_ver": "0",
+ "@timestamp": "2019-06-28T16:00:20.790Z",
+ "type": "click",
+ "target": "button#test_button",
+ "details": {
+ "clicks": 13,
+ "shift": false,
+ "meta": false,
+ "alt": false,
+ "ctrl": false
+ },
+ "major_ver": "2",
+ "toolVersion": "2.0.0",
+ "pageReferrer": "",
+ "clientTime": 1561737620520,
+ "userAction": true,
+ "location": {
+ "x": 40,
+ "y": 19
+ },
+ "host": "172.18.0.1",
+ "path": [
+ "button#test_button",
+ "div.container",
+ "body",
+ "html",
+ "#document",
+ "Window"
+ ],
+ "sessionID": "session_1561737570573",
+ "toolName": "Apache UserALE.js Example",
+ "pageTitle": "UserAleJS - Example Page",
+ "logType": "raw",
+ "pageUrl": "file:///Users/jpoore/Documents/Apache_Flagon/test/incubator-flagon-useralejs/example/index.html",
+ "userId": "example-user",
+ "useraleVersion": "2.0.0",
+ "patch_ver": "0"
+ ]
+
+</code></pre>
+</div>
+
+<p>It’s a lot, but it makes sense in context.</p>
+
+<h3 id="useralejs-event-tracking">UserALE.js Event Tracking</h3>
+
+<p>The fields dentify what users do and what they interact with. UserALE.js gets this information from anywhere on a page/app without using a ton of hooks.</p>
+
+<div class="language-html highlighter-rouge"><pre class="highlight"><code> "type": "click", [this field documents the kind of user behavior observed]
+ "target": "button#test_button", [this field documents the site/app element a user interacted with]
+ "path": [ {this is the DOM path to the "target" element, which is critical for disambiguation between elements}
+ "button#test_button",
+ "div.container",
+ "body",
+ "html",
+ "#document",
+ "Window"]
+
+</code></pre>
+</div>
+
+<p>You may want to specially label some of these fields and important elements that. See our guide on <a href="/docs/useralejs/API">the UserALE.js API</a>.</p>
+
+<p>For more information about the kinds of behaviors (event classes) we collect, check out our guide for
+[modifying UserALE.js source code]((/docs/useralejs/modifying).</p>
+
+<h3 id="temporal-handling-in-useralejs">Temporal Handling in UserALE.js</h3>
+
+<p>Time is a very important concept in UserALE.js. Below are the fields related to temporal data capture:</p>
+
+<div class="language-html highlighter-rouge"><pre class="highlight"><code> "clientTime": 1561737620520, [UserALE.js collects time from the client when a log is generated]
+ "microTime": 0.185, [When a log is wrtten, we write microtime too, not every database parses it]
+ "@timestamp": "2019-06-28T16:00:20.790Z", [If you use our Elastic backend, you will see indexing time too]
+</code></pre>
+</div>
+
+<h3 id="useralejs-meta-data">UserALE.js Meta-Data</h3>
+
+<p>You want context? We have all of the things for all of your events:</p>
+
+<h4 id="event-context">Event Context</h4>
+
+<p>Every event has a little nuance, UserALE.js gets it all.</p>
+
+<p>UserALE.js will add to details the number of rapid, consecutive clicks on a single element.</p>
+
+<div class="language-html highlighter-rouge"><pre class="highlight"><code> "details": {
+ "clicks": 13,
+ "shift": false,
+ "meta": false,
+ "alt": false,
+ "ctrl": false
+ },
+</code></pre>
+</div>
+
+<p>You’ll get location of the cursor two for mouseover and click data, too!</p>
+
+<div class="language-html highlighter-rouge"><pre class="highlight"><code> "location": {
+ "x": 40,
+ "y": 19
+ },
+</code></pre>
+</div>
+
+<p><a href="https://github.com/apache/incubator-flagon-useralejs/tree/master/build">UserALE.js’ WebExtension</a> is deployed directly
+into your browser, as a result you’ll get browser events.</p>
+
+<p>Examples are below,you’ll see our details field has some pretty useful data from the browser.</p>
+
+<div class="language-html highlighter-rouge"><pre class="highlight"><code> "details": {
+ "audible": false, [audio media on the page?]
+ "title": "Discover - Kibana",
+ "selected": true,
+ "tabId": 64, [uniquely tracks each tab]
+ "windowId": 73, [uniquely tracks each window]
+ "muted": false,
+ "index": 0,
+ "incognito": false, [private browsing?]
+ "url": "http://localhost:5601/app/kibana#/discover?_g=(refreshInterval:(pause:!t)",
+ "active": true, []tab is active?[]
+ "pinned": false
+ },
+</code></pre>
+</div>
+
+<h4 id="pageapp-context">Page/App Context</h4>
+
+<p>If a user clicks on a thing and you know nothing about that thing, you’re toast!</p>
+
+<p>UserALE.js gives a lot context about your page or app. Some are automatically grabbed from the page, some are
+configurable through our <a href="/docs/useralejs">script tag</a></p>
+
+<div class="language-html highlighter-rouge"><pre class="highlight"><code> "toolVersion": "2.0.0", [you can give a semantic versioning of your page or tool]
+ "pageReferrer": "", [grabbed from the page, from which page did your users find your page/app]
+ "toolName": "Apache UserALE.js Example", [give your tool an alis through our script tag]
+ "pageTitle": "UserAleJS - Example Page", [page title grabbed from page]
+ "pageUrl": "file:///Users/jpoore/Documents/Apache_Flagon/test/incubator-flagon-useralejs/example/index.html"
+</code></pre>
+</div>
+
+<p>To find out more and how to change the context attached to event logs, check out our
+<a href="/docs/useralejs/modifying">modifying UserALE.js source code</a> guide.</p>
+
+<h4 id="user-context">User Context</h4>
+
+<p>UserALE.js has its own methods for gathering user context, and it can integrate with other methods you might have
+(e.g., cookies)</p>
+
+<div class="language-html highlighter-rouge"><pre class="highlight"><code> "sessionID": "session_1561737570573", [This session ID is unique to a specific page visit]
+ "userId": "example-user", [You can also pass a unique userId]
+ "host": "172.18.0.1", [IP address]
+</code></pre>
+</div>
+
+<p>To see how to pass in a userId from a url, check out our <a href="/docs/useralejs">script tag docs</a>.</p>
+
+<p>Other things you might want to do (e.g., cookies) can also be passed to userId via <a href="/docs/useralejs/API">the UserALE.js API</a>
+<code class="highlighter-rouge">mapping</code> function.</p>
+
+<h2 id="useralejs-log-types">UserALE.js Log Types</h2>
+
+<p>For the most part, UserALE.js logs are uniform. However, there are some variations based on the type of log.</p>
+
+<h3 id="webextension-logs">WebExtension Logs</h3>
+
+<p>WebExtension logs from page-level events will look identical to the logs from our script tag method.</p>
+
+<p>Our WebExtension logs from browser-level events, including focus, activation, and zoom events:</p>
+
+<div class="language-html highlighter-rouge"><pre class="highlight"><code>"host": "172.18.0.1",
+ "path": null,
+ "microTime": 0.835,
+ "@timestamp": "2019-06-28T18:05:03.681Z",
+ "sessionID": "session_1561741679119",
+ "type": "browser.tabs.onZoomChange",
+ "target": null,
+ "details": {
+ "audible": false,
+ "oldZoomFactor": 1,
+ "selected": true,
+ "tabId": 64,
+ "title": "Discover - Kibana",
+ "windowId": 73,
+ "newZoomFactor": 1,
+ "muted": false,
+ "index": 0,
+ "incognito": false,
+ "url": "http://localhost:5601/app/kibana#/discover?_g=(refreshInterval:(pause:!t),
+ "active": true,
+ "pinned": false
+ },
+ "toolName": null,
+ "toolVersion": null,
+ "clientTime": 1561745100028,
+ "userAction": true,
+ "logType": "raw",
+ "tags": [
+ "_grokparsefailure"
+ ],
+ "location": null,
+ "userId": "nobody",
+ "useraleVersion": null
+ },
+
+</code></pre>
+</div>
+
+<h3 id="interval-logs">Interval Logs</h3>
+
+<p>Interval logs are a experimental feature, that write long sequences of the same event to windows. They capture high resolution data like ‘mouseovers’ in time-boxed summary windows.</p>
+
+<p>Interval logs have a start- and end-time instead of a single, discrete time-stamp.</p>
+
+<div class="language-html highlighter-rouge"><pre class="highlight"><code> "endTime": 1561739434516, [end interval]
+ "minor_ver": "0",
+ "@timestamp": "2019-06-28T16:30:35.734Z",
+ "type": "mouseover",
+ "target": "html", [where were mouseovers observed within the interval]
+ "targetChange": true,
+ "major_ver": "2",
+ "count": 10, [count of disrcete events within the interval]
+ "pageReferrer": "",
+ "toolVersion": "2.0.0",
+ "userAction": false,
+ "duration": 396, [duration of interval in ms]
+ "host": "172.18.0.1",
+ "path": [
+ "html",
+ "#document",
+ "Window"
+ ],
+ "sessionID": "session_1561737570573",
+ "toolName": "Apache UserALE.js Example",
+ "startTime": 1561739434120, [begin interval]
+ "typeChange": true, [were there any other events during the interval?]
+ "pageTitle": "UserAleJS - Example Page",
+ "logType": "interval", [as compared to "raw"]
+ "pageUrl": "fApache_Flagon/test/incubator-flagon-useralejs/example/index.html",
+ "userId": "example-user",
+ "useraleVersion": "2.0.0",
+ "patch_ver": "0"
+</code></pre>
+</div>
+<h2 id="contributing">Contributing</h2>
+
+<p>Contributions are welcome! Simply <a href="https://issues.apache.org/jira/browse/FLAGON">submit an issue report</a> for problems
+you encounter or a pull request for your feature or bug fix. The core team will review it and work with you to
+incorporate it into UserALE.js.</p>
+
+ </div>
+</div>
+
+ </div>
+
+ <div class="footer ui inverted very padded vertical segment">
+ <div class="ui vertical segment">
+ <div class="ui four column grid">
+ <div class="column">
+ <h4 class="ui inverted header">About</h4>
+ <div class="ui inverted link list">
+ <a class="item" href="/stack">Stack</a>
+ <a class="item" href="/userale">UserALE</a>
+ <a class="item" href="/distill">Distill</a>
+ <a class="item" href="/tap">Tap</a>
+ <a class="item" href="/stout">Stout</a>
+ </div>
+ </div>
+ <div class="column">
+ <h4 class="ui inverted header">Docs</h4>
+ <div class="ui inverted link list">
+ <a class="item" href="/docs/stack">Stack</a>
+ <a class="item" href="/docs/userale">UserALE</a>
+ <a class="item" href="/docs/useralejs">UserAle.js</a>
+ <a class="item" href="/docs/useralepy">UserAle.py</a>
+ <a class="item" href="/docs/distill">Distill</a>
+ <a class="item" href="/docs/tap">Tap</a>
+ <a class="item" href="/docs/stout">Stout</a>
+ </div>
+ </div>
+ <div class="column">
+ <h4 class="ui inverted header">Community</h4>
+ <div class="ui inverted link list">
+ <a class="item" href="https://github.com/apache?q=flagon">GitHub</a>
+ <a class="item" href="http://stackoverflow.com/questions/tagged/apache-flagon">StackOverflow</a>
+ <a class="item" href="https://issues.apache.org/jira/browse/FLAGON">Jira Issue Tracker</a>
+ <a class="item" href="https://cwiki.apache.org/confluence/display/FLAGON">Project Wiki</a>
+ <a class="item" href="https://twitter.com/ApacheFlagon">Twitter</a>
+ </div>
+ </div>
+ <div class="column">
+ <h4 class="ui inverted header">Apache</h4>
+ <div class="ui inverted link list">
+ <a class="item" href="http://www.apache.org/">Apache Software Foundation</a>
+ <a class="item" href="http://www.apache.org/licenses/">License</a>
+ <a class="item" href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
+ <a class="item" href="http://www.apache.org/foundation/thanks.html">Thanks</a>
+ <a class="item" href="http://www.apache.org/security/">Security</a>
+ </div>
+ </div>
+ </div>
+ </div>
+ <div class="ui inverted vertical segment">
+ <div class="ui two column middle aligned grid">
+ <div class="column">
+ Apache Flagon is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the [...]
+ </div>
+ <div class="center aligned column">
+ Copyright © 2019 The Apache Software Foundation, Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.<br>
+ Apache Flagon, Flagon, Apache, the Apache feather logo, the Apache Flagon logo and the Apache Incubator logo are trademarks of The Apache Software Foundation.
+ </div>
+ </div>
+ </div>
+ <div class="ui inverted vertical segment">
+ <div class="ui one column middle aligned grid">
+ <div class="center aligned column">
+ <a href="http://incubator.apache.org/">
+ <img src="/images/incubator-logo-white.jpg">
+ </a>
+ <a href="https://www.apache.org/events/current-event.html">
+ <img src="https://www.apache.org/events/current-event-234x60.png" alt="ASF Current Event">
+ </a>
+ </div>
+ </div>
+ </div>
+</div>
+
+
+ </body>
+
+</html>
diff --git a/content/docs/useralejs/index.html b/content/docs/useralejs/index.html
index cb63071..ce65d38 100644
--- a/content/docs/useralejs/index.html
+++ b/content/docs/useralejs/index.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
@@ -251,7 +251,7 @@
<p><em>Note:</em> Work on UserALE.js’ documentation is ongoing. Contributions are welcome. To get involved, see our <a href="/docs/contributing">Contributing</a> guide.</p>
<h3 id="include-useralejs-in-your-project">Include UserALE.js in your project</h3>
-<p>To start logging with Apache UserALE.js, you can include our script directly in your project. More details can be found in our <a href="https://github.com/apache/incubator-flagon-useralejs/blob/master/README.md">README</a>. You can use our <a href="/docs/useralejs/build">build process</a> to create our script, or just use a sample in our <a href="https://github.com/apache/incubator-flagon-useralejs/tree/master/build">repos</a>.</p>
+<p>To start logging with Apache UserALE.js, you can include our script directly in your project. More details can be found in our <a href="https://github.com/apache/incubator-flagon-useralejs/blob/master/README.md">README</a>. You can use our <a href="/docs/useralejs/build">build process</a> to create our script, use a sample in our <a href="https://github.com/apache/incubator-flagon-useralejs/tree/master/build">repos</a>, or pull our scripts from <a href="https://www.npmjs.com/package/f [...]
<p>To include UserALE.js in a specific project, you’ll need to deploy a version of our minified UserALE.js script in an accessible location (e.g., webserver), and simply include this script tag on the page:</p>
@@ -338,7 +338,7 @@
<p>User our <a href="https://github.com/apache/incubator-flagon-useralejs/tree/master/example">example test utility</a> to experiment with script tag parameters.</p>
<h3 id="deploying-the-useralejs-webextension">Deploying the UserALE.js WebExtension</h3>
-<p>If you’re interested in using our Web Extension to log user activity across all pages they visit, try our web extension, which injects UserALE.js into any web page your client(s) navigate to. This option is perfect for testing and research. The web extension builds through the same <a href="/docs/useralejs/build">build pipeline</a> as UserALE.js. You can also use pre-built extension files in our <a href="https://github.com/apache/incubator-flagon-useralejs/tree/FLAGON-336/build">repo< [...]
+<p>If you’re interested in using our Web Extension to log user activity across all pages they visit, try our web extension, which injects UserALE.js into any web page your client(s) navigate to. This option is perfect for testing and research. The web extension builds through the same <a href="/docs/useralejs/build">build pipeline</a> as UserALE.js. You can also use pre-built extension files in our <a href="https://github.com/apache/incubator-flagon-useralejs/tree/master/build">repo</a>.</p>
<p>When you’re ready to deploy the UserALE.js web extension, follow the instructions below:</p>
diff --git a/content/docs/useralejs/modifying/index.html b/content/docs/useralejs/modifying/index.html
new file mode 100644
index 0000000..4f6b4fb
--- /dev/null
+++ b/content/docs/useralejs/modifying/index.html
@@ -0,0 +1,463 @@
+<!DOCTYPE html>
+<html lang="en">
+
+ <head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1">
+
+ <title>Modifying UserALE.js Source Code</title>
+ <meta name="description" content="Apache UserALE.js makes it easy for you to capture every user behavior on your webpage or application. But, you might not need all that data.">
+
+ <link rel="stylesheet" type="text/css" href="/semantic/dist/semantic.min.css">
+ <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.1/jquery.min.js"></script>
+ <script src="/semantic/dist/semantic.min.js"></script>
+ <script src="https://d3js.org/d3.v4.min.js"></script>
+ <script src="/js/main.js"></script>
+
+ <link rel="stylesheet" href="/assets/main.css">
+ <link rel="canonical" href="http://flagon.incubator.apache.org/docs/useralejs/modifying/">
+ <link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
+
+
+</head>
+
+
+ <body>
+
+ <div class="site-header">
+ <div id="main-menu" class="ui inverted padded fixed top borderless menu">
+ <a class="site-title" href="/">
+ <h3 class="ui inverted header item">Apache Flagon</h3>
+ </a>
+
+ <div class="right menu">
+ <div class="ui dropdown item">
+ Products
+ <div class="menu">
+ <a class="item" href="/stack">Stack</a>
+ <a class="item" href="/userale">UserALE</a>
+ <a class="item" href="/distill">Distill</a>
+ <a class="item" href="/tap">Tap</a>
+ <a class="item" href="/stout">Stout</a>
+ </div>
+ </div>
+ <div class="ui dropdown item">
+ <a href="/docs">Docs</a>
+ <div class="menu">
+ <a class="item" href="/docs/stack">Stack</a>
+ <a class="item" href="/docs/userale">UserALE</a>
+ <a class="item" href="/docs/useralejs">UserALE.js</a>
+ <a class="item" href="/docs/useralepy">UserALE.py</a>
+ <a class="item" href="/docs/distill">Distill</a>
+ <a class="item" href="/docs/tap">Tap</a>
+ <a class="item" href="/docs/stout">Stout</a>
+ </div>
+ </div>
+ <a class="item" href="/releases">Releases</a>
+ <a class="item" href="/community">Community</a>
+ </div>
+ </div>
+</div>
+
+
+ <div class="main-wrapper">
+ <div class="docs-wrapper">
+ <div class="docs-sidebar">
+
+
+
+
+
+
+
+
+
+<!-- <div class="ui inverted list">
+ <a class="item" href="/docs">About the Docs</a>
+</div> -->
+<div id="docs-nav" class="ui inverted accordion">
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ Apache Flagon
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/">About the Docs</a>
+
+ <a class="item" href="/docs/contributing/">Contributing</a>
+
+ </div>
+ </div>
+
+
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ Stack
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/stack/">Getting Started</a>
+
+ <a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
+
+ </div>
+ </div>
+
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ UserALE
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/userale/">About UserALE</a>
+
+ </div>
+ </div>
+
+
+ <div class="active title">
+
+ <i class="dropdown icon"></i>
+ UserALE.js
+ </div>
+
+ <div class="active content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/useralejs/">Getting Started</a>
+
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
+
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
+
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
+
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
+
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
+
+ </div>
+ </div>
+
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ UserALE.py
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/useralepy/">Installation</a>
+
+ <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
+
+ <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
+
+ <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
+
+ </div>
+ </div>
+
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ Distill
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/distill/">Installation</a>
+
+ <a class="item" href="/docs/distill/start.html">Getting Started</a>
+
+ <a class="item" href="/docs/distill/api.html">API Documentation</a>
+
+ <a class="item" href="/docs/distill/analytics.html">Apache Distill Analytics</a>
+
+ <a class="item" href="/docs/distill/http.html">Apache Distill HTTP Client</a>
+
+ <a class="item" href="/docs/distill/models.html">Apache Distill Models</a>
+
+ <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a>
+
+ <a class="item" href="/docs/distill/changelog.html">Changelog</a>
+
+ </div>
+ </div>
+
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ Tap
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/tap/">Getting Started</a>
+
+ </div>
+ </div>
+
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ Stout
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/stout/">About Stout</a>
+
+ <a class="item" href="/docs/stout/start.html">Getting Started</a>
+
+ </div>
+ </div>
+</div>
+
+ </div>
+ <div class="docs-content">
+ <h2 class="ui header">Modifying UserALE.js Source Code</h2>
+ <p><a href="https://github.com/apache/incubator-flagon-useralejs">Apache UserALE.js</a> makes it easy for you to capture <em>every</em> user
+behavior on your webpage or application. But, you might not need all that data.</p>
+
+<p>UserALE.js also makes it easy for your to manage, and curate your logging scheme.</p>
+
+<p>This guide walks you through how to modify UserALE.js log data and behavior through source code modification.</p>
+
+<h2 id="modifying-useralejs-logs-via-source-code-modifications">Modifying UserALE.js Logs via Source Code Modifications</h2>
+
+<p>We’re starting with this method because it will give context to others methods, like our script tag and API (below).</p>
+
+<p>UserALE.js src is intuitively abstracted into few different files”</p>
+
+<ul>
+ <li><a href="https://github.com/apache/incubator-flagon-useralejs/blob/master/src/attachHandlers.js">attachHandlers</a>: configure which user behaviors UserALE.js listens for and event handlers here.</li>
+ <li><a href="https://github.com/apache/incubator-flagon-useralejs/blob/master/src/configure.js">configure</a>: set special custom parameters, like passing a unqiue userID into UserALE.js logs.</li>
+ <li><a href="https://github.com/apache/incubator-flagon-useralejs/blob/master/src/getInitialSettings.js">getInitialSettings</a>: modify HTML5 parameters passed through the script tag.</li>
+ <li><a href="https://github.com/apache/incubator-flagon-useralejs/blob/master/src/main.js">main</a>: attaches event handlers and adds logs to queue (probably want to leave alone).</li>
+ <li><a href="https://github.com/apache/incubator-flagon-useralejs/blob/master/src/packageLogs.js">packageLogs</a>: modify to configure how user behaviors are added to data schema, and meta data added from the page.</li>
+ <li><a href="https://github.com/apache/incubator-flagon-useralejs/blob/master/src/sendLogs.js">sendLogs</a>: modify how logs are sent to logging server, etc. (be careful here, too).</li>
+</ul>
+
+<h3 id="usage">Usage</h3>
+
+<p>Most modifications can be accomplished through <code class="highlighter-rouge">attachHandlers</code> and <code class="highlighter-rouge">packageLogs</code>.</p>
+
+<p>Once you modify source, you’ll need to rebuild UserALE.js scripts and webextension (and should probably run unit tests).</p>
+
+<h3 id="modifying-event-handlers-examples">Modifying Event Handlers: Examples</h3>
+
+<p><code class="highlighter-rouge">attachHandlers</code> controls which behaviors and what kinds of logs are captured</p>
+
+<p>You can modify some of the events UserALE.js by editing vars in <code class="highlighter-rouge">attacheHandlers</code>.</p>
+
+<div class="language-javascript highlighter-rouge"><pre class="highlight"><code><span class="kd">var</span> <span class="nx">events</span><span class="p">;</span>
+<span class="kd">var</span> <span class="nx">bufferBools</span><span class="p">;</span>
+<span class="kd">var</span> <span class="nx">bufferedEvents</span><span class="p">;</span>
+<span class="cm">/* modify which events are abstracted into interval logs by editing the array below*/</span>
+<span class="kd">var</span> <span class="nx">intervalEvents</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'click'</span><span class="p">,</span> <span class="s1">'focus'</span><span class="p">,</span> <span class="s1">'blur'</span><span class="p">,</span> <span class="s1">'input'</span><span class="p">,</span> <span class="s1">'change'</span><span class="p">,</span> <span class="s1">'mouseover'</span><span class="p">,</span> <span class="s1">'submit'</span><spa [...]
+<span class="cm">/* modify which events are pulled from window*/</span>
+<span class="kd">var</span> <span class="nx">windowEvents</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'load'</span><span class="p">,</span> <span class="s1">'blur'</span><span class="p">,</span> <span class="s1">'focus'</span><span class="p">];</span>
+</code></pre>
+</div>
+
+<p>You can modify which events UserALE.js captures in it’s ‘raw’ log stream, by modifying the var <code class="highlighter-rouge">events</code>:</p>
+
+<div class="language-javascript highlighter-rouge"><pre class="highlight"><code><span class="cm">/* Comment out event types in the `events` var for granular modification of UserALE.js behavior */</span>
+<span class="kr">export</span> <span class="kd">function</span> <span class="nx">defineDetails</span><span class="p">(</span><span class="nx">config</span><span class="p">)</span> <span class="p">{</span>
+ <span class="c1">// Events list</span>
+ <span class="c1">// Keys are event types</span>
+ <span class="c1">// Values are functions that return details object if applicable</span>
+ <span class="nx">events</span> <span class="o">=</span> <span class="p">{</span>
+ <span class="s1">'click'</span> <span class="p">:</span> <span class="nx">extractMouseEvent</span><span class="p">,</span>
+ <span class="s1">'dblclick'</span> <span class="p">:</span> <span class="nx">extractMouseEvent</span><span class="p">,</span>
+ <span class="s1">'mousedown'</span> <span class="p">:</span> <span class="nx">extractMouseEvent</span><span class="p">,</span>
+ <span class="s1">'mouseup'</span> <span class="p">:</span> <span class="nx">extractMouseEvent</span><span class="p">,</span>
+ <span class="s1">'focus'</span> <span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
+ <span class="s1">'blur'</span> <span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
+ <span class="s1">'input'</span> <span class="p">:</span> <span class="nx">config</span><span class="p">.</span><span class="nx">logDetails</span> <span class="p">?</span> <span class="kd">function</span><span class="p">(</span><span class="nx">e</span><span class="p">)</span> <span class="p">{</span> <span class="k">return</span> <span class="p">{</span> <span class="s1">'value'</span> <span class="p">:</span> <span class="nx">e</span><span class="p">.</span><span class="nx">target</ [...]
+ <span class="s1">'change'</span> <span class="p">:</span> <span class="nx">config</span><span class="p">.</span><span class="nx">logDetails</span> <span class="p">?</span> <span class="kd">function</span><span class="p">(</span><span class="nx">e</span><span class="p">)</span> <span class="p">{</span> <span class="k">return</span> <span class="p">{</span> <span class="s1">'value'</span> <span class="p">:</span> <span class="nx">e</span><span class="p">.</span><span class="nx">target< [...]
+ <span class="s1">'dragstart'</span> <span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
+ <span class="s1">'dragend'</span> <span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
+ <span class="s1">'drag'</span> <span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
+ <span class="s1">'drop'</span> <span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
+ <span class="s1">'keydown'</span> <span class="p">:</span> <span class="nx">config</span><span class="p">.</span><span class="nx">logDetails</span> <span class="p">?</span> <span class="kd">function</span><span class="p">(</span><span class="nx">e</span><span class="p">)</span> <span class="p">{</span> <span class="k">return</span> <span class="p">...,</span>
+ <span class="cm">/*'mouseover' : null,*/</span> <span class="err">#</span><span class="nx">Aliasing</span> <span class="nx">the</span> <span class="s2">"events"</span> <span class="nx">list</span> <span class="nx">removes</span> <span class="nx">that</span> <span class="kr">class</span> <span class="nx">from</span> <span class="nx">your</span> <span class="nx">event</span> <span class="nx">stream</span><span class="p">.</span>
+ <span class="s1">'submit'</span> <span class="p">:</span> <span class="kc">null</span>
+</code></pre>
+</div>
+
+<p>You can eliminate the <code class="highlighter-rouge">interval</code> log stream altogether by modifying the <code class="highlighter-rouge">attachHandlers</code> configs:</p>
+
+<div class="language-javascript highlighter-rouge"><pre class="highlight"><code><span class="kr">export</span> <span class="kd">function</span> <span class="nx">attachHandlers</span><span class="p">(</span><span class="nx">config</span><span class="p">)</span> <span class="p">{</span>
+ <span class="nx">defineDetails</span><span class="p">(</span><span class="nx">config</span><span class="p">);</span>
+
+ <span class="nb">Object</span><span class="p">.</span><span class="nx">keys</span><span class="p">(</span><span class="nx">events</span><span class="p">).</span><span class="nx">forEach</span><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">ev</span><span class="p">)</span> <span class="p">{</span>
+ <span class="nb">document</span><span class="p">.</span><span class="nx">addEventListener</span><span class="p">(</span><span class="nx">ev</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">e</span><span class="p">)</span> <span class="p">{</span>
+ <span class="nx">packageLog</span><span class="p">(</span><span class="nx">e</span><span class="p">,</span> <span class="nx">events</span><span class="p">[</span><span class="nx">ev</span><span class="p">]);</span>
+ <span class="p">},</span> <span class="kc">true</span><span class="p">);</span>
+ <span class="p">});</span>
+<span class="cm">/*Comment out configs for intervalEvents to remove them from your log stream */</span>
+ <span class="nx">intervalEvents</span><span class="p">.</span><span class="nx">forEach</span><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">ev</span><span class="p">)</span> <span class="p">{</span>
+ <span class="nb">document</span><span class="p">.</span><span class="nx">addEventListener</span><span class="p">(</span><span class="nx">ev</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">e</span><span class="p">)</span> <span class="p">{</span>
+ <span class="nx">packageIntervalLog</span><span class="p">(</span><span class="nx">e</span><span class="p">);</span>
+ <span class="p">},</span> <span class="kc">true</span><span class="p">);</span>
+ <span class="p">});</span>
+</code></pre>
+</div>
+
+<h3 id="modifying-meta-data-packaged-in-logs-examples">Modifying Meta Data Packaged in Logs: Examples</h3>
+
+<p><code class="highlighter-rouge">packageLogs</code> pulls parameters from the script tag, API, and from window or document and adds them to event logs.</p>
+
+<p>The easiest way to make these changes is by modifying the var <code class="highlighter-rouge">log</code>:</p>
+
+<div class="language-javascript highlighter-rouge"><pre class="highlight"><code> <span class="cm">/* Comment or add fields to be included in your logs*/</span>
+ <span class="kd">var</span> <span class="nx">log</span> <span class="o">=</span> <span class="p">{</span>
+ <span class="s1">'target'</span> <span class="p">:</span> <span class="nx">getSelector</span><span class="p">(</span><span class="nx">e</span><span class="p">.</span><span class="nx">target</span><span class="p">),</span>
+ <span class="s1">'path'</span> <span class="p">:</span> <span class="nx">buildPath</span><span class="p">(</span><span class="nx">e</span><span class="p">),</span>
+ <span class="s1">'pageUrl'</span><span class="p">:</span> <span class="nb">window</span><span class="p">.</span><span class="nx">location</span><span class="p">.</span><span class="nx">href</span><span class="p">,</span>
+ <span class="s1">'pageTitle'</span><span class="p">:</span> <span class="nb">document</span><span class="p">.</span><span class="nx">title</span><span class="p">,</span>
+ <span class="s1">'pageReferrer'</span><span class="p">:</span> <span class="nb">document</span><span class="p">.</span><span class="nx">referrer</span><span class="p">,</span>
+ <span class="s1">'clientTime'</span> <span class="p">:</span> <span class="nx">timeFields</span><span class="p">.</span><span class="nx">milli</span><span class="p">,</span>
+ <span class="s1">'microTime'</span> <span class="p">:</span> <span class="nx">timeFields</span><span class="p">.</span><span class="nx">micro</span><span class="p">,</span>
+ <span class="s1">'location'</span> <span class="p">:</span> <span class="nx">getLocation</span><span class="p">(</span><span class="nx">e</span><span class="p">),</span>
+ <span class="s1">'type'</span> <span class="p">:</span> <span class="nx">e</span><span class="p">.</span><span class="nx">type</span><span class="p">,</span>
+ <span class="s1">'logType'</span><span class="p">:</span> <span class="s1">'raw'</span><span class="p">,</span>
+ <span class="s1">'userAction'</span> <span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
+ <span class="s1">'details'</span> <span class="p">:</span> <span class="nx">details</span><span class="p">,</span>
+ <span class="s1">'userId'</span> <span class="p">:</span> <span class="nx">config</span><span class="p">.</span><span class="nx">userId</span><span class="p">,</span>
+ <span class="s1">'toolVersion'</span> <span class="p">:</span> <span class="nx">config</span><span class="p">.</span><span class="nx">version</span><span class="p">,</span>
+ <span class="s1">'toolName'</span> <span class="p">:</span> <span class="nx">config</span><span class="p">.</span><span class="nx">toolName</span><span class="p">,</span>
+ <span class="s1">'useraleVersion'</span><span class="p">:</span> <span class="nx">config</span><span class="p">.</span><span class="nx">useraleVersion</span><span class="p">,</span>
+ <span class="s1">'sessionID'</span><span class="p">:</span> <span class="nx">config</span><span class="p">.</span><span class="nx">sessionID</span>
+ <span class="p">};</span>
+</code></pre>
+</div>
+
+<h3 id="benefits-modifying-useralejs-logs-via-src">Benefits Modifying UserALE.js Logs via src:</h3>
+<ul>
+ <li>Full control of your log streams</li>
+ <li>With simple modification to src you can package and build multiple UserALE.js scripts for page-to-page modification
+ of log streams.</li>
+ <li>Modify the behavior of our webExtension</li>
+ <li>Ideal in cases where you don’t want to integrate UserALE.js into your CD pipeline, just pass around pre-built scripts
+ that suite your needs.</li>
+</ul>
+
+<h2 id="contributing">Contributing</h2>
+
+<p>Contributions are welcome! Simply <a href="https://issues.apache.org/jira/browse/FLAGON">submit an issue report</a> for problems
+you encounter or a pull request for your feature or bug fix. The core team will review it and work with you to
+incorporate it into UserALE.js.</p>
+
+ </div>
+</div>
+
+ </div>
+
+ <div class="footer ui inverted very padded vertical segment">
+ <div class="ui vertical segment">
+ <div class="ui four column grid">
+ <div class="column">
+ <h4 class="ui inverted header">About</h4>
+ <div class="ui inverted link list">
+ <a class="item" href="/stack">Stack</a>
+ <a class="item" href="/userale">UserALE</a>
+ <a class="item" href="/distill">Distill</a>
+ <a class="item" href="/tap">Tap</a>
+ <a class="item" href="/stout">Stout</a>
+ </div>
+ </div>
+ <div class="column">
+ <h4 class="ui inverted header">Docs</h4>
+ <div class="ui inverted link list">
+ <a class="item" href="/docs/stack">Stack</a>
+ <a class="item" href="/docs/userale">UserALE</a>
+ <a class="item" href="/docs/useralejs">UserAle.js</a>
+ <a class="item" href="/docs/useralepy">UserAle.py</a>
+ <a class="item" href="/docs/distill">Distill</a>
+ <a class="item" href="/docs/tap">Tap</a>
+ <a class="item" href="/docs/stout">Stout</a>
+ </div>
+ </div>
+ <div class="column">
+ <h4 class="ui inverted header">Community</h4>
+ <div class="ui inverted link list">
+ <a class="item" href="https://github.com/apache?q=flagon">GitHub</a>
+ <a class="item" href="http://stackoverflow.com/questions/tagged/apache-flagon">StackOverflow</a>
+ <a class="item" href="https://issues.apache.org/jira/browse/FLAGON">Jira Issue Tracker</a>
+ <a class="item" href="https://cwiki.apache.org/confluence/display/FLAGON">Project Wiki</a>
+ <a class="item" href="https://twitter.com/ApacheFlagon">Twitter</a>
+ </div>
+ </div>
+ <div class="column">
+ <h4 class="ui inverted header">Apache</h4>
+ <div class="ui inverted link list">
+ <a class="item" href="http://www.apache.org/">Apache Software Foundation</a>
+ <a class="item" href="http://www.apache.org/licenses/">License</a>
+ <a class="item" href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
+ <a class="item" href="http://www.apache.org/foundation/thanks.html">Thanks</a>
+ <a class="item" href="http://www.apache.org/security/">Security</a>
+ </div>
+ </div>
+ </div>
+ </div>
+ <div class="ui inverted vertical segment">
+ <div class="ui two column middle aligned grid">
+ <div class="column">
+ Apache Flagon is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the [...]
+ </div>
+ <div class="center aligned column">
+ Copyright © 2019 The Apache Software Foundation, Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.<br>
+ Apache Flagon, Flagon, Apache, the Apache feather logo, the Apache Flagon logo and the Apache Incubator logo are trademarks of The Apache Software Foundation.
+ </div>
+ </div>
+ </div>
+ <div class="ui inverted vertical segment">
+ <div class="ui one column middle aligned grid">
+ <div class="center aligned column">
+ <a href="http://incubator.apache.org/">
+ <img src="/images/incubator-logo-white.jpg">
+ </a>
+ <a href="https://www.apache.org/events/current-event.html">
+ <img src="https://www.apache.org/events/current-event-234x60.png" alt="ASF Current Event">
+ </a>
+ </div>
+ </div>
+ </div>
+</div>
+
+
+ </body>
+
+</html>
diff --git a/site/_site/docs/distill/start.html b/content/docs/useralejs/troubleshooting/index.html
similarity index 88%
copy from site/_site/docs/distill/start.html
copy to content/docs/useralejs/troubleshooting/index.html
index d4562fe..2a9f239 100644
--- a/site/_site/docs/distill/start.html
+++ b/content/docs/useralejs/troubleshooting/index.html
@@ -6,8 +6,8 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
- <title>Getting Started</title>
- <meta name="description" content="Usage">
+ <title>Troubleshooting</title>
+ <meta name="description" content="Enable Cross-Origin Resource Sharing (CORS)">
<link rel="stylesheet" type="text/css" href="/semantic/dist/semantic.min.css">
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.1/jquery.min.js"></script>
@@ -16,7 +16,7 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://flagon.incubator.apache.org/docs/distill/start.html">
+ <link rel="canonical" href="http://flagon.incubator.apache.org/docs/useralejs/troubleshooting/">
<link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -131,27 +131,27 @@
</div>
- <div class="title">
+ <div class="active title">
<i class="dropdown icon"></i>
UserALE.js
</div>
- <div class="content">
+ <div class="active content">
<div class="ui inverted bulleted list docs-list">
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
@@ -179,13 +179,13 @@
</div>
- <div class="active title">
+ <div class="title">
<i class="dropdown icon"></i>
Distill
</div>
- <div class="active content">
+ <div class="content">
<div class="ui inverted bulleted list docs-list">
@@ -245,18 +245,12 @@
</div>
<div class="docs-content">
- <h2 class="ui header">Getting Started</h2>
- <h3 id="usage">Usage</h3>
+ <h2 class="ui header">Troubleshooting</h2>
+ <h3 id="enable-cross-origin-resource-sharing-cors">Enable Cross-Origin Resource Sharing (CORS)</h3>
-<p>Using curl:</p>
+<p>The logs generated by <a href="https://github.com/apache/incubator-flagon-useralejs">Apache UserALE.js</a> are sent to a logging server which is configured in the script tag. Your client may send out failure logs because of a CORS (cross-origin resource sharing) issue. You will need to configure your backend server to enable CORS.</p>
-<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>curl -XGET <span class="s1">'http://localhost:8090/app/register'</span> -d <span class="s1">'{
- "application_name" : "my_app",
- "version" : "0.1",
- "application_description" : "my test app"
- }'</span>
-</code></pre>
-</div>
+<p>For more information and examples on how to enable CORS on your server, please visit <a href="http://enable-cors.org/index.html">enable-cors.org</a>.</p>
</div>
</div>
diff --git a/content/docs/useralepy/api.html b/content/docs/useralepy/api.html
index cde7315..2dafb58 100644
--- a/content/docs/useralepy/api.html
+++ b/content/docs/useralepy/api.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/content/docs/useralepy/changelog.html b/content/docs/useralepy/changelog.html
index 47b7e6c..c5d4936 100644
--- a/content/docs/useralepy/changelog.html
+++ b/content/docs/useralepy/changelog.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/content/docs/useralepy/index.html b/content/docs/useralepy/index.html
index d6dcfcd..7592740 100644
--- a/content/docs/useralepy/index.html
+++ b/content/docs/useralepy/index.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/content/docs/useralepy/start.html b/content/docs/useralepy/start.html
index 4e1feaa..83ec54a 100644
--- a/content/docs/useralepy/start.html
+++ b/content/docs/useralepy/start.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/content/feed.xml b/content/feed.xml
index d0e8baf..7a85395 100644
--- a/content/feed.xml
+++ b/content/feed.xml
@@ -1 +1 @@
-<?xml version="1.0" encoding="utf-8"?><?xml-stylesheet type="text/xml" href="http://flagon.incubator.apache.org/feed.xslt.xml"?><feed xmlns="http://www.w3.org/2005/Atom"><generator uri="http://jekyllrb.com" version="3.3.1">Jekyll</generator><link href="http://flagon.incubator.apache.org/feed.xml" rel="self" type="application/atom+xml" /><link href="http://flagon.incubator.apache.org/" rel="alternate" type="text/html" /><updated>2019-06-27T03:26:21+00:00</updated><id>http://flagon.incubat [...]
+<?xml version="1.0" encoding="utf-8"?><?xml-stylesheet type="text/xml" href="http://flagon.incubator.apache.org/feed.xslt.xml"?><feed xmlns="http://www.w3.org/2005/Atom"><generator uri="http://jekyllrb.com" version="3.3.1">Jekyll</generator><link href="http://flagon.incubator.apache.org/feed.xml" rel="self" type="application/atom+xml" /><link href="http://flagon.incubator.apache.org/" rel="alternate" type="text/html" /><updated>2019-06-29T01:37:39+00:00</updated><id>http://flagon.incubat [...]
diff --git a/content/index.html b/content/index.html
index 90343d7..e08ba44 100644
--- a/content/index.html
+++ b/content/index.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
diff --git a/content/releases/index.html b/content/releases/index.html
index 7c28df5..9a76457 100644
--- a/content/releases/index.html
+++ b/content/releases/index.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -74,7 +74,7 @@
</p>
<p>
- Please Note all Apache Flagon artifacts are released as source code and binary artifacts and additional packages can be found on packaging platforms such as UserALE.js which we make available through <a href="https://www.npmjs.com/package/useralejs">the NPM useralejs package</a>.
+ Please Note all Apache Flagon artifacts are released as source code and binary artifacts and additional packages can be found on packaging platforms such as UserALE.js which we make available through <a href="https://www.npmjs.com/package/flagon-userale">the NPM useralejs package</a>.
The CHANGELOG file shipped with each artifact can be consulted for more information on the list of updates in each release.
@@ -83,7 +83,7 @@
<h1>Flagon UserALE.js</h1>
-Please note, that for convenience, we make UserALE.js available through <a href="https://www.npmjs.com/package/useralejs">the NPM useralejs package</a>.
+Please note, that for convenience, we make UserALE.js available through <a href="https://www.npmjs.com/package/flagon-userale">the NPM useralejs package</a>.
<h2>Downloads</h2>
The link in the 'Download Artifact' column below should display a default mirror selection based on your inferred location. If (when you browse to it) you do not see that page, try a different browser. The SHA512 checksum and ASCII armoured detached signatures are links to the originals on the main distribution server.
@@ -100,27 +100,27 @@ The link in the 'Download Artifact' column below should display a default mirror
<tbody>
<tr>
<td>Apache Flagon UserALE.js 1.0.0 (binary tar.gz)</td>
- <td><a href="http://www.apache.org/dyn/closer.cgi/incubator/senssoft/apache-senssoft-useralejs-1.0.0/apache-senssoft-useralejs-1.0.0-bin.tar.gz">apache-senssoft-useralejs-1.0.0-bin.tar.gz</a></td>
- <td><a href="https://dist.apache.org/repos/dist/release/incubator/senssoft/apache-senssoft-useralejs-1.0.0/apache-senssoft-useralejs-1.0.0-bin.tar.gz.asc">apache-senssoft-useralejs-1.0.0-bin.tar.gz.asc</a> </td>
- <td><a href="https://dist.apache.org/repos/dist/release/incubator/senssoft/apache-senssoft-useralejs-1.0.0/apache-senssoft-useralejs-1.0.0-bin.tar.gz.sha512">apache-senssoft-useralejs-1.0.0-bin.tar.gz.sha512</a> </td>
+ <td><a href="http://www.apache.org/dyn/closer.cgi/incubator/flagon/apache-flagon-useralejs-incubating-1.0.0/apache-flagon-useralejs-incubating-1.0.0-bin.tar.gz">apache-flagon-useralejs-incubating-1.0.0-bin.tar.gz</a></td>
+ <td><a href="https://dist.apache.org/repos/dist/release/incubator/flagon/apache-flagon-useralejs-incubating-1.0.0/apache-flagon-useralejs-incubating-1.0.0-bin.tar.gz.asc">apache-flagon-useralejs-incubating-1.0.0-bin.tar.gz.asc</a> </td>
+ <td><a href="https://dist.apache.org/repos/dist/release/incubator/flagon/apache-flagon-useralejs-incubating-1.0.0/apache-flagon-useralejs-incubating-1.0.0-bin.tar.gz.sha512">apache-flagon-useralejs-incubating-1.0.0-bin.tar.gz.sha512</a> </td>
</tr>
<tr>
<td>Apache Flagon UserALE.js 1.0.0(binary zip)</td>
- <td><a href="http://www.apache.org/dyn/closer.cgi/incubator/senssoft/apache-senssoft-useralejs-1.0.0/apache-senssoft-useralejs-1.0.0-bin.zip">apache-senssoft-useralejs-1.0.0-bin.zip</a></td>
- <td><a href="https://dist.apache.org/repos/dist/release/incubator/senssoft/apache-senssoft-useralejs-1.0.0/apache-senssoft-useralejs-1.0.0-bin.zip.asc">apache-senssoft-useralejs-1.0.0-bin.zip.asc</a></td>
- <td><a href="https://dist.apache.org/repos/dist/release/incubator/senssoft/apache-senssoft-useralejs-1.0.0/apache-senssoft-useralejs-1.0.0-bin.zip.sha512">apache-senssoft-useralejs-1.0.0-bin.zip.sha512</a></td>
+ <td><a href="http://www.apache.org/dyn/closer.cgi/incubator/flagon/apache-flagon-useralejs-incubating-1.0.0/apache-flagon-useralejs-incubating-1.0.0-bin.zip">apache-flagon-useralejs-incubating-1.0.0-bin.zip</a></td>
+ <td><a href="https://dist.apache.org/repos/dist/release/incubator/flagon/apache-flagon-useralejs-incubating-1.0.0/apache-flagon-useralejs-incubating-1.0.0-bin.zip.asc">apache-flagon-useralejs-incubating-1.0.0-bin.zip.asc</a></td>
+ <td><a href="https://dist.apache.org/repos/dist/release/incubator/flagon/apache-flagon-useralejs-incubating-1.0.0/apache-flagon-useralejs-incubating-1.0.0-bin.zip.sha512">apache-flagon-useralejs-incubating-1.0.0-bin.zip.sha512</a></td>
</tr>
<tr>
<td>Apache Flagon UserALE.js 1.0.0 (source tar.gz)</td>
- <td><a href="http://www.apache.org/dyn/closer.cgi/incubator/senssoft/apache-senssoft-useralejs-1.0.0/apache-senssoft-useralejs-1.0.0-src.tar.gz">apache-senssoft-useralejs-1.0.0-src.tar.gz</a></td>
- <td><a href="https://dist.apache.org/repos/dist/release/incubator/senssoft/apache-senssoft-useralejs-1.0.0/apache-senssoft-useralejs-1.0.0-src.tar.gz.asc">apache-senssoft-useralejs-1.0.0-src.tar.gz.asc</a> </td>
- <td><a href="https://dist.apache.org/repos/dist/release/incubator/senssoft/apache-senssoft-useralejs-1.0.0/apache-senssoft-useralejs-1.0.0-src.tar.gz.sha512">apache-senssoft-useralejs-1.0.0-src.tar.gz.sha512</a> </td>
+ <td><a href="http://www.apache.org/dyn/closer.cgi/incubator/flagon/apache-flagon-useralejs-incubating-1.0.0/apache-flagon-useralejs-incubating-1.0.0-src.tar.gz">apache-flagon-useralejs-incubating-1.0.0-src.tar.gz</a></td>
+ <td><a href="https://dist.apache.org/repos/dist/release/incubator/flagon/apache-flagon-useralejs-incubating-1.0.0/apache-flagon-useralejs-incubating-1.0.0-src.tar.gz.asc">apache-flagon-useralejs-incubating-1.0.0-src.tar.gz.asc</a> </td>
+ <td><a href="https://dist.apache.org/repos/dist/release/incubator/flagon/apache-flagon-useralejs-incubating-1.0.0/apache-flagon-useralejs-incubating-1.0.0-src.tar.gz.sha512">apache-flagon-useralejs-incubating-1.0.0-src.tar.gz.sha512</a> </td>
</tr>
<tr>
<td>Apache Flagon UserALE.js 1.0.0(source zip)</td>
- <td><a href="http://www.apache.org/dyn/closer.cgi/incubator/senssoft/apache-senssoft-useralejs-1.0.0/apache-senssoft-useralejs-1.0.0-src.zip">apache-senssoft-useralejs-1.0.0-src.zip</a></td>
- <td><a href="https://dist.apache.org/repos/dist/release/incubator/senssoft/apache-senssoft-useralejs-1.0.0/apache-senssoft-useralejs-1.0.0-src.zip.asc">apache-senssoft-useralejs-1.0.0-src.zip.asc</a></td>
- <td><a href="https://dist.apache.org/repos/dist/release/incubator/senssoft/apache-senssoft-useralejs-1.0.0/apache-senssoft-useralejs-1.0.0-src.zip.sha512">apache-senssoft-useralejs-1.0.0-src.zip.sha512</a></td>
+ <td><a href="http://www.apache.org/dyn/closer.cgi/incubator/flagon/apache-flagon-useralejs-incubating-1.0.0/apache-flagon-useralejs-incubating-1.0.0-src.zip">apache-flagon-useralejs-incubating-1.0.0-src.zip</a></td>
+ <td><a href="https://dist.apache.org/repos/dist/release/incubator/flagon/apache-flagon-useralejs-incubating-1.0.0/apache-flagon-useralejs-incubating-1.0.0-src.zip.asc">apache-flagon-useralejs-incubating-1.0.0-src.zip.asc</a></td>
+ <td><a href="https://dist.apache.org/repos/dist/release/incubator/flagon/apache-flagon-useralejs-incubating-1.0.0/apache-flagon-useralejs-incubating-1.0.0-src.zip.sha512">apache-flagon-useralejs-incubating-1.0.0-src.zip.sha512</a></td>
</tr>
</tbody>
</table>
@@ -147,7 +147,7 @@ The link in the 'Download Artifact' column below should display a default mirror
</p>
<p>
<code>
- $ gpg --verify apache-flagon-useralejs-1.0.0-src.zip.asc
+ $ gpg --verify apache-flagon-{product}-{version}-src.zip.asc
</code>
</p>
@@ -160,10 +160,10 @@ The link in the 'Download Artifact' column below should display a default mirror
Alternatively, you can verify the SHA512 signatures on the files. A unix program called md5 or md5sum is included in many unix distributions. Use the following example
</p>
<p>
- <code>$ sha512sum apache-flagon-useralejs-1.0.0-src.zip</code>
+ <code>$ sha512sum apache-flagon-{product}-{version}-src.zip</code>
</p>
<p>
- ... output should match the string in apache-flagon-useralejs-1.0.0-src.zip.sha512
+ ... output should match the string in apache-flagon-{product}-{version}-src.zip.sha512
</p>
</div>
</div>
diff --git a/content/stack/index.html b/content/stack/index.html
index 1e38857..e9e574b 100644
--- a/content/stack/index.html
+++ b/content/stack/index.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
diff --git a/content/stout/index.html b/content/stout/index.html
index 91ff65e..a50ad1e 100644
--- a/content/stout/index.html
+++ b/content/stout/index.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
diff --git a/content/tap/index.html b/content/tap/index.html
index 1af098d..30175e4 100644
--- a/content/tap/index.html
+++ b/content/tap/index.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
diff --git a/content/userale/index.html b/content/userale/index.html
index 81656ec..dba47a5 100644
--- a/content/userale/index.html
+++ b/content/userale/index.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
diff --git a/site/_site/community/index.html b/site/_site/community/index.html
index bdd134c..6f7099a 100644
--- a/site/_site/community/index.html
+++ b/site/_site/community/index.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
diff --git a/site/_site/distill/index.html b/site/_site/distill/index.html
index 32e1e74..e52868d 100644
--- a/site/_site/distill/index.html
+++ b/site/_site/distill/index.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
diff --git a/site/_site/docs/contributing/index.html b/site/_site/docs/contributing/index.html
index 24d6254..2abc170 100644
--- a/site/_site/docs/contributing/index.html
+++ b/site/_site/docs/contributing/index.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/site/_site/docs/distill/analytics.html b/site/_site/docs/distill/analytics.html
index 90bc760..4e8620e 100644
--- a/site/_site/docs/distill/analytics.html
+++ b/site/_site/docs/distill/analytics.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/site/_site/docs/distill/api.html b/site/_site/docs/distill/api.html
index cc7e1a9..78ea91a 100644
--- a/site/_site/docs/distill/api.html
+++ b/site/_site/docs/distill/api.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/site/_site/docs/distill/changelog.html b/site/_site/docs/distill/changelog.html
index 39c543f..802a8c7 100644
--- a/site/_site/docs/distill/changelog.html
+++ b/site/_site/docs/distill/changelog.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/site/_site/docs/distill/http.html b/site/_site/docs/distill/http.html
index 80d94f5..e2171a8 100644
--- a/site/_site/docs/distill/http.html
+++ b/site/_site/docs/distill/http.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/site/_site/docs/distill/index.html b/site/_site/docs/distill/index.html
index dcc37bd..7268156 100644
--- a/site/_site/docs/distill/index.html
+++ b/site/_site/docs/distill/index.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/site/_site/docs/distill/models.html b/site/_site/docs/distill/models.html
index 1ec0761..a4112d1 100644
--- a/site/_site/docs/distill/models.html
+++ b/site/_site/docs/distill/models.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/site/_site/docs/distill/start.html b/site/_site/docs/distill/start.html
index d4562fe..a546d67 100644
--- a/site/_site/docs/distill/start.html
+++ b/site/_site/docs/distill/start.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/site/_site/docs/distill/utilities.html b/site/_site/docs/distill/utilities.html
index e688eac..3cff8fc 100644
--- a/site/_site/docs/distill/utilities.html
+++ b/site/_site/docs/distill/utilities.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/site/_site/docs/index.html b/site/_site/docs/index.html
index 4b5be6e..43e647c 100644
--- a/site/_site/docs/index.html
+++ b/site/_site/docs/index.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/site/_site/docs/stack/index.html b/site/_site/docs/stack/index.html
index e71a83a..c8c1f89 100644
--- a/site/_site/docs/stack/index.html
+++ b/site/_site/docs/stack/index.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/site/_site/docs/stack/scaling/index.html b/site/_site/docs/stack/scaling/index.html
index b58dc5d..6b544ab 100644
--- a/site/_site/docs/stack/scaling/index.html
+++ b/site/_site/docs/stack/scaling/index.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/site/_site/docs/stout/index.html b/site/_site/docs/stout/index.html
index 13b6ac9..b12ebe4 100644
--- a/site/_site/docs/stout/index.html
+++ b/site/_site/docs/stout/index.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/site/_site/docs/stout/start.html b/site/_site/docs/stout/start.html
index 137e72c..ad8b1b3 100644
--- a/site/_site/docs/stout/start.html
+++ b/site/_site/docs/stout/start.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/site/_site/docs/tap/index.html b/site/_site/docs/tap/index.html
index 091d3cd..37dfa06 100644
--- a/site/_site/docs/tap/index.html
+++ b/site/_site/docs/tap/index.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/site/_site/docs/userale/index.html b/site/_site/docs/userale/index.html
index 377e683..03d8c34 100644
--- a/site/_site/docs/userale/index.html
+++ b/site/_site/docs/userale/index.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/site/_site/docs/useralejs/API/index.html b/site/_site/docs/useralejs/API/index.html
new file mode 100644
index 0000000..96f1f9a
--- /dev/null
+++ b/site/_site/docs/useralejs/API/index.html
@@ -0,0 +1,476 @@
+<!DOCTYPE html>
+<html lang="en">
+
+ <head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1">
+
+ <title>The UserALE.js API</title>
+ <meta name="description" content="Apache UserALE.js features a robust API that allows you customize official Apache Flagon UserALE.js builds page-by-page to suite your needs.">
+
+ <link rel="stylesheet" type="text/css" href="/semantic/dist/semantic.min.css">
+ <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.1/jquery.min.js"></script>
+ <script src="/semantic/dist/semantic.min.js"></script>
+ <script src="https://d3js.org/d3.v4.min.js"></script>
+ <script src="/js/main.js"></script>
+
+ <link rel="stylesheet" href="/assets/main.css">
+ <link rel="canonical" href="http://flagon.incubator.apache.org/docs/useralejs/API/">
+ <link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
+
+
+</head>
+
+
+ <body>
+
+ <div class="site-header">
+ <div id="main-menu" class="ui inverted padded fixed top borderless menu">
+ <a class="site-title" href="/">
+ <h3 class="ui inverted header item">Apache Flagon</h3>
+ </a>
+
+ <div class="right menu">
+ <div class="ui dropdown item">
+ Products
+ <div class="menu">
+ <a class="item" href="/stack">Stack</a>
+ <a class="item" href="/userale">UserALE</a>
+ <a class="item" href="/distill">Distill</a>
+ <a class="item" href="/tap">Tap</a>
+ <a class="item" href="/stout">Stout</a>
+ </div>
+ </div>
+ <div class="ui dropdown item">
+ <a href="/docs">Docs</a>
+ <div class="menu">
+ <a class="item" href="/docs/stack">Stack</a>
+ <a class="item" href="/docs/userale">UserALE</a>
+ <a class="item" href="/docs/useralejs">UserALE.js</a>
+ <a class="item" href="/docs/useralepy">UserALE.py</a>
+ <a class="item" href="/docs/distill">Distill</a>
+ <a class="item" href="/docs/tap">Tap</a>
+ <a class="item" href="/docs/stout">Stout</a>
+ </div>
+ </div>
+ <a class="item" href="/releases">Releases</a>
+ <a class="item" href="/community">Community</a>
+ </div>
+ </div>
+</div>
+
+
+ <div class="main-wrapper">
+ <div class="docs-wrapper">
+ <div class="docs-sidebar">
+
+
+
+
+
+
+
+
+
+<!-- <div class="ui inverted list">
+ <a class="item" href="/docs">About the Docs</a>
+</div> -->
+<div id="docs-nav" class="ui inverted accordion">
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ Apache Flagon
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/">About the Docs</a>
+
+ <a class="item" href="/docs/contributing/">Contributing</a>
+
+ </div>
+ </div>
+
+
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ Stack
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/stack/">Getting Started</a>
+
+ <a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
+
+ </div>
+ </div>
+
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ UserALE
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/userale/">About UserALE</a>
+
+ </div>
+ </div>
+
+
+ <div class="active title">
+
+ <i class="dropdown icon"></i>
+ UserALE.js
+ </div>
+
+ <div class="active content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/useralejs/">Getting Started</a>
+
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
+
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
+
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
+
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
+
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
+
+ </div>
+ </div>
+
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ UserALE.py
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/useralepy/">Installation</a>
+
+ <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
+
+ <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
+
+ <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
+
+ </div>
+ </div>
+
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ Distill
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/distill/">Installation</a>
+
+ <a class="item" href="/docs/distill/start.html">Getting Started</a>
+
+ <a class="item" href="/docs/distill/api.html">API Documentation</a>
+
+ <a class="item" href="/docs/distill/analytics.html">Apache Distill Analytics</a>
+
+ <a class="item" href="/docs/distill/http.html">Apache Distill HTTP Client</a>
+
+ <a class="item" href="/docs/distill/models.html">Apache Distill Models</a>
+
+ <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a>
+
+ <a class="item" href="/docs/distill/changelog.html">Changelog</a>
+
+ </div>
+ </div>
+
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ Tap
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/tap/">Getting Started</a>
+
+ </div>
+ </div>
+
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ Stout
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/stout/">About Stout</a>
+
+ <a class="item" href="/docs/stout/start.html">Getting Started</a>
+
+ </div>
+ </div>
+</div>
+
+ </div>
+ <div class="docs-content">
+ <h2 class="ui header">The UserALE.js API</h2>
+ <p><a href="https://github.com/apache/incubator-flagon-useralejs">Apache UserALE.js</a> features a robust API that allows you
+customize official Apache Flagon UserALE.js <a href="https://github.com/apache/incubator-flagon-useralejs/tree/master/build">builds</a> page-by-page to suite your needs.</p>
+
+<p>The API exposes two functions: <code class="highlighter-rouge">setLogFilter</code> & <code class="highlighter-rouge">setLogMapper</code>. With these two powerful functions, you have a lot of
+latitude in customizing and curating your logs.</p>
+
+<h1 id="api-usage">API Usage</h1>
+
+<p>To invoke the API, simply add additional javascript code blocks under your UserALE.js script tag.</p>
+
+<p>Don’t forget to add the UserALE.js script tag:</p>
+
+<div class="language-html highlighter-rouge"><pre class="highlight"><code><span class="nt"><head></span>
+ <span class="nt"><title></span>UserAleJS - Example Page<span class="nt"></title></span>
+ <span class="c"><!--
+ Add the UserALE.js script tag to the top of your doc
+ --></span>
+ <span class="nt"><script </span><span class="na">src=</span><span class="s">"/path/to/userale-1.0.0.min.js"</span> <span class="na">data-url=</span><span class="s">"http://yourLoggingUrl"</span><span class="nt">></script></span>
+</code></pre>
+</div>
+
+<h2 id="setlogfilter-examples"><code class="highlighter-rouge">setLogFilter</code> Examples</h2>
+
+<p><code class="highlighter-rouge">setLogFilter</code> allows you to eliminate log data you don’t need or want from your log stream:</p>
+
+<div class="language-html highlighter-rouge"><pre class="highlight"><code><span class="c"><!--
+Add additional code blocks to set the filters you want
+This simple array filter pulls mouseover data out of your log stream
+--></span>
+ <span class="nt"><script </span><span class="na">type=</span><span class="s">"text/javascript"</span><span class="nt">></span>
+ <span class="nb">window</span><span class="p">.</span><span class="nx">userale</span><span class="p">.</span><span class="nx">filter</span><span class="p">(</span><span class="kd">function</span> <span class="p">(</span><span class="nx">log</span><span class="p">)</span> <span class="p">{</span>
+ <span class="k">return</span> <span class="p">(</span><span class="nx">log</span><span class="p">.</span><span class="nx">type</span> <span class="o">!=</span> <span class="s1">'mouseover'</span><span class="p">);</span>
+ <span class="p">});</span>
+ <span class="nt"></script></span>
+</code></pre>
+</div>
+
+<p>Here is one UserALE.js filter to rule them all!</p>
+
+<div class="language-html highlighter-rouge"><pre class="highlight"><code><span class="c"><!--
+Modify the array page-by-page to curate your log stream:
+by adding unwanted event 'types' in type_array;
+by adding unwanted log classes to eliminate 'raw' or 'interval' logs from your stream.
+--></span>
+ <span class="nt"><script </span><span class="na">type=</span><span class="s">"text/javascript"</span><span class="nt">></span>
+ <span class="kd">var</span> <span class="nx">type_array</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'mouseup'</span><span class="p">,</span> <span class="s1">'mouseover'</span><span class="p">,</span> <span class="s1">'dblclick'</span><span class="p">,</span> <span class="s1">'blur'</span><span class="p">,</span> <span class="s1">'focus'</span><span class="p">]</span>
+ <span class="kd">var</span> <span class="nx">logType_array</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'interval'</span><span class="p">]</span>
+ <span class="nb">window</span><span class="p">.</span><span class="nx">userale</span><span class="p">.</span><span class="nx">filter</span><span class="p">(</span><span class="kd">function</span> <span class="p">(</span><span class="nx">log</span><span class="p">)</span> <span class="p">{</span>
+ <span class="k">return</span> <span class="o">!</span><span class="nx">type_array</span><span class="p">.</span><span class="nx">includes</span><span class="p">(</span><span class="nx">log</span><span class="p">.</span><span class="nx">type</span><span class="p">)</span> <span class="o">&&</span> <span class="o">!</span><span class="nx">logType_array</span><span class="p">.</span><span class="nx">includes</span><span class="p">(</span><span class="nx">log</span><span class= [...]
+ <span class="p">});</span>
+ <span class="nt"></script></span>
+</code></pre>
+</div>
+
+<p>You can also use the <code class="highlighter-rouge">setLogFilter</code> function to do other cool stuff. Below is an example for how to further modify the
+rate at which UserALE.js collects data, but dropping every other log (odd-even) in the logging queue.</p>
+
+<div class="language-html highlighter-rouge"><pre class="highlight"><code> <span class="nt"><script </span><span class="na">type=</span><span class="s">"text/javascript"</span><span class="nt">></span>
+ <span class="kd">var</span> <span class="nx">logCounter</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
+ <span class="nb">window</span><span class="p">.</span><span class="nx">userale</span><span class="p">.</span><span class="nx">filter</span><span class="p">(</span><span class="kd">function</span> <span class="p">(</span><span class="nx">log</span><span class="p">)</span> <span class="p">{</span>
+ <span class="k">return</span> <span class="p">(</span><span class="nx">logCounter</span><span class="o">++</span> <span class="o">%</span> <span class="mi">2</span><span class="p">);</span>
+ <span class="p">});</span>
+ <span class="nt"></script></span>
+</code></pre>
+</div>
+
+<h2 id="setlogmapper-examples"><code class="highlighter-rouge">setLogMapper</code> Examples</h2>
+
+<p><code class="highlighter-rouge">setLogMapper</code> allows you to modify or add new fields to UserALE.js logs.</p>
+
+<p>This simple mapping function adds a new log field for custom labels you want to attach to certain elements:</p>
+
+<div class="language-html highlighter-rouge"><pre class="highlight"><code><span class="c"><!--
+This will add your label to all event logs that reference a particular DOM target.
+--></span>
+ <span class="nt"><script </span><span class="na">type=</span><span class="s">"text/javascript"</span><span class="nt">></span>
+ <span class="nb">window</span><span class="p">.</span><span class="nx">userale</span><span class="p">.</span><span class="nx">map</span><span class="p">(</span><span class="kd">function</span> <span class="p">(</span><span class="nx">log</span><span class="p">)</span> <span class="p">{</span>
+ <span class="kd">var</span> <span class="nx">targetsForLabels</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"button#test_button"</span><span class="p">];</span>
+ <span class="k">if</span> <span class="p">(</span><span class="nx">targetsForLabels</span><span class="p">.</span><span class="nx">includes</span><span class="p">(</span><span class="nx">log</span><span class="p">.</span><span class="nx">target</span><span class="p">))</span> <span class="p">{</span>
+ <span class="k">return</span> <span class="nb">Object</span><span class="p">.</span><span class="nx">assign</span><span class="p">({},</span> <span class="nx">log</span><span class="p">,</span> <span class="p">{</span> <span class="na">CustomLabel</span><span class="p">:</span> <span class="s2">"Click me!"</span> <span class="p">});</span>
+ <span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
+ <span class="k">return</span> <span class="nx">log</span><span class="p">;</span>
+ <span class="p">}</span>
+ <span class="p">});</span>
+ <span class="nt"></script></span>
+</code></pre>
+</div>
+
+<p>This cool mapping function adds a progressive count on a given element (“app”) and writes to a new log field
+called “score”</p>
+
+<div class="language-html highlighter-rouge"><pre class="highlight"><code> <span class="nt"></head></span>
+ <span class="nt"><body></span>
+ <span class="nt"><div</span> <span class="na">id=</span><span class="s">"app"</span><span class="nt">></span>
+ <span class="nt"><button</span> <span class="na">id=</span><span class="s">"increment"</span><span class="nt">></span>+<span class="nt"></button></span>
+ <span class="nt"><button</span> <span class="na">id=</span><span class="s">"decrement"</span><span class="nt">></span>-<span class="nt"></button></span>
+ <span class="nt"><div</span> <span class="na">id=</span><span class="s">"scoreboard"</span><span class="nt">></div></span>
+ <span class="nt"></div></span>
+ <span class="nt"></script></span>
+
+ <span class="nt"><script </span><span class="na">type=</span><span class="s">"text/javascript"</span><span class="nt">></span>
+ <span class="kd">var</span> <span class="nx">score</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
+ <span class="kd">var</span> <span class="nx">scoreBoard</span> <span class="o">=</span> <span class="nb">document</span><span class="p">.</span><span class="nx">getElementById</span><span class="p">(</span><span class="s1">'scoreboard'</span><span class="p">);</span>
+ <span class="nx">scoreBoard</span><span class="p">.</span><span class="nx">innerText</span> <span class="o">=</span> <span class="s1">'0'</span><span class="p">;</span>
+
+ <span class="kd">function</span> <span class="nx">setScore</span><span class="p">(</span><span class="nx">nextScore</span><span class="p">)</span> <span class="p">{</span>
+ <span class="nx">score</span> <span class="o">=</span> <span class="nx">nextScore</span><span class="p">;</span>
+ <span class="nx">scoreBoard</span><span class="p">.</span><span class="nx">innerText</span> <span class="o">=</span> <span class="nb">String</span><span class="p">(</span><span class="nx">score</span><span class="p">);</span>
+ <span class="p">}</span>
+
+ <span class="nb">document</span><span class="p">.</span><span class="nx">getElementById</span><span class="p">(</span><span class="s1">'increment'</span><span class="p">).</span><span class="nx">addEventListener</span><span class="p">(</span><span class="s1">'click'</span><span class="p">,</span> <span class="kd">function</span> <span class="p">()</span> <span class="p">{</span>
+ <span class="nx">setScore</span><span class="p">(</span><span class="nx">score</span> <span class="o">+</span> <span class="mi">1</span><span class="p">);</span>
+ <span class="p">});</span>
+
+ <span class="nb">document</span><span class="p">.</span><span class="nx">getElementById</span><span class="p">(</span><span class="s1">'decrement'</span><span class="p">).</span><span class="nx">addEventListener</span><span class="p">(</span><span class="s1">'click'</span><span class="p">,</span> <span class="kd">function</span> <span class="p">()</span> <span class="p">{</span>
+ <span class="k">if</span> <span class="p">(</span><span class="nx">score</span><span class="p">)</span> <span class="p">{</span>
+ <span class="nx">setScore</span><span class="p">(</span><span class="nx">score</span> <span class="o">-</span> <span class="mi">1</span><span class="p">);</span>
+ <span class="p">}</span>
+ <span class="p">});</span>
+
+ <span class="nb">window</span><span class="p">.</span><span class="nx">userale</span><span class="p">.</span><span class="nx">map</span><span class="p">(</span><span class="kd">function</span> <span class="p">(</span><span class="nx">log</span><span class="p">)</span> <span class="p">{</span>
+ <span class="k">return</span> <span class="nb">Object</span><span class="p">.</span><span class="nx">assign</span><span class="p">({},</span> <span class="nx">log</span><span class="p">,</span> <span class="p">{</span> <span class="na">score</span><span class="p">:</span> <span class="nx">score</span> <span class="p">});</span> <span class="c1">// Add the "score" property to the log</span>
+ <span class="p">});</span>
+ <span class="nt"></script></span>
+ <span class="nt"></body></span>
+<span class="nt"></html></span>
+
+</code></pre>
+</div>
+
+<p>Test these examples out in our UserALE.js <a href="https://github.com/apache/incubator-flagon-useralejs/blob/master/example/index.html">example page</a> test utility!</p>
+
+<h3 id="benefits-of-the-useralejs-api">Benefits of the UserALE.js API</h3>
+<ul>
+ <li>No need to dig into our source code</li>
+ <li>Version control is easy and no need to sweat merges–just download the latest <a href="/releases">release</a>,
+ or update via <a href="https://www.npmjs.com/package/flagon-userale">npm</a>.</li>
+ <li>Manage logs page-by-page, ideal for large or complex sites</li>
+ <li>Use basic or best-practice JS styles and methods to build your own filters, no need to learn weird custom syntax.</li>
+</ul>
+
+<h2 id="contributing">Contributing</h2>
+
+<p>Contributions are welcome! Simply <a href="https://issues.apache.org/jira/browse/FLAGON">submit an issue report</a> for problems
+you encounter or a pull request for your feature or bug fix. The core team will review it and work with you to
+incorporate it into UserALE.js.</p>
+
+ </div>
+</div>
+
+ </div>
+
+ <div class="footer ui inverted very padded vertical segment">
+ <div class="ui vertical segment">
+ <div class="ui four column grid">
+ <div class="column">
+ <h4 class="ui inverted header">About</h4>
+ <div class="ui inverted link list">
+ <a class="item" href="/stack">Stack</a>
+ <a class="item" href="/userale">UserALE</a>
+ <a class="item" href="/distill">Distill</a>
+ <a class="item" href="/tap">Tap</a>
+ <a class="item" href="/stout">Stout</a>
+ </div>
+ </div>
+ <div class="column">
+ <h4 class="ui inverted header">Docs</h4>
+ <div class="ui inverted link list">
+ <a class="item" href="/docs/stack">Stack</a>
+ <a class="item" href="/docs/userale">UserALE</a>
+ <a class="item" href="/docs/useralejs">UserAle.js</a>
+ <a class="item" href="/docs/useralepy">UserAle.py</a>
+ <a class="item" href="/docs/distill">Distill</a>
+ <a class="item" href="/docs/tap">Tap</a>
+ <a class="item" href="/docs/stout">Stout</a>
+ </div>
+ </div>
+ <div class="column">
+ <h4 class="ui inverted header">Community</h4>
+ <div class="ui inverted link list">
+ <a class="item" href="https://github.com/apache?q=flagon">GitHub</a>
+ <a class="item" href="http://stackoverflow.com/questions/tagged/apache-flagon">StackOverflow</a>
+ <a class="item" href="https://issues.apache.org/jira/browse/FLAGON">Jira Issue Tracker</a>
+ <a class="item" href="https://cwiki.apache.org/confluence/display/FLAGON">Project Wiki</a>
+ <a class="item" href="https://twitter.com/ApacheFlagon">Twitter</a>
+ </div>
+ </div>
+ <div class="column">
+ <h4 class="ui inverted header">Apache</h4>
+ <div class="ui inverted link list">
+ <a class="item" href="http://www.apache.org/">Apache Software Foundation</a>
+ <a class="item" href="http://www.apache.org/licenses/">License</a>
+ <a class="item" href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
+ <a class="item" href="http://www.apache.org/foundation/thanks.html">Thanks</a>
+ <a class="item" href="http://www.apache.org/security/">Security</a>
+ </div>
+ </div>
+ </div>
+ </div>
+ <div class="ui inverted vertical segment">
+ <div class="ui two column middle aligned grid">
+ <div class="column">
+ Apache Flagon is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the [...]
+ </div>
+ <div class="center aligned column">
+ Copyright © 2019 The Apache Software Foundation, Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.<br>
+ Apache Flagon, Flagon, Apache, the Apache feather logo, the Apache Flagon logo and the Apache Incubator logo are trademarks of The Apache Software Foundation.
+ </div>
+ </div>
+ </div>
+ <div class="ui inverted vertical segment">
+ <div class="ui one column middle aligned grid">
+ <div class="center aligned column">
+ <a href="http://incubator.apache.org/">
+ <img src="/images/incubator-logo-white.jpg">
+ </a>
+ <a href="https://www.apache.org/events/current-event.html">
+ <img src="https://www.apache.org/events/current-event-234x60.png" alt="ASF Current Event">
+ </a>
+ </div>
+ </div>
+ </div>
+</div>
+
+
+ </body>
+
+</html>
diff --git a/site/_site/docs/distill/utilities.html b/site/_site/docs/useralejs/build/index.html
similarity index 67%
copy from site/_site/docs/distill/utilities.html
copy to site/_site/docs/useralejs/build/index.html
index e688eac..acf5509 100644
--- a/site/_site/docs/distill/utilities.html
+++ b/site/_site/docs/useralejs/build/index.html
@@ -6,8 +6,8 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
- <title>Apache Distill Utilities</title>
- <meta name="description" content="Query Builder class distill.utils.query_builder.QueryBuilder(query=None)">
+ <title>UserALE.js Build and Test</title>
+ <meta name="description" content="To build Apache UserALE.js, you will need to clone our repo and install NPM and Node.js.">
<link rel="stylesheet" type="text/css" href="/semantic/dist/semantic.min.css">
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.1/jquery.min.js"></script>
@@ -16,7 +16,7 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://flagon.incubator.apache.org/docs/distill/utilities.html">
+ <link rel="canonical" href="http://flagon.incubator.apache.org/docs/useralejs/build/">
<link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -131,27 +131,27 @@
</div>
- <div class="title">
+ <div class="active title">
<i class="dropdown icon"></i>
UserALE.js
</div>
- <div class="content">
+ <div class="active content">
<div class="ui inverted bulleted list docs-list">
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
@@ -179,13 +179,13 @@
</div>
- <div class="active title">
+ <div class="title">
<i class="dropdown icon"></i>
Distill
</div>
- <div class="active content">
+ <div class="content">
<div class="ui inverted bulleted list docs-list">
@@ -245,105 +245,116 @@
</div>
<div class="docs-content">
- <h2 class="ui header">Apache Distill Utilities</h2>
- <h3 id="query-builder">Query Builder</h3>
-<blockquote>
-
- <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="k">class</span> <span class="nc">distill</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">query_builder</span><span class="o">.</span><span class="n">QueryBuilder</span><span class="p">(</span><span class="n">query</span><span class="o">=</span><span class="bp">None</span><span class="p">)</span>
-</code></pre>
- </div>
-</blockquote>
-
-<blockquote>
- <p><strong>Bases:</strong> object</p>
-</blockquote>
-
-<h4 id="add_filtersfilters">add_filters(filters)</h4>
+ <h2 class="ui header">UserALE.js Build and Test</h2>
+ <p>To build <a href="https://github.com/apache/incubator-flagon-useralejs/tree/master">Apache UserALE.js</a>, you will need to clone our repo and install <a href="https://nodejs.org/">NPM and Node.js</a>.</p>
-<h4 id="add_sortingsort_field-sort_order">add_sorting(sort_field=’’, sort_order=’’)</h4>
+<p>UserALE.js utilizes NPM for package and dependency management. Execute the following to install dependencies.</p>
+<div class="highlighter-rouge"><pre class="highlight"><code>#install required packages
+npm install
-<h3 id="exception-handling">Exception Handling</h3>
-<blockquote>
-
- <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="n">exception</span> <span class="n">distill</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">exceptions</span><span class="o">.</span><span class="n">Error</span>
+#review major dependencies
+npm ls --depth=0
</code></pre>
- </div>
-</blockquote>
-
-<blockquote>
- <p><strong>Bases:</strong> exceptions.Exception</p>
-</blockquote>
+</div>
-<blockquote>
- <p>Base class for exceptions.</p>
-</blockquote>
+<h2 id="build">Build</h2>
-<blockquote>
+<p>UserALE.js uses Gulp to manage build tasking. These tasks are executed through our build script; use the following to execute:</p>
- <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="n">exception</span> <span class="n">distill</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">exceptions</span><span class="o">.</span><span class="n">ValidationError</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">msg</span><span class="p">)</span>
+<div class="highlighter-rouge"><pre class="highlight"><code>#Build UserALE.js
+npm run build
</code></pre>
- </div>
-</blockquote>
-
-<blockquote>
- <p><strong>Bases:</strong> distill.utils.exceptions.Error</p>
-</blockquote>
+</div>
-<blockquote>
- <p>Exceptions raised for errors in validated a url.</p>
-</blockquote>
+<h2 id="test">Test</h2>
-<h3 id="validation-library">Validation Library</h3>
-<blockquote>
+<p>UserALE.js uses JSDOM and Mocha to execute unit tests, which are integrated into our build pipeline. See <code class="highlighter-rouge">package.json</code> for full script options.</p>
- <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="n">distill</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">validation</span><span class="o">.</span><span class="n">str2bool</span><span class="p">(</span><span class="n">v</span><span class="p">)</span>
+<p>To run tests:</p>
+<div class="highlighter-rouge"><pre class="highlight"><code>#Run UserALE.js unit tests
+npm run test
</code></pre>
- </div>
-</blockquote>
-
-<blockquote>
- <p>Convert string expression to boolean</p>
-</blockquote>
-
-<blockquote>
- <p><strong>Parameters:</strong></p>
- <ul>
- <li>v – Input value</li>
- </ul>
-</blockquote>
-
-<blockquote>
- <p><strong>Returns:</strong></p>
- <ul>
- <li>Converted message as boolean type</li>
- <li>Return type: bool</li>
- </ul>
-</blockquote>
-
-<blockquote>
-
- <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="n">distill</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">validation</span><span class="o">.</span><span class="n">validate_request</span><span class="p">(</span><span class="n">q</span><span class="p">)</span>
+</div>
+<p>… you’ll see something like:</p>
+<div class="highlighter-rouge"><pre class="highlight"><code>...
+ attachHandlers
+ ✓ attaches all the event handlers without duplicates
+ ✓ debounces bufferedEvents (505ms)
+ defineDetails
+ - configures high detail events correctly
+
+ configure
+ ✓ merges new configs into main config object
+ ✓ includes a userid if present in the window.location
+ getUserIdFromParams
+ ✓ fetches userId from URL params
+ ✓ returns null if no matching param
+
+ getInitialSettings
+ timeStampScale
+ ✓ no event.timestamp
+ ✓ zero
+ ✓ epoch milliseconds
+ ✓ epoch microseconds
+ ✓ performance navigation time
+ getInitialSettings
+ ✓ fetches all settings from a script tag (122ms)
+ ✓ grabs user id from params
+
+ Userale API
+ ✓ provides configs
+ ✓ edits configs
+ ✓ starts + stops (214ms)
+ ✓ sends custom logs
+
+ packageLogs
+ setLogFilter
+ ✓ assigns the handler to the provided value
+ ✓ allows the handler to be nulled
+ setLogMapper
+ ✓ assigns the handler to the provided value
+ ✓ allows the handler to be nulled
+ packageLog
+ ✓ only executes if on
+ ✓ calls detailFcn with the event as an argument if provided
+ ✓ packages logs
+ ✓ filters logs when a handler is assigned and returns false
+ ✓ assigns logs to the mapper's return value if a handler is assigned
+ ✓ does not call the map handler if the log is filtered out
+ ✓ does not attempt to call a non-function filter/mapper
+ extractTimeFields
+ ✓ returns the millisecond and microsecond portions of a timestamp
+ ✓ sets micro to 0 when no decimal is present
+ ✓ always returns an object
+ getLocation
+ ✓ returns event page location
+ ✓ calculates page location if unavailable
+ ✓ fails to null
+ selectorizePath
+ ✓ returns a new array of the same length provided
+ getSelector
+ ✓ builds a selector
+ ✓ identifies window
+ ✓ handles a non-null unknown value
+ buildPath
+ ✓ builds a path
+ ✓ defaults to path if available
+
+ sendLogs
+ ✓ sends logs on an interval
+ ✓ does not send logs if the config is off
+ ✓ sends logs on page exit with navigator
+ ✓ sends logs on page exit without navigator
+ ✓ does not send logs on page exit if config is off
+
+
+ 45 passing (954ms)
+ 1 pending
</code></pre>
- </div>
-</blockquote>
-
-<blockquote>
- <p>Parse out request message and validate inputs</p>
-</blockquote>
-
-<blockquote>
- <p><strong>Parameters:</strong></p>
- <ul>
- <li>q – Url query string</li>
- </ul>
-</blockquote>
-
-<blockquote>
- <p><strong>Raises:</strong></p>
- <ul>
- <li>ValidationError – if the query is missing required parameters</li>
- </ul>
-</blockquote>
+</div>
+<p>Any failing tests will also be logged in the terminal. If there are failing tests, please consider <a href="https://issues.apache.org/jira/projects/FLAGON">logging an issue in JIRA</a>.</p>
+
+<p>Further instructions can be found in our <a href="https://github.com/apache/incubator-flagon-useralejs/blob/master/README.md">README</a></p>
</div>
</div>
diff --git a/site/_site/docs/useralejs/dataschema/index.html b/site/_site/docs/useralejs/dataschema/index.html
new file mode 100644
index 0000000..ba0482b
--- /dev/null
+++ b/site/_site/docs/useralejs/dataschema/index.html
@@ -0,0 +1,604 @@
+<!DOCTYPE html>
+<html lang="en">
+
+ <head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1">
+
+ <title>UserALE.js' Data Schema</title>
+ <meta name="description" content="This guide describes the structure of content of Apache UserALE.js logs, including: which behaviors UserALE.js listens to; which meta data UserALE.js attache...">
+
+ <link rel="stylesheet" type="text/css" href="/semantic/dist/semantic.min.css">
+ <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.1/jquery.min.js"></script>
+ <script src="/semantic/dist/semantic.min.js"></script>
+ <script src="https://d3js.org/d3.v4.min.js"></script>
+ <script src="/js/main.js"></script>
+
+ <link rel="stylesheet" href="/assets/main.css">
+ <link rel="canonical" href="http://flagon.incubator.apache.org/docs/useralejs/dataschema/">
+ <link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
+
+
+</head>
+
+
+ <body>
+
+ <div class="site-header">
+ <div id="main-menu" class="ui inverted padded fixed top borderless menu">
+ <a class="site-title" href="/">
+ <h3 class="ui inverted header item">Apache Flagon</h3>
+ </a>
+
+ <div class="right menu">
+ <div class="ui dropdown item">
+ Products
+ <div class="menu">
+ <a class="item" href="/stack">Stack</a>
+ <a class="item" href="/userale">UserALE</a>
+ <a class="item" href="/distill">Distill</a>
+ <a class="item" href="/tap">Tap</a>
+ <a class="item" href="/stout">Stout</a>
+ </div>
+ </div>
+ <div class="ui dropdown item">
+ <a href="/docs">Docs</a>
+ <div class="menu">
+ <a class="item" href="/docs/stack">Stack</a>
+ <a class="item" href="/docs/userale">UserALE</a>
+ <a class="item" href="/docs/useralejs">UserALE.js</a>
+ <a class="item" href="/docs/useralepy">UserALE.py</a>
+ <a class="item" href="/docs/distill">Distill</a>
+ <a class="item" href="/docs/tap">Tap</a>
+ <a class="item" href="/docs/stout">Stout</a>
+ </div>
+ </div>
+ <a class="item" href="/releases">Releases</a>
+ <a class="item" href="/community">Community</a>
+ </div>
+ </div>
+</div>
+
+
+ <div class="main-wrapper">
+ <div class="docs-wrapper">
+ <div class="docs-sidebar">
+
+
+
+
+
+
+
+
+
+<!-- <div class="ui inverted list">
+ <a class="item" href="/docs">About the Docs</a>
+</div> -->
+<div id="docs-nav" class="ui inverted accordion">
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ Apache Flagon
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/">About the Docs</a>
+
+ <a class="item" href="/docs/contributing/">Contributing</a>
+
+ </div>
+ </div>
+
+
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ Stack
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/stack/">Getting Started</a>
+
+ <a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
+
+ </div>
+ </div>
+
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ UserALE
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/userale/">About UserALE</a>
+
+ </div>
+ </div>
+
+
+ <div class="active title">
+
+ <i class="dropdown icon"></i>
+ UserALE.js
+ </div>
+
+ <div class="active content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/useralejs/">Getting Started</a>
+
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
+
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
+
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
+
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
+
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
+
+ </div>
+ </div>
+
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ UserALE.py
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/useralepy/">Installation</a>
+
+ <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
+
+ <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
+
+ <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
+
+ </div>
+ </div>
+
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ Distill
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/distill/">Installation</a>
+
+ <a class="item" href="/docs/distill/start.html">Getting Started</a>
+
+ <a class="item" href="/docs/distill/api.html">API Documentation</a>
+
+ <a class="item" href="/docs/distill/analytics.html">Apache Distill Analytics</a>
+
+ <a class="item" href="/docs/distill/http.html">Apache Distill HTTP Client</a>
+
+ <a class="item" href="/docs/distill/models.html">Apache Distill Models</a>
+
+ <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a>
+
+ <a class="item" href="/docs/distill/changelog.html">Changelog</a>
+
+ </div>
+ </div>
+
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ Tap
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/tap/">Getting Started</a>
+
+ </div>
+ </div>
+
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ Stout
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/stout/">About Stout</a>
+
+ <a class="item" href="/docs/stout/start.html">Getting Started</a>
+
+ </div>
+ </div>
+</div>
+
+ </div>
+ <div class="docs-content">
+ <h2 class="ui header">UserALE.js' Data Schema</h2>
+ <p>This guide describes the structure of content of <a href="https://github.com/apache/incubator-flagon-useralejs">Apache UserALE.js</a>
+logs, including:</p>
+<ul>
+ <li>which behaviors UserALE.js listens to;</li>
+ <li>which meta data UserALE.js attaches to logs, for context:</li>
+ <li>different types of UserALE.js logs, and their usage.</li>
+</ul>
+
+<h2 id="useralejs-logs">UserALE.js Logs</h2>
+
+<p>UserALE.js logs, by default, contain a lot more data than other business analytics products because it is powerful enough for <em>workflow analysis</em>.</p>
+
+<p>Workflow analysis is about understanding the complex interdependency between elements and behaviors within and across
+pages. Workflow analysis at this level is really crucial for understanding:</p>
+<ul>
+ <li>how people think about the information on your site or app</li>
+ <li>understanding efficiency in information discovery</li>
+ <li>and for gauging how novices explore pages compared to experts or superusers.</li>
+</ul>
+
+<p>In order to do workflow analysis, UserALE.js generates granular data about interactions with page elements.</p>
+
+<p>This is a standard UserALE.js log from our <a href="https://github.com/apache/incubator-flagon-useralejs/blob/master/example/index.html">example test utility</a>:</p>
+
+<div class="language-html highlighter-rouge"><pre class="highlight"><code> "microTime": 0.185,
+ "minor_ver": "0",
+ "@timestamp": "2019-06-28T16:00:20.790Z",
+ "type": "click",
+ "target": "button#test_button",
+ "details": {
+ "clicks": 13,
+ "shift": false,
+ "meta": false,
+ "alt": false,
+ "ctrl": false
+ },
+ "major_ver": "2",
+ "toolVersion": "2.0.0",
+ "pageReferrer": "",
+ "clientTime": 1561737620520,
+ "userAction": true,
+ "location": {
+ "x": 40,
+ "y": 19
+ },
+ "host": "172.18.0.1",
+ "path": [
+ "button#test_button",
+ "div.container",
+ "body",
+ "html",
+ "#document",
+ "Window"
+ ],
+ "sessionID": "session_1561737570573",
+ "toolName": "Apache UserALE.js Example",
+ "pageTitle": "UserAleJS - Example Page",
+ "logType": "raw",
+ "pageUrl": "file:///Users/jpoore/Documents/Apache_Flagon/test/incubator-flagon-useralejs/example/index.html",
+ "userId": "example-user",
+ "useraleVersion": "2.0.0",
+ "patch_ver": "0"
+ ]
+
+</code></pre>
+</div>
+
+<p>It’s a lot, but it makes sense in context.</p>
+
+<h3 id="useralejs-event-tracking">UserALE.js Event Tracking</h3>
+
+<p>The fields dentify what users do and what they interact with. UserALE.js gets this information from anywhere on a page/app without using a ton of hooks.</p>
+
+<div class="language-html highlighter-rouge"><pre class="highlight"><code> "type": "click", [this field documents the kind of user behavior observed]
+ "target": "button#test_button", [this field documents the site/app element a user interacted with]
+ "path": [ {this is the DOM path to the "target" element, which is critical for disambiguation between elements}
+ "button#test_button",
+ "div.container",
+ "body",
+ "html",
+ "#document",
+ "Window"]
+
+</code></pre>
+</div>
+
+<p>You may want to specially label some of these fields and important elements that. See our guide on <a href="/docs/useralejs/API">the UserALE.js API</a>.</p>
+
+<p>For more information about the kinds of behaviors (event classes) we collect, check out our guide for
+[modifying UserALE.js source code]((/docs/useralejs/modifying).</p>
+
+<h3 id="temporal-handling-in-useralejs">Temporal Handling in UserALE.js</h3>
+
+<p>Time is a very important concept in UserALE.js. Below are the fields related to temporal data capture:</p>
+
+<div class="language-html highlighter-rouge"><pre class="highlight"><code> "clientTime": 1561737620520, [UserALE.js collects time from the client when a log is generated]
+ "microTime": 0.185, [When a log is wrtten, we write microtime too, not every database parses it]
+ "@timestamp": "2019-06-28T16:00:20.790Z", [If you use our Elastic backend, you will see indexing time too]
+</code></pre>
+</div>
+
+<h3 id="useralejs-meta-data">UserALE.js Meta-Data</h3>
+
+<p>You want context? We have all of the things for all of your events:</p>
+
+<h4 id="event-context">Event Context</h4>
+
+<p>Every event has a little nuance, UserALE.js gets it all.</p>
+
+<p>UserALE.js will add to details the number of rapid, consecutive clicks on a single element.</p>
+
+<div class="language-html highlighter-rouge"><pre class="highlight"><code> "details": {
+ "clicks": 13,
+ "shift": false,
+ "meta": false,
+ "alt": false,
+ "ctrl": false
+ },
+</code></pre>
+</div>
+
+<p>You’ll get location of the cursor two for mouseover and click data, too!</p>
+
+<div class="language-html highlighter-rouge"><pre class="highlight"><code> "location": {
+ "x": 40,
+ "y": 19
+ },
+</code></pre>
+</div>
+
+<p><a href="https://github.com/apache/incubator-flagon-useralejs/tree/master/build">UserALE.js’ WebExtension</a> is deployed directly
+into your browser, as a result you’ll get browser events.</p>
+
+<p>Examples are below,you’ll see our details field has some pretty useful data from the browser.</p>
+
+<div class="language-html highlighter-rouge"><pre class="highlight"><code> "details": {
+ "audible": false, [audio media on the page?]
+ "title": "Discover - Kibana",
+ "selected": true,
+ "tabId": 64, [uniquely tracks each tab]
+ "windowId": 73, [uniquely tracks each window]
+ "muted": false,
+ "index": 0,
+ "incognito": false, [private browsing?]
+ "url": "http://localhost:5601/app/kibana#/discover?_g=(refreshInterval:(pause:!t)",
+ "active": true, []tab is active?[]
+ "pinned": false
+ },
+</code></pre>
+</div>
+
+<h4 id="pageapp-context">Page/App Context</h4>
+
+<p>If a user clicks on a thing and you know nothing about that thing, you’re toast!</p>
+
+<p>UserALE.js gives a lot context about your page or app. Some are automatically grabbed from the page, some are
+configurable through our <a href="/docs/useralejs">script tag</a></p>
+
+<div class="language-html highlighter-rouge"><pre class="highlight"><code> "toolVersion": "2.0.0", [you can give a semantic versioning of your page or tool]
+ "pageReferrer": "", [grabbed from the page, from which page did your users find your page/app]
+ "toolName": "Apache UserALE.js Example", [give your tool an alis through our script tag]
+ "pageTitle": "UserAleJS - Example Page", [page title grabbed from page]
+ "pageUrl": "file:///Users/jpoore/Documents/Apache_Flagon/test/incubator-flagon-useralejs/example/index.html"
+</code></pre>
+</div>
+
+<p>To find out more and how to change the context attached to event logs, check out our
+<a href="/docs/useralejs/modifying">modifying UserALE.js source code</a> guide.</p>
+
+<h4 id="user-context">User Context</h4>
+
+<p>UserALE.js has its own methods for gathering user context, and it can integrate with other methods you might have
+(e.g., cookies)</p>
+
+<div class="language-html highlighter-rouge"><pre class="highlight"><code> "sessionID": "session_1561737570573", [This session ID is unique to a specific page visit]
+ "userId": "example-user", [You can also pass a unique userId]
+ "host": "172.18.0.1", [IP address]
+</code></pre>
+</div>
+
+<p>To see how to pass in a userId from a url, check out our <a href="/docs/useralejs">script tag docs</a>.</p>
+
+<p>Other things you might want to do (e.g., cookies) can also be passed to userId via <a href="/docs/useralejs/API">the UserALE.js API</a>
+<code class="highlighter-rouge">mapping</code> function.</p>
+
+<h2 id="useralejs-log-types">UserALE.js Log Types</h2>
+
+<p>For the most part, UserALE.js logs are uniform. However, there are some variations based on the type of log.</p>
+
+<h3 id="webextension-logs">WebExtension Logs</h3>
+
+<p>WebExtension logs from page-level events will look identical to the logs from our script tag method.</p>
+
+<p>Our WebExtension logs from browser-level events, including focus, activation, and zoom events:</p>
+
+<div class="language-html highlighter-rouge"><pre class="highlight"><code>"host": "172.18.0.1",
+ "path": null,
+ "microTime": 0.835,
+ "@timestamp": "2019-06-28T18:05:03.681Z",
+ "sessionID": "session_1561741679119",
+ "type": "browser.tabs.onZoomChange",
+ "target": null,
+ "details": {
+ "audible": false,
+ "oldZoomFactor": 1,
+ "selected": true,
+ "tabId": 64,
+ "title": "Discover - Kibana",
+ "windowId": 73,
+ "newZoomFactor": 1,
+ "muted": false,
+ "index": 0,
+ "incognito": false,
+ "url": "http://localhost:5601/app/kibana#/discover?_g=(refreshInterval:(pause:!t),
+ "active": true,
+ "pinned": false
+ },
+ "toolName": null,
+ "toolVersion": null,
+ "clientTime": 1561745100028,
+ "userAction": true,
+ "logType": "raw",
+ "tags": [
+ "_grokparsefailure"
+ ],
+ "location": null,
+ "userId": "nobody",
+ "useraleVersion": null
+ },
+
+</code></pre>
+</div>
+
+<h3 id="interval-logs">Interval Logs</h3>
+
+<p>Interval logs are a experimental feature, that write long sequences of the same event to windows. They capture high resolution data like ‘mouseovers’ in time-boxed summary windows.</p>
+
+<p>Interval logs have a start- and end-time instead of a single, discrete time-stamp.</p>
+
+<div class="language-html highlighter-rouge"><pre class="highlight"><code> "endTime": 1561739434516, [end interval]
+ "minor_ver": "0",
+ "@timestamp": "2019-06-28T16:30:35.734Z",
+ "type": "mouseover",
+ "target": "html", [where were mouseovers observed within the interval]
+ "targetChange": true,
+ "major_ver": "2",
+ "count": 10, [count of disrcete events within the interval]
+ "pageReferrer": "",
+ "toolVersion": "2.0.0",
+ "userAction": false,
+ "duration": 396, [duration of interval in ms]
+ "host": "172.18.0.1",
+ "path": [
+ "html",
+ "#document",
+ "Window"
+ ],
+ "sessionID": "session_1561737570573",
+ "toolName": "Apache UserALE.js Example",
+ "startTime": 1561739434120, [begin interval]
+ "typeChange": true, [were there any other events during the interval?]
+ "pageTitle": "UserAleJS - Example Page",
+ "logType": "interval", [as compared to "raw"]
+ "pageUrl": "fApache_Flagon/test/incubator-flagon-useralejs/example/index.html",
+ "userId": "example-user",
+ "useraleVersion": "2.0.0",
+ "patch_ver": "0"
+</code></pre>
+</div>
+<h2 id="contributing">Contributing</h2>
+
+<p>Contributions are welcome! Simply <a href="https://issues.apache.org/jira/browse/FLAGON">submit an issue report</a> for problems
+you encounter or a pull request for your feature or bug fix. The core team will review it and work with you to
+incorporate it into UserALE.js.</p>
+
+ </div>
+</div>
+
+ </div>
+
+ <div class="footer ui inverted very padded vertical segment">
+ <div class="ui vertical segment">
+ <div class="ui four column grid">
+ <div class="column">
+ <h4 class="ui inverted header">About</h4>
+ <div class="ui inverted link list">
+ <a class="item" href="/stack">Stack</a>
+ <a class="item" href="/userale">UserALE</a>
+ <a class="item" href="/distill">Distill</a>
+ <a class="item" href="/tap">Tap</a>
+ <a class="item" href="/stout">Stout</a>
+ </div>
+ </div>
+ <div class="column">
+ <h4 class="ui inverted header">Docs</h4>
+ <div class="ui inverted link list">
+ <a class="item" href="/docs/stack">Stack</a>
+ <a class="item" href="/docs/userale">UserALE</a>
+ <a class="item" href="/docs/useralejs">UserAle.js</a>
+ <a class="item" href="/docs/useralepy">UserAle.py</a>
+ <a class="item" href="/docs/distill">Distill</a>
+ <a class="item" href="/docs/tap">Tap</a>
+ <a class="item" href="/docs/stout">Stout</a>
+ </div>
+ </div>
+ <div class="column">
+ <h4 class="ui inverted header">Community</h4>
+ <div class="ui inverted link list">
+ <a class="item" href="https://github.com/apache?q=flagon">GitHub</a>
+ <a class="item" href="http://stackoverflow.com/questions/tagged/apache-flagon">StackOverflow</a>
+ <a class="item" href="https://issues.apache.org/jira/browse/FLAGON">Jira Issue Tracker</a>
+ <a class="item" href="https://cwiki.apache.org/confluence/display/FLAGON">Project Wiki</a>
+ <a class="item" href="https://twitter.com/ApacheFlagon">Twitter</a>
+ </div>
+ </div>
+ <div class="column">
+ <h4 class="ui inverted header">Apache</h4>
+ <div class="ui inverted link list">
+ <a class="item" href="http://www.apache.org/">Apache Software Foundation</a>
+ <a class="item" href="http://www.apache.org/licenses/">License</a>
+ <a class="item" href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
+ <a class="item" href="http://www.apache.org/foundation/thanks.html">Thanks</a>
+ <a class="item" href="http://www.apache.org/security/">Security</a>
+ </div>
+ </div>
+ </div>
+ </div>
+ <div class="ui inverted vertical segment">
+ <div class="ui two column middle aligned grid">
+ <div class="column">
+ Apache Flagon is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the [...]
+ </div>
+ <div class="center aligned column">
+ Copyright © 2019 The Apache Software Foundation, Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.<br>
+ Apache Flagon, Flagon, Apache, the Apache feather logo, the Apache Flagon logo and the Apache Incubator logo are trademarks of The Apache Software Foundation.
+ </div>
+ </div>
+ </div>
+ <div class="ui inverted vertical segment">
+ <div class="ui one column middle aligned grid">
+ <div class="center aligned column">
+ <a href="http://incubator.apache.org/">
+ <img src="/images/incubator-logo-white.jpg">
+ </a>
+ <a href="https://www.apache.org/events/current-event.html">
+ <img src="https://www.apache.org/events/current-event-234x60.png" alt="ASF Current Event">
+ </a>
+ </div>
+ </div>
+ </div>
+</div>
+
+
+ </body>
+
+</html>
diff --git a/site/_site/docs/useralejs/index.html b/site/_site/docs/useralejs/index.html
index cb63071..ce65d38 100644
--- a/site/_site/docs/useralejs/index.html
+++ b/site/_site/docs/useralejs/index.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
@@ -251,7 +251,7 @@
<p><em>Note:</em> Work on UserALE.js’ documentation is ongoing. Contributions are welcome. To get involved, see our <a href="/docs/contributing">Contributing</a> guide.</p>
<h3 id="include-useralejs-in-your-project">Include UserALE.js in your project</h3>
-<p>To start logging with Apache UserALE.js, you can include our script directly in your project. More details can be found in our <a href="https://github.com/apache/incubator-flagon-useralejs/blob/master/README.md">README</a>. You can use our <a href="/docs/useralejs/build">build process</a> to create our script, or just use a sample in our <a href="https://github.com/apache/incubator-flagon-useralejs/tree/master/build">repos</a>.</p>
+<p>To start logging with Apache UserALE.js, you can include our script directly in your project. More details can be found in our <a href="https://github.com/apache/incubator-flagon-useralejs/blob/master/README.md">README</a>. You can use our <a href="/docs/useralejs/build">build process</a> to create our script, use a sample in our <a href="https://github.com/apache/incubator-flagon-useralejs/tree/master/build">repos</a>, or pull our scripts from <a href="https://www.npmjs.com/package/f [...]
<p>To include UserALE.js in a specific project, you’ll need to deploy a version of our minified UserALE.js script in an accessible location (e.g., webserver), and simply include this script tag on the page:</p>
@@ -338,7 +338,7 @@
<p>User our <a href="https://github.com/apache/incubator-flagon-useralejs/tree/master/example">example test utility</a> to experiment with script tag parameters.</p>
<h3 id="deploying-the-useralejs-webextension">Deploying the UserALE.js WebExtension</h3>
-<p>If you’re interested in using our Web Extension to log user activity across all pages they visit, try our web extension, which injects UserALE.js into any web page your client(s) navigate to. This option is perfect for testing and research. The web extension builds through the same <a href="/docs/useralejs/build">build pipeline</a> as UserALE.js. You can also use pre-built extension files in our <a href="https://github.com/apache/incubator-flagon-useralejs/tree/FLAGON-336/build">repo< [...]
+<p>If you’re interested in using our Web Extension to log user activity across all pages they visit, try our web extension, which injects UserALE.js into any web page your client(s) navigate to. This option is perfect for testing and research. The web extension builds through the same <a href="/docs/useralejs/build">build pipeline</a> as UserALE.js. You can also use pre-built extension files in our <a href="https://github.com/apache/incubator-flagon-useralejs/tree/master/build">repo</a>.</p>
<p>When you’re ready to deploy the UserALE.js web extension, follow the instructions below:</p>
diff --git a/site/_site/docs/useralejs/modifying/index.html b/site/_site/docs/useralejs/modifying/index.html
new file mode 100644
index 0000000..4f6b4fb
--- /dev/null
+++ b/site/_site/docs/useralejs/modifying/index.html
@@ -0,0 +1,463 @@
+<!DOCTYPE html>
+<html lang="en">
+
+ <head>
+ <meta charset="utf-8">
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+ <meta name="viewport" content="width=device-width, initial-scale=1">
+
+ <title>Modifying UserALE.js Source Code</title>
+ <meta name="description" content="Apache UserALE.js makes it easy for you to capture every user behavior on your webpage or application. But, you might not need all that data.">
+
+ <link rel="stylesheet" type="text/css" href="/semantic/dist/semantic.min.css">
+ <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.1/jquery.min.js"></script>
+ <script src="/semantic/dist/semantic.min.js"></script>
+ <script src="https://d3js.org/d3.v4.min.js"></script>
+ <script src="/js/main.js"></script>
+
+ <link rel="stylesheet" href="/assets/main.css">
+ <link rel="canonical" href="http://flagon.incubator.apache.org/docs/useralejs/modifying/">
+ <link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
+
+
+</head>
+
+
+ <body>
+
+ <div class="site-header">
+ <div id="main-menu" class="ui inverted padded fixed top borderless menu">
+ <a class="site-title" href="/">
+ <h3 class="ui inverted header item">Apache Flagon</h3>
+ </a>
+
+ <div class="right menu">
+ <div class="ui dropdown item">
+ Products
+ <div class="menu">
+ <a class="item" href="/stack">Stack</a>
+ <a class="item" href="/userale">UserALE</a>
+ <a class="item" href="/distill">Distill</a>
+ <a class="item" href="/tap">Tap</a>
+ <a class="item" href="/stout">Stout</a>
+ </div>
+ </div>
+ <div class="ui dropdown item">
+ <a href="/docs">Docs</a>
+ <div class="menu">
+ <a class="item" href="/docs/stack">Stack</a>
+ <a class="item" href="/docs/userale">UserALE</a>
+ <a class="item" href="/docs/useralejs">UserALE.js</a>
+ <a class="item" href="/docs/useralepy">UserALE.py</a>
+ <a class="item" href="/docs/distill">Distill</a>
+ <a class="item" href="/docs/tap">Tap</a>
+ <a class="item" href="/docs/stout">Stout</a>
+ </div>
+ </div>
+ <a class="item" href="/releases">Releases</a>
+ <a class="item" href="/community">Community</a>
+ </div>
+ </div>
+</div>
+
+
+ <div class="main-wrapper">
+ <div class="docs-wrapper">
+ <div class="docs-sidebar">
+
+
+
+
+
+
+
+
+
+<!-- <div class="ui inverted list">
+ <a class="item" href="/docs">About the Docs</a>
+</div> -->
+<div id="docs-nav" class="ui inverted accordion">
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ Apache Flagon
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/">About the Docs</a>
+
+ <a class="item" href="/docs/contributing/">Contributing</a>
+
+ </div>
+ </div>
+
+
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ Stack
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/stack/">Getting Started</a>
+
+ <a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
+
+ </div>
+ </div>
+
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ UserALE
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/userale/">About UserALE</a>
+
+ </div>
+ </div>
+
+
+ <div class="active title">
+
+ <i class="dropdown icon"></i>
+ UserALE.js
+ </div>
+
+ <div class="active content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/useralejs/">Getting Started</a>
+
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
+
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
+
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
+
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
+
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
+
+ </div>
+ </div>
+
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ UserALE.py
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/useralepy/">Installation</a>
+
+ <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
+
+ <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
+
+ <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
+
+ </div>
+ </div>
+
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ Distill
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/distill/">Installation</a>
+
+ <a class="item" href="/docs/distill/start.html">Getting Started</a>
+
+ <a class="item" href="/docs/distill/api.html">API Documentation</a>
+
+ <a class="item" href="/docs/distill/analytics.html">Apache Distill Analytics</a>
+
+ <a class="item" href="/docs/distill/http.html">Apache Distill HTTP Client</a>
+
+ <a class="item" href="/docs/distill/models.html">Apache Distill Models</a>
+
+ <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a>
+
+ <a class="item" href="/docs/distill/changelog.html">Changelog</a>
+
+ </div>
+ </div>
+
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ Tap
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/tap/">Getting Started</a>
+
+ </div>
+ </div>
+
+
+ <div class="title">
+
+ <i class="dropdown icon"></i>
+ Stout
+ </div>
+
+ <div class="content">
+
+ <div class="ui inverted bulleted list docs-list">
+
+ <a class="item" href="/docs/stout/">About Stout</a>
+
+ <a class="item" href="/docs/stout/start.html">Getting Started</a>
+
+ </div>
+ </div>
+</div>
+
+ </div>
+ <div class="docs-content">
+ <h2 class="ui header">Modifying UserALE.js Source Code</h2>
+ <p><a href="https://github.com/apache/incubator-flagon-useralejs">Apache UserALE.js</a> makes it easy for you to capture <em>every</em> user
+behavior on your webpage or application. But, you might not need all that data.</p>
+
+<p>UserALE.js also makes it easy for your to manage, and curate your logging scheme.</p>
+
+<p>This guide walks you through how to modify UserALE.js log data and behavior through source code modification.</p>
+
+<h2 id="modifying-useralejs-logs-via-source-code-modifications">Modifying UserALE.js Logs via Source Code Modifications</h2>
+
+<p>We’re starting with this method because it will give context to others methods, like our script tag and API (below).</p>
+
+<p>UserALE.js src is intuitively abstracted into few different files”</p>
+
+<ul>
+ <li><a href="https://github.com/apache/incubator-flagon-useralejs/blob/master/src/attachHandlers.js">attachHandlers</a>: configure which user behaviors UserALE.js listens for and event handlers here.</li>
+ <li><a href="https://github.com/apache/incubator-flagon-useralejs/blob/master/src/configure.js">configure</a>: set special custom parameters, like passing a unqiue userID into UserALE.js logs.</li>
+ <li><a href="https://github.com/apache/incubator-flagon-useralejs/blob/master/src/getInitialSettings.js">getInitialSettings</a>: modify HTML5 parameters passed through the script tag.</li>
+ <li><a href="https://github.com/apache/incubator-flagon-useralejs/blob/master/src/main.js">main</a>: attaches event handlers and adds logs to queue (probably want to leave alone).</li>
+ <li><a href="https://github.com/apache/incubator-flagon-useralejs/blob/master/src/packageLogs.js">packageLogs</a>: modify to configure how user behaviors are added to data schema, and meta data added from the page.</li>
+ <li><a href="https://github.com/apache/incubator-flagon-useralejs/blob/master/src/sendLogs.js">sendLogs</a>: modify how logs are sent to logging server, etc. (be careful here, too).</li>
+</ul>
+
+<h3 id="usage">Usage</h3>
+
+<p>Most modifications can be accomplished through <code class="highlighter-rouge">attachHandlers</code> and <code class="highlighter-rouge">packageLogs</code>.</p>
+
+<p>Once you modify source, you’ll need to rebuild UserALE.js scripts and webextension (and should probably run unit tests).</p>
+
+<h3 id="modifying-event-handlers-examples">Modifying Event Handlers: Examples</h3>
+
+<p><code class="highlighter-rouge">attachHandlers</code> controls which behaviors and what kinds of logs are captured</p>
+
+<p>You can modify some of the events UserALE.js by editing vars in <code class="highlighter-rouge">attacheHandlers</code>.</p>
+
+<div class="language-javascript highlighter-rouge"><pre class="highlight"><code><span class="kd">var</span> <span class="nx">events</span><span class="p">;</span>
+<span class="kd">var</span> <span class="nx">bufferBools</span><span class="p">;</span>
+<span class="kd">var</span> <span class="nx">bufferedEvents</span><span class="p">;</span>
+<span class="cm">/* modify which events are abstracted into interval logs by editing the array below*/</span>
+<span class="kd">var</span> <span class="nx">intervalEvents</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'click'</span><span class="p">,</span> <span class="s1">'focus'</span><span class="p">,</span> <span class="s1">'blur'</span><span class="p">,</span> <span class="s1">'input'</span><span class="p">,</span> <span class="s1">'change'</span><span class="p">,</span> <span class="s1">'mouseover'</span><span class="p">,</span> <span class="s1">'submit'</span><spa [...]
+<span class="cm">/* modify which events are pulled from window*/</span>
+<span class="kd">var</span> <span class="nx">windowEvents</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'load'</span><span class="p">,</span> <span class="s1">'blur'</span><span class="p">,</span> <span class="s1">'focus'</span><span class="p">];</span>
+</code></pre>
+</div>
+
+<p>You can modify which events UserALE.js captures in it’s ‘raw’ log stream, by modifying the var <code class="highlighter-rouge">events</code>:</p>
+
+<div class="language-javascript highlighter-rouge"><pre class="highlight"><code><span class="cm">/* Comment out event types in the `events` var for granular modification of UserALE.js behavior */</span>
+<span class="kr">export</span> <span class="kd">function</span> <span class="nx">defineDetails</span><span class="p">(</span><span class="nx">config</span><span class="p">)</span> <span class="p">{</span>
+ <span class="c1">// Events list</span>
+ <span class="c1">// Keys are event types</span>
+ <span class="c1">// Values are functions that return details object if applicable</span>
+ <span class="nx">events</span> <span class="o">=</span> <span class="p">{</span>
+ <span class="s1">'click'</span> <span class="p">:</span> <span class="nx">extractMouseEvent</span><span class="p">,</span>
+ <span class="s1">'dblclick'</span> <span class="p">:</span> <span class="nx">extractMouseEvent</span><span class="p">,</span>
+ <span class="s1">'mousedown'</span> <span class="p">:</span> <span class="nx">extractMouseEvent</span><span class="p">,</span>
+ <span class="s1">'mouseup'</span> <span class="p">:</span> <span class="nx">extractMouseEvent</span><span class="p">,</span>
+ <span class="s1">'focus'</span> <span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
+ <span class="s1">'blur'</span> <span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
+ <span class="s1">'input'</span> <span class="p">:</span> <span class="nx">config</span><span class="p">.</span><span class="nx">logDetails</span> <span class="p">?</span> <span class="kd">function</span><span class="p">(</span><span class="nx">e</span><span class="p">)</span> <span class="p">{</span> <span class="k">return</span> <span class="p">{</span> <span class="s1">'value'</span> <span class="p">:</span> <span class="nx">e</span><span class="p">.</span><span class="nx">target</ [...]
+ <span class="s1">'change'</span> <span class="p">:</span> <span class="nx">config</span><span class="p">.</span><span class="nx">logDetails</span> <span class="p">?</span> <span class="kd">function</span><span class="p">(</span><span class="nx">e</span><span class="p">)</span> <span class="p">{</span> <span class="k">return</span> <span class="p">{</span> <span class="s1">'value'</span> <span class="p">:</span> <span class="nx">e</span><span class="p">.</span><span class="nx">target< [...]
+ <span class="s1">'dragstart'</span> <span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
+ <span class="s1">'dragend'</span> <span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
+ <span class="s1">'drag'</span> <span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
+ <span class="s1">'drop'</span> <span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
+ <span class="s1">'keydown'</span> <span class="p">:</span> <span class="nx">config</span><span class="p">.</span><span class="nx">logDetails</span> <span class="p">?</span> <span class="kd">function</span><span class="p">(</span><span class="nx">e</span><span class="p">)</span> <span class="p">{</span> <span class="k">return</span> <span class="p">...,</span>
+ <span class="cm">/*'mouseover' : null,*/</span> <span class="err">#</span><span class="nx">Aliasing</span> <span class="nx">the</span> <span class="s2">"events"</span> <span class="nx">list</span> <span class="nx">removes</span> <span class="nx">that</span> <span class="kr">class</span> <span class="nx">from</span> <span class="nx">your</span> <span class="nx">event</span> <span class="nx">stream</span><span class="p">.</span>
+ <span class="s1">'submit'</span> <span class="p">:</span> <span class="kc">null</span>
+</code></pre>
+</div>
+
+<p>You can eliminate the <code class="highlighter-rouge">interval</code> log stream altogether by modifying the <code class="highlighter-rouge">attachHandlers</code> configs:</p>
+
+<div class="language-javascript highlighter-rouge"><pre class="highlight"><code><span class="kr">export</span> <span class="kd">function</span> <span class="nx">attachHandlers</span><span class="p">(</span><span class="nx">config</span><span class="p">)</span> <span class="p">{</span>
+ <span class="nx">defineDetails</span><span class="p">(</span><span class="nx">config</span><span class="p">);</span>
+
+ <span class="nb">Object</span><span class="p">.</span><span class="nx">keys</span><span class="p">(</span><span class="nx">events</span><span class="p">).</span><span class="nx">forEach</span><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">ev</span><span class="p">)</span> <span class="p">{</span>
+ <span class="nb">document</span><span class="p">.</span><span class="nx">addEventListener</span><span class="p">(</span><span class="nx">ev</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">e</span><span class="p">)</span> <span class="p">{</span>
+ <span class="nx">packageLog</span><span class="p">(</span><span class="nx">e</span><span class="p">,</span> <span class="nx">events</span><span class="p">[</span><span class="nx">ev</span><span class="p">]);</span>
+ <span class="p">},</span> <span class="kc">true</span><span class="p">);</span>
+ <span class="p">});</span>
+<span class="cm">/*Comment out configs for intervalEvents to remove them from your log stream */</span>
+ <span class="nx">intervalEvents</span><span class="p">.</span><span class="nx">forEach</span><span class="p">(</span><span class="kd">function</span><span class="p">(</span><span class="nx">ev</span><span class="p">)</span> <span class="p">{</span>
+ <span class="nb">document</span><span class="p">.</span><span class="nx">addEventListener</span><span class="p">(</span><span class="nx">ev</span><span class="p">,</span> <span class="kd">function</span><span class="p">(</span><span class="nx">e</span><span class="p">)</span> <span class="p">{</span>
+ <span class="nx">packageIntervalLog</span><span class="p">(</span><span class="nx">e</span><span class="p">);</span>
+ <span class="p">},</span> <span class="kc">true</span><span class="p">);</span>
+ <span class="p">});</span>
+</code></pre>
+</div>
+
+<h3 id="modifying-meta-data-packaged-in-logs-examples">Modifying Meta Data Packaged in Logs: Examples</h3>
+
+<p><code class="highlighter-rouge">packageLogs</code> pulls parameters from the script tag, API, and from window or document and adds them to event logs.</p>
+
+<p>The easiest way to make these changes is by modifying the var <code class="highlighter-rouge">log</code>:</p>
+
+<div class="language-javascript highlighter-rouge"><pre class="highlight"><code> <span class="cm">/* Comment or add fields to be included in your logs*/</span>
+ <span class="kd">var</span> <span class="nx">log</span> <span class="o">=</span> <span class="p">{</span>
+ <span class="s1">'target'</span> <span class="p">:</span> <span class="nx">getSelector</span><span class="p">(</span><span class="nx">e</span><span class="p">.</span><span class="nx">target</span><span class="p">),</span>
+ <span class="s1">'path'</span> <span class="p">:</span> <span class="nx">buildPath</span><span class="p">(</span><span class="nx">e</span><span class="p">),</span>
+ <span class="s1">'pageUrl'</span><span class="p">:</span> <span class="nb">window</span><span class="p">.</span><span class="nx">location</span><span class="p">.</span><span class="nx">href</span><span class="p">,</span>
+ <span class="s1">'pageTitle'</span><span class="p">:</span> <span class="nb">document</span><span class="p">.</span><span class="nx">title</span><span class="p">,</span>
+ <span class="s1">'pageReferrer'</span><span class="p">:</span> <span class="nb">document</span><span class="p">.</span><span class="nx">referrer</span><span class="p">,</span>
+ <span class="s1">'clientTime'</span> <span class="p">:</span> <span class="nx">timeFields</span><span class="p">.</span><span class="nx">milli</span><span class="p">,</span>
+ <span class="s1">'microTime'</span> <span class="p">:</span> <span class="nx">timeFields</span><span class="p">.</span><span class="nx">micro</span><span class="p">,</span>
+ <span class="s1">'location'</span> <span class="p">:</span> <span class="nx">getLocation</span><span class="p">(</span><span class="nx">e</span><span class="p">),</span>
+ <span class="s1">'type'</span> <span class="p">:</span> <span class="nx">e</span><span class="p">.</span><span class="nx">type</span><span class="p">,</span>
+ <span class="s1">'logType'</span><span class="p">:</span> <span class="s1">'raw'</span><span class="p">,</span>
+ <span class="s1">'userAction'</span> <span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
+ <span class="s1">'details'</span> <span class="p">:</span> <span class="nx">details</span><span class="p">,</span>
+ <span class="s1">'userId'</span> <span class="p">:</span> <span class="nx">config</span><span class="p">.</span><span class="nx">userId</span><span class="p">,</span>
+ <span class="s1">'toolVersion'</span> <span class="p">:</span> <span class="nx">config</span><span class="p">.</span><span class="nx">version</span><span class="p">,</span>
+ <span class="s1">'toolName'</span> <span class="p">:</span> <span class="nx">config</span><span class="p">.</span><span class="nx">toolName</span><span class="p">,</span>
+ <span class="s1">'useraleVersion'</span><span class="p">:</span> <span class="nx">config</span><span class="p">.</span><span class="nx">useraleVersion</span><span class="p">,</span>
+ <span class="s1">'sessionID'</span><span class="p">:</span> <span class="nx">config</span><span class="p">.</span><span class="nx">sessionID</span>
+ <span class="p">};</span>
+</code></pre>
+</div>
+
+<h3 id="benefits-modifying-useralejs-logs-via-src">Benefits Modifying UserALE.js Logs via src:</h3>
+<ul>
+ <li>Full control of your log streams</li>
+ <li>With simple modification to src you can package and build multiple UserALE.js scripts for page-to-page modification
+ of log streams.</li>
+ <li>Modify the behavior of our webExtension</li>
+ <li>Ideal in cases where you don’t want to integrate UserALE.js into your CD pipeline, just pass around pre-built scripts
+ that suite your needs.</li>
+</ul>
+
+<h2 id="contributing">Contributing</h2>
+
+<p>Contributions are welcome! Simply <a href="https://issues.apache.org/jira/browse/FLAGON">submit an issue report</a> for problems
+you encounter or a pull request for your feature or bug fix. The core team will review it and work with you to
+incorporate it into UserALE.js.</p>
+
+ </div>
+</div>
+
+ </div>
+
+ <div class="footer ui inverted very padded vertical segment">
+ <div class="ui vertical segment">
+ <div class="ui four column grid">
+ <div class="column">
+ <h4 class="ui inverted header">About</h4>
+ <div class="ui inverted link list">
+ <a class="item" href="/stack">Stack</a>
+ <a class="item" href="/userale">UserALE</a>
+ <a class="item" href="/distill">Distill</a>
+ <a class="item" href="/tap">Tap</a>
+ <a class="item" href="/stout">Stout</a>
+ </div>
+ </div>
+ <div class="column">
+ <h4 class="ui inverted header">Docs</h4>
+ <div class="ui inverted link list">
+ <a class="item" href="/docs/stack">Stack</a>
+ <a class="item" href="/docs/userale">UserALE</a>
+ <a class="item" href="/docs/useralejs">UserAle.js</a>
+ <a class="item" href="/docs/useralepy">UserAle.py</a>
+ <a class="item" href="/docs/distill">Distill</a>
+ <a class="item" href="/docs/tap">Tap</a>
+ <a class="item" href="/docs/stout">Stout</a>
+ </div>
+ </div>
+ <div class="column">
+ <h4 class="ui inverted header">Community</h4>
+ <div class="ui inverted link list">
+ <a class="item" href="https://github.com/apache?q=flagon">GitHub</a>
+ <a class="item" href="http://stackoverflow.com/questions/tagged/apache-flagon">StackOverflow</a>
+ <a class="item" href="https://issues.apache.org/jira/browse/FLAGON">Jira Issue Tracker</a>
+ <a class="item" href="https://cwiki.apache.org/confluence/display/FLAGON">Project Wiki</a>
+ <a class="item" href="https://twitter.com/ApacheFlagon">Twitter</a>
+ </div>
+ </div>
+ <div class="column">
+ <h4 class="ui inverted header">Apache</h4>
+ <div class="ui inverted link list">
+ <a class="item" href="http://www.apache.org/">Apache Software Foundation</a>
+ <a class="item" href="http://www.apache.org/licenses/">License</a>
+ <a class="item" href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
+ <a class="item" href="http://www.apache.org/foundation/thanks.html">Thanks</a>
+ <a class="item" href="http://www.apache.org/security/">Security</a>
+ </div>
+ </div>
+ </div>
+ </div>
+ <div class="ui inverted vertical segment">
+ <div class="ui two column middle aligned grid">
+ <div class="column">
+ Apache Flagon is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the [...]
+ </div>
+ <div class="center aligned column">
+ Copyright © 2019 The Apache Software Foundation, Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.<br>
+ Apache Flagon, Flagon, Apache, the Apache feather logo, the Apache Flagon logo and the Apache Incubator logo are trademarks of The Apache Software Foundation.
+ </div>
+ </div>
+ </div>
+ <div class="ui inverted vertical segment">
+ <div class="ui one column middle aligned grid">
+ <div class="center aligned column">
+ <a href="http://incubator.apache.org/">
+ <img src="/images/incubator-logo-white.jpg">
+ </a>
+ <a href="https://www.apache.org/events/current-event.html">
+ <img src="https://www.apache.org/events/current-event-234x60.png" alt="ASF Current Event">
+ </a>
+ </div>
+ </div>
+ </div>
+</div>
+
+
+ </body>
+
+</html>
diff --git a/site/_site/docs/distill/start.html b/site/_site/docs/useralejs/troubleshooting/index.html
similarity index 88%
copy from site/_site/docs/distill/start.html
copy to site/_site/docs/useralejs/troubleshooting/index.html
index d4562fe..2a9f239 100644
--- a/site/_site/docs/distill/start.html
+++ b/site/_site/docs/useralejs/troubleshooting/index.html
@@ -6,8 +6,8 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
- <title>Getting Started</title>
- <meta name="description" content="Usage">
+ <title>Troubleshooting</title>
+ <meta name="description" content="Enable Cross-Origin Resource Sharing (CORS)">
<link rel="stylesheet" type="text/css" href="/semantic/dist/semantic.min.css">
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.1/jquery.min.js"></script>
@@ -16,7 +16,7 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://flagon.incubator.apache.org/docs/distill/start.html">
+ <link rel="canonical" href="http://flagon.incubator.apache.org/docs/useralejs/troubleshooting/">
<link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -131,27 +131,27 @@
</div>
- <div class="title">
+ <div class="active title">
<i class="dropdown icon"></i>
UserALE.js
</div>
- <div class="content">
+ <div class="active content">
<div class="ui inverted bulleted list docs-list">
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
@@ -179,13 +179,13 @@
</div>
- <div class="active title">
+ <div class="title">
<i class="dropdown icon"></i>
Distill
</div>
- <div class="active content">
+ <div class="content">
<div class="ui inverted bulleted list docs-list">
@@ -245,18 +245,12 @@
</div>
<div class="docs-content">
- <h2 class="ui header">Getting Started</h2>
- <h3 id="usage">Usage</h3>
+ <h2 class="ui header">Troubleshooting</h2>
+ <h3 id="enable-cross-origin-resource-sharing-cors">Enable Cross-Origin Resource Sharing (CORS)</h3>
-<p>Using curl:</p>
+<p>The logs generated by <a href="https://github.com/apache/incubator-flagon-useralejs">Apache UserALE.js</a> are sent to a logging server which is configured in the script tag. Your client may send out failure logs because of a CORS (cross-origin resource sharing) issue. You will need to configure your backend server to enable CORS.</p>
-<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>curl -XGET <span class="s1">'http://localhost:8090/app/register'</span> -d <span class="s1">'{
- "application_name" : "my_app",
- "version" : "0.1",
- "application_description" : "my test app"
- }'</span>
-</code></pre>
-</div>
+<p>For more information and examples on how to enable CORS on your server, please visit <a href="http://enable-cors.org/index.html">enable-cors.org</a>.</p>
</div>
</div>
diff --git a/site/_site/docs/useralepy/api.html b/site/_site/docs/useralepy/api.html
index cde7315..2dafb58 100644
--- a/site/_site/docs/useralepy/api.html
+++ b/site/_site/docs/useralepy/api.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/site/_site/docs/useralepy/changelog.html b/site/_site/docs/useralepy/changelog.html
index 47b7e6c..c5d4936 100644
--- a/site/_site/docs/useralepy/changelog.html
+++ b/site/_site/docs/useralepy/changelog.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/site/_site/docs/useralepy/index.html b/site/_site/docs/useralepy/index.html
index d6dcfcd..7592740 100644
--- a/site/_site/docs/useralepy/index.html
+++ b/site/_site/docs/useralepy/index.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/site/_site/docs/useralepy/start.html b/site/_site/docs/useralepy/start.html
index 4e1feaa..83ec54a 100644
--- a/site/_site/docs/useralepy/start.html
+++ b/site/_site/docs/useralepy/start.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -143,15 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+ <a class="item" href="/docs/useralejs/build/">UserALE.js Build and Test</a>
- <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+ <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
- <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+ <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
- <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+ <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
</div>
</div>
diff --git a/site/_site/feed.xml b/site/_site/feed.xml
index d0e8baf..7a85395 100644
--- a/site/_site/feed.xml
+++ b/site/_site/feed.xml
@@ -1 +1 @@
-<?xml version="1.0" encoding="utf-8"?><?xml-stylesheet type="text/xml" href="http://flagon.incubator.apache.org/feed.xslt.xml"?><feed xmlns="http://www.w3.org/2005/Atom"><generator uri="http://jekyllrb.com" version="3.3.1">Jekyll</generator><link href="http://flagon.incubator.apache.org/feed.xml" rel="self" type="application/atom+xml" /><link href="http://flagon.incubator.apache.org/" rel="alternate" type="text/html" /><updated>2019-06-27T03:26:21+00:00</updated><id>http://flagon.incubat [...]
+<?xml version="1.0" encoding="utf-8"?><?xml-stylesheet type="text/xml" href="http://flagon.incubator.apache.org/feed.xslt.xml"?><feed xmlns="http://www.w3.org/2005/Atom"><generator uri="http://jekyllrb.com" version="3.3.1">Jekyll</generator><link href="http://flagon.incubator.apache.org/feed.xml" rel="self" type="application/atom+xml" /><link href="http://flagon.incubator.apache.org/" rel="alternate" type="text/html" /><updated>2019-06-29T01:37:39+00:00</updated><id>http://flagon.incubat [...]
diff --git a/site/_site/index.html b/site/_site/index.html
index 90343d7..e08ba44 100644
--- a/site/_site/index.html
+++ b/site/_site/index.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
diff --git a/site/_site/releases/index.html b/site/_site/releases/index.html
index 7c28df5..9a76457 100644
--- a/site/_site/releases/index.html
+++ b/site/_site/releases/index.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
@@ -74,7 +74,7 @@
</p>
<p>
- Please Note all Apache Flagon artifacts are released as source code and binary artifacts and additional packages can be found on packaging platforms such as UserALE.js which we make available through <a href="https://www.npmjs.com/package/useralejs">the NPM useralejs package</a>.
+ Please Note all Apache Flagon artifacts are released as source code and binary artifacts and additional packages can be found on packaging platforms such as UserALE.js which we make available through <a href="https://www.npmjs.com/package/flagon-userale">the NPM useralejs package</a>.
The CHANGELOG file shipped with each artifact can be consulted for more information on the list of updates in each release.
@@ -83,7 +83,7 @@
<h1>Flagon UserALE.js</h1>
-Please note, that for convenience, we make UserALE.js available through <a href="https://www.npmjs.com/package/useralejs">the NPM useralejs package</a>.
+Please note, that for convenience, we make UserALE.js available through <a href="https://www.npmjs.com/package/flagon-userale">the NPM useralejs package</a>.
<h2>Downloads</h2>
The link in the 'Download Artifact' column below should display a default mirror selection based on your inferred location. If (when you browse to it) you do not see that page, try a different browser. The SHA512 checksum and ASCII armoured detached signatures are links to the originals on the main distribution server.
@@ -100,27 +100,27 @@ The link in the 'Download Artifact' column below should display a default mirror
<tbody>
<tr>
<td>Apache Flagon UserALE.js 1.0.0 (binary tar.gz)</td>
- <td><a href="http://www.apache.org/dyn/closer.cgi/incubator/senssoft/apache-senssoft-useralejs-1.0.0/apache-senssoft-useralejs-1.0.0-bin.tar.gz">apache-senssoft-useralejs-1.0.0-bin.tar.gz</a></td>
- <td><a href="https://dist.apache.org/repos/dist/release/incubator/senssoft/apache-senssoft-useralejs-1.0.0/apache-senssoft-useralejs-1.0.0-bin.tar.gz.asc">apache-senssoft-useralejs-1.0.0-bin.tar.gz.asc</a> </td>
- <td><a href="https://dist.apache.org/repos/dist/release/incubator/senssoft/apache-senssoft-useralejs-1.0.0/apache-senssoft-useralejs-1.0.0-bin.tar.gz.sha512">apache-senssoft-useralejs-1.0.0-bin.tar.gz.sha512</a> </td>
+ <td><a href="http://www.apache.org/dyn/closer.cgi/incubator/flagon/apache-flagon-useralejs-incubating-1.0.0/apache-flagon-useralejs-incubating-1.0.0-bin.tar.gz">apache-flagon-useralejs-incubating-1.0.0-bin.tar.gz</a></td>
+ <td><a href="https://dist.apache.org/repos/dist/release/incubator/flagon/apache-flagon-useralejs-incubating-1.0.0/apache-flagon-useralejs-incubating-1.0.0-bin.tar.gz.asc">apache-flagon-useralejs-incubating-1.0.0-bin.tar.gz.asc</a> </td>
+ <td><a href="https://dist.apache.org/repos/dist/release/incubator/flagon/apache-flagon-useralejs-incubating-1.0.0/apache-flagon-useralejs-incubating-1.0.0-bin.tar.gz.sha512">apache-flagon-useralejs-incubating-1.0.0-bin.tar.gz.sha512</a> </td>
</tr>
<tr>
<td>Apache Flagon UserALE.js 1.0.0(binary zip)</td>
- <td><a href="http://www.apache.org/dyn/closer.cgi/incubator/senssoft/apache-senssoft-useralejs-1.0.0/apache-senssoft-useralejs-1.0.0-bin.zip">apache-senssoft-useralejs-1.0.0-bin.zip</a></td>
- <td><a href="https://dist.apache.org/repos/dist/release/incubator/senssoft/apache-senssoft-useralejs-1.0.0/apache-senssoft-useralejs-1.0.0-bin.zip.asc">apache-senssoft-useralejs-1.0.0-bin.zip.asc</a></td>
- <td><a href="https://dist.apache.org/repos/dist/release/incubator/senssoft/apache-senssoft-useralejs-1.0.0/apache-senssoft-useralejs-1.0.0-bin.zip.sha512">apache-senssoft-useralejs-1.0.0-bin.zip.sha512</a></td>
+ <td><a href="http://www.apache.org/dyn/closer.cgi/incubator/flagon/apache-flagon-useralejs-incubating-1.0.0/apache-flagon-useralejs-incubating-1.0.0-bin.zip">apache-flagon-useralejs-incubating-1.0.0-bin.zip</a></td>
+ <td><a href="https://dist.apache.org/repos/dist/release/incubator/flagon/apache-flagon-useralejs-incubating-1.0.0/apache-flagon-useralejs-incubating-1.0.0-bin.zip.asc">apache-flagon-useralejs-incubating-1.0.0-bin.zip.asc</a></td>
+ <td><a href="https://dist.apache.org/repos/dist/release/incubator/flagon/apache-flagon-useralejs-incubating-1.0.0/apache-flagon-useralejs-incubating-1.0.0-bin.zip.sha512">apache-flagon-useralejs-incubating-1.0.0-bin.zip.sha512</a></td>
</tr>
<tr>
<td>Apache Flagon UserALE.js 1.0.0 (source tar.gz)</td>
- <td><a href="http://www.apache.org/dyn/closer.cgi/incubator/senssoft/apache-senssoft-useralejs-1.0.0/apache-senssoft-useralejs-1.0.0-src.tar.gz">apache-senssoft-useralejs-1.0.0-src.tar.gz</a></td>
- <td><a href="https://dist.apache.org/repos/dist/release/incubator/senssoft/apache-senssoft-useralejs-1.0.0/apache-senssoft-useralejs-1.0.0-src.tar.gz.asc">apache-senssoft-useralejs-1.0.0-src.tar.gz.asc</a> </td>
- <td><a href="https://dist.apache.org/repos/dist/release/incubator/senssoft/apache-senssoft-useralejs-1.0.0/apache-senssoft-useralejs-1.0.0-src.tar.gz.sha512">apache-senssoft-useralejs-1.0.0-src.tar.gz.sha512</a> </td>
+ <td><a href="http://www.apache.org/dyn/closer.cgi/incubator/flagon/apache-flagon-useralejs-incubating-1.0.0/apache-flagon-useralejs-incubating-1.0.0-src.tar.gz">apache-flagon-useralejs-incubating-1.0.0-src.tar.gz</a></td>
+ <td><a href="https://dist.apache.org/repos/dist/release/incubator/flagon/apache-flagon-useralejs-incubating-1.0.0/apache-flagon-useralejs-incubating-1.0.0-src.tar.gz.asc">apache-flagon-useralejs-incubating-1.0.0-src.tar.gz.asc</a> </td>
+ <td><a href="https://dist.apache.org/repos/dist/release/incubator/flagon/apache-flagon-useralejs-incubating-1.0.0/apache-flagon-useralejs-incubating-1.0.0-src.tar.gz.sha512">apache-flagon-useralejs-incubating-1.0.0-src.tar.gz.sha512</a> </td>
</tr>
<tr>
<td>Apache Flagon UserALE.js 1.0.0(source zip)</td>
- <td><a href="http://www.apache.org/dyn/closer.cgi/incubator/senssoft/apache-senssoft-useralejs-1.0.0/apache-senssoft-useralejs-1.0.0-src.zip">apache-senssoft-useralejs-1.0.0-src.zip</a></td>
- <td><a href="https://dist.apache.org/repos/dist/release/incubator/senssoft/apache-senssoft-useralejs-1.0.0/apache-senssoft-useralejs-1.0.0-src.zip.asc">apache-senssoft-useralejs-1.0.0-src.zip.asc</a></td>
- <td><a href="https://dist.apache.org/repos/dist/release/incubator/senssoft/apache-senssoft-useralejs-1.0.0/apache-senssoft-useralejs-1.0.0-src.zip.sha512">apache-senssoft-useralejs-1.0.0-src.zip.sha512</a></td>
+ <td><a href="http://www.apache.org/dyn/closer.cgi/incubator/flagon/apache-flagon-useralejs-incubating-1.0.0/apache-flagon-useralejs-incubating-1.0.0-src.zip">apache-flagon-useralejs-incubating-1.0.0-src.zip</a></td>
+ <td><a href="https://dist.apache.org/repos/dist/release/incubator/flagon/apache-flagon-useralejs-incubating-1.0.0/apache-flagon-useralejs-incubating-1.0.0-src.zip.asc">apache-flagon-useralejs-incubating-1.0.0-src.zip.asc</a></td>
+ <td><a href="https://dist.apache.org/repos/dist/release/incubator/flagon/apache-flagon-useralejs-incubating-1.0.0/apache-flagon-useralejs-incubating-1.0.0-src.zip.sha512">apache-flagon-useralejs-incubating-1.0.0-src.zip.sha512</a></td>
</tr>
</tbody>
</table>
@@ -147,7 +147,7 @@ The link in the 'Download Artifact' column below should display a default mirror
</p>
<p>
<code>
- $ gpg --verify apache-flagon-useralejs-1.0.0-src.zip.asc
+ $ gpg --verify apache-flagon-{product}-{version}-src.zip.asc
</code>
</p>
@@ -160,10 +160,10 @@ The link in the 'Download Artifact' column below should display a default mirror
Alternatively, you can verify the SHA512 signatures on the files. A unix program called md5 or md5sum is included in many unix distributions. Use the following example
</p>
<p>
- <code>$ sha512sum apache-flagon-useralejs-1.0.0-src.zip</code>
+ <code>$ sha512sum apache-flagon-{product}-{version}-src.zip</code>
</p>
<p>
- ... output should match the string in apache-flagon-useralejs-1.0.0-src.zip.sha512
+ ... output should match the string in apache-flagon-{product}-{version}-src.zip.sha512
</p>
</div>
</div>
diff --git a/site/_site/stack/index.html b/site/_site/stack/index.html
index 1e38857..e9e574b 100644
--- a/site/_site/stack/index.html
+++ b/site/_site/stack/index.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
diff --git a/site/_site/stout/index.html b/site/_site/stout/index.html
index 91ff65e..a50ad1e 100644
--- a/site/_site/stout/index.html
+++ b/site/_site/stout/index.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
diff --git a/site/_site/tap/index.html b/site/_site/tap/index.html
index 1af098d..30175e4 100644
--- a/site/_site/tap/index.html
+++ b/site/_site/tap/index.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
diff --git a/site/_site/userale/index.html b/site/_site/userale/index.html
index 81656ec..dba47a5 100644
--- a/site/_site/userale/index.html
+++ b/site/_site/userale/index.html
@@ -33,7 +33,7 @@
<div class="right menu">
<div class="ui dropdown item">
- Components
+ Products
<div class="menu">
<a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>