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/28 01:41:29 UTC
[incubator-flagon] branch FLAGON-344 updated: [FLAGON-344] updates
to website to reflect Flagon namechange
This is an automated email from the ASF dual-hosted git repository.
poorejc pushed a commit to branch FLAGON-344
in repository https://gitbox.apache.org/repos/asf/incubator-flagon.git
The following commit(s) were added to refs/heads/FLAGON-344 by this push:
new 327d7d3 [FLAGON-344] updates to website to reflect Flagon namechange
327d7d3 is described below
commit 327d7d31786d6e3bf99295cb2830a1330489048c
Author: poorejc <po...@apache.org>
AuthorDate: Thu Jun 27 21:41:16 2019 -0400
[FLAGON-344] updates to website to reflect Flagon namechange
---
content/_config.yml | 8 +-
content/community/index.html | 82 +--
content/distill/index.html | 57 +-
.../start.html => contributing/index.html} | 131 +++--
content/docs/distill/analytics.html | 89 +--
content/docs/distill/api.html | 97 ++--
content/docs/distill/changelog.html | 89 +--
content/docs/distill/http.html | 97 ++--
content/docs/distill/index.html | 100 ++--
content/docs/distill/models.html | 89 +--
content/docs/distill/start.html | 89 +--
content/docs/distill/utilities.html | 89 +--
content/docs/index.html | 93 ++--
content/docs/stack/index.html | 393 +++++++++++++
content/docs/stack/scaling/index.html | 618 +++++++++++++++++++++
content/docs/stout/index.html | 89 +--
content/docs/stout/start.html | 89 +--
content/docs/system/index.html | 50 +-
content/docs/tap/index.html | 95 ++--
content/docs/userale/index.html | 101 ++--
content/docs/useralejs/API.html | 468 ++++++++++++++++
content/docs/useralejs/build.html | 441 +++++++++++++++
.../changelog.html => useralejs/dataschema.html} | 135 ++---
content/docs/useralejs/index.html | 218 +++++---
content/docs/useralejs/modifying.html | 457 +++++++++++++++
.../{distill/start.html => useralejs/testing.html} | 87 +--
content/docs/useralejs/troubleshooting.html | 91 +--
content/docs/useralepy/api.html | 611 ++++++++++++++++++++
content/docs/{distill => useralepy}/changelog.html | 169 ++++--
content/docs/{distill => useralepy}/index.html | 239 ++++----
content/docs/useralepy/start.html | 383 +++++++++++++
content/feed.xml | 2 +-
content/images/incubator-logo-white.jpg | Bin 0 -> 11267 bytes
content/images/metricBeat.png | Bin 0 -> 124599 bytes
content/images/mouseOverBench1.png | Bin 0 -> 93193 bytes
content/images/mouseOverBench2.png | Bin 0 -> 87554 bytes
content/images/stack.png | Bin 0 -> 203346 bytes
content/index.html | 83 +--
content/releases/index.html | 158 ++++--
{site/_site/system => content/stack}/index.html | 47 +-
content/stout/index.html | 59 +-
content/system/index.html | 221 --------
content/tap/index.html | 61 +-
content/userale/index.html | 61 +-
44 files changed, 5135 insertions(+), 1401 deletions(-)
diff --git a/content/_config.yml b/content/_config.yml
index 3176e73..c52bf4a 100644
--- a/content/_config.yml
+++ b/content/_config.yml
@@ -13,11 +13,11 @@
# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
# You can create any custom variable you would like, and they will be accessible
# in the templates via {{ site.myvariable }}.
-title: Apache SensSoft
-description: The homepage for Apache SensSoft
+title: Apache Flagon
+description: The homepage for Apache Flagon
baseurl: "" # the subpath of your site, e.g. /blog
-url: "http://senssoft.incubator.apache.org" # the base hostname & protocol for your site, e.g. http://example.com
-twitter_username: apachesenssoft
+url: "http://flagon.incubator.apache.org" # the base hostname & protocol for your site, e.g. http://example.com
+twitter_username: ApacheFlagon
github_username: apache
collections:
diff --git a/content/community/index.html b/content/community/index.html
index 1c1916a..bdd134c 100644
--- a/content/community/index.html
+++ b/content/community/index.html
@@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Community</title>
- <meta name="description" content="The homepage for Apache SensSoft">
+ <meta name="description" content="The homepage for Apache Flagon">
<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,8 +16,8 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://localhost:4000/community/">
- <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml">
+ <link rel="canonical" href="http://flagon.incubator.apache.org/community/">
+ <link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
</head>
@@ -28,14 +28,14 @@
<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 SensSoft</h3>
+ <h3 class="ui inverted header item">Apache Flagon</h3>
</a>
<div class="right menu">
<div class="ui dropdown item">
Components
<div class="menu">
- <a class="item" href="/system">System</a>
+ <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>
@@ -45,10 +45,10 @@
<div class="ui dropdown item">
<a href="/docs">Docs</a>
<div class="menu">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserALE.pyqt</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>
@@ -69,7 +69,7 @@
<div class="page-content">
<div class="ui vertical segment">
<p>
- The Apache SensSoft team happily welcomes contributors and supporters of our work. Contributions, bug reports, and suggestions are welcome for the core products, website, documentation, and everything else! See our <a href="/docs/system/contributing">docs</a> for more information on submitting effective contributions and bug reports.
+ The Apache Flagon team happily welcomes contributors and supporters of our work. Contributions, bug reports, and suggestions are welcome for the core products, website, documentation, and everything else! See our <a href="/docs/contributing">docs</a> for more information on submitting effective contributions and bug reports.
</p>
</div>
@@ -80,21 +80,25 @@
<div class="content">Users</div>
</h3>
<p>
- For users of Apache SensSoft who want to keep up to date with new releases and community highlights. To subscribe, email <a href="mailto:user-subscribe@senssoft.incubator.apache.org">user-subscribe@senssoft.incubator.apache.org</a>.
+ For users of Apache Flagon who want to keep up to date with new releases and community highlights. To subscribe, email <a href="mailto:user-subscribe@flagon.incubator.apache.org">user-subscribe@flagon.incubator.apache.org</a>.
+ <a class="ui yellow button" href="mailto:users-subscribe@flagon.incubator.apache.org">User List</a>
</p>
+
<h3 class="ui header">
<i class="code icon"></i>
<div class="content">Dev</div>
</h3>
<p>
- For contributors to Apache SensSoft or those interested in ongoing design and development efforts. To subscribe, email <a href="mailto:dev-subscribe@senssoft.incubator.apache.org">dev-subscribe@senssoft.incubator.apache.org</a>.
+ For contributors to Apache Flagon or those interested in ongoing design and development efforts. To subscribe, email <a href="mailto:dev-subscribe@flagon.incubator.apache.org">dev-subscribe@flagon.incubator.apache.org</a>.
+ <a class="ui blue button" href="mailto:dev-subscribe@flagon.incubator.apache.org">Dev List</a>
</p>
<h3 class="ui header">
<i class="upload icon"></i>
<div class="content">Commits</div>
</h3>
<p>
- For emails-on-commit across all Apache SensSoft products. To subscribe, email <a href="mailto:commits-subscribe@senssoft.incubator.apache.org">commits-subscribe@senssoft.incubator.apache.org</a>.
+ For emails-on-commit across all Apache Flagon products. To subscribe, email <a href="mailto:commits-subscribe@flagon.incubator.apache.org">commits-subscribe@flagon.incubator.apache.org</a>.
+ <a class="ui blue button" href="mailto:commits-subscribe@flagon.incubator.apache.org">Commits List</a>
</p>
</div>
@@ -105,42 +109,42 @@
<div class="content">GitHub</div>
</h3>
<p>
- <a href="https://github.com/apache?q=senssoft">Find our code on Github</a> to browse and contribute.
+ <a href="https://github.com/apache?q=flagon">Find our code on Github</a> to browse and contribute.
</p>
<h3 class="ui header">
<i class="twitter icon"></i>
<div class="content">Twitter</div>
</h3>
<p>
- <a href="https://twitter.com/apachesenssoft">Follow us on Twitter</a> to keep up to date on Apache SensSoft and related developments.
+ <a href="https://twitter.com/ApacheFlagon">Follow us on Twitter</a> to keep up to date on Apache Flagon and related developments.
</p>
<h3 class="ui header">
<i class="stack overflow icon"></i>
<div class="content">StackOverflow</div>
</h3>
<p>
- Get your questions answered on <a href="http://stackoverflow.com/questions/tagged/apache-senssoft">StackOverflow</a>.
+ Get your questions answered on <a href="http://stackoverflow.com/questions/tagged/apache-flagon">StackOverflow</a>.
</p>
<h3 class="ui header">
<i class="bug icon"></i>
<div class="content">Issues and Bugs</div>
</h3>
<p>
- Visit our <a href="https://issues.apache.org/jira/browse/SENSSOFT">Jira Issue Tracker</a> for full information on current developments, bugs, etc.
+ Visit our <a href="https://issues.apache.org/jira/browse/FLAGON">JIRA Issue Tracker</a> for full information on current developments, bugs, etc.
</p>
<h3 class="ui header">
<i class="sticky note icon"></i>
<div class="content">Wiki</div>
</h3>
<p>
- See our <a href="https://cwiki.apache.org/confluence/display/SENSSOFT">wiki</a> for detailed information on project organization, roadmaps, etc.
+ See our <a href="https://cwiki.apache.org/confluence/display/FLAGON">wiki</a> for detailed information on project organization, roadmaps, etc.
</p>
</div>
<div class="ui vertical segment">
<h2 class="ui header">Contributors</h2>
<p>
- Thank you to all our contributors! Want to be added? Contribute and <a href="mailto:dev@senssoft.incubator.apache.org">contact us!</a>
+ Thank you to all our contributors! Want to be added? Contribute and <a href="mailto:dev@flagon.incubator.apache.org">contact us!</a>
</p>
<ul class="ui list">
<li>Michelle Beard</li>
@@ -157,6 +161,7 @@
<li>Dan Traviglia</li>
<li>Arthi Vezhavendan</li>
<li>Steve York</li>
+ <li>David Meikle</li>
</ul>
</div>
@@ -171,7 +176,7 @@
<div class="column">
<h4 class="ui inverted header">About</h4>
<div class="ui inverted link list">
- <a class="item" href="/system">System</a>
+ <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>
@@ -181,10 +186,10 @@
<div class="column">
<h4 class="ui inverted header">Docs</h4>
<div class="ui inverted link list">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserAle.pyqt</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>
@@ -193,21 +198,21 @@
<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=senssoft">GitHub</a>
- <a class="item" href="http://stackoverflow.com/questions/tagged/apache-senssoft">StackOverflow</a>
- <a class="item" href="https://issues.apache.org/jira/browse/SENSSOFT">Jira Issue Tracker</a>
- <a class="item" href="https://cwiki.apache.org/confluence/display/SENSSOFT">Project Wiki</a>
- <a class="item" href="https://twitter.com/apachesenssoft">Twitter</a>
+ <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/licenses/LICENSE-2.0.html">License</a>
<a class="item" href="http://www.apache.org/">Apache Software Foundation</a>
- <a class="item" href="http://incubator.apache.org/">Apache Incubator</a>
- <a class="item" href="http://www.apache.org/foundation/sponsorship.html">Sponsor Apache</a>
- <a class="item" href="http://www.apache.org/foundation/thanks.html">Thank you</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>
@@ -215,12 +220,23 @@
<div class="ui inverted vertical segment">
<div class="ui two column middle aligned grid">
<div class="column">
- Apache SensSoft 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 th [...]
+ 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">
- <img class="component-image" src="/images/incubator-logo-white.png">
- <br>
- Copyright © 2017 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, and the Apache Incubator logo are trademarks of The Apache Software Foundation. Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc.
+ <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>
diff --git a/content/distill/index.html b/content/distill/index.html
index 784bf24..32e1e74 100644
--- a/content/distill/index.html
+++ b/content/distill/index.html
@@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Distill</title>
- <meta name="description" content="The homepage for Apache SensSoft">
+ <meta name="description" content="The homepage for Apache Flagon">
<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,8 +16,8 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://localhost:4000/distill/">
- <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml">
+ <link rel="canonical" href="http://flagon.incubator.apache.org/distill/">
+ <link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
</head>
@@ -28,14 +28,14 @@
<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 SensSoft</h3>
+ <h3 class="ui inverted header item">Apache Flagon</h3>
</a>
<div class="right menu">
<div class="ui dropdown item">
Components
<div class="menu">
- <a class="item" href="/system">System</a>
+ <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>
@@ -45,10 +45,10 @@
<div class="ui dropdown item">
<a href="/docs">Docs</a>
<div class="menu">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserALE.pyqt</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>
@@ -164,7 +164,7 @@
<div class="column">
<h4 class="ui inverted header">About</h4>
<div class="ui inverted link list">
- <a class="item" href="/system">System</a>
+ <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>
@@ -174,10 +174,10 @@
<div class="column">
<h4 class="ui inverted header">Docs</h4>
<div class="ui inverted link list">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserAle.pyqt</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>
@@ -186,21 +186,21 @@
<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=senssoft">GitHub</a>
- <a class="item" href="http://stackoverflow.com/questions/tagged/apache-senssoft">StackOverflow</a>
- <a class="item" href="https://issues.apache.org/jira/browse/SENSSOFT">Jira Issue Tracker</a>
- <a class="item" href="https://cwiki.apache.org/confluence/display/SENSSOFT">Project Wiki</a>
- <a class="item" href="https://twitter.com/apachesenssoft">Twitter</a>
+ <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/licenses/LICENSE-2.0.html">License</a>
<a class="item" href="http://www.apache.org/">Apache Software Foundation</a>
- <a class="item" href="http://incubator.apache.org/">Apache Incubator</a>
- <a class="item" href="http://www.apache.org/foundation/sponsorship.html">Sponsor Apache</a>
- <a class="item" href="http://www.apache.org/foundation/thanks.html">Thank you</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>
@@ -208,12 +208,23 @@
<div class="ui inverted vertical segment">
<div class="ui two column middle aligned grid">
<div class="column">
- Apache SensSoft 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 th [...]
+ 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">
- <img class="component-image" src="/images/incubator-logo-white.png">
- <br>
- Copyright © 2017 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, and the Apache Incubator logo are trademarks of The Apache Software Foundation. Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc.
+ 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>
diff --git a/content/docs/distill/start.html b/content/docs/contributing/index.html
similarity index 53%
copy from content/docs/distill/start.html
copy to content/docs/contributing/index.html
index ccb3f2d..24d6254 100644
--- a/content/docs/distill/start.html
+++ b/content/docs/contributing/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>Contributing</title>
+ <meta name="description" content="First, thank you for contributing to Apache Flagon!">
<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,8 +16,8 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://localhost:4000/docs/distill/start.html">
- <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml">
+ <link rel="canonical" href="http://flagon.incubator.apache.org/docs/contributing/">
+ <link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
</head>
@@ -28,14 +28,14 @@
<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 SensSoft</h3>
+ <h3 class="ui inverted header item">Apache Flagon</h3>
</a>
<div class="right menu">
<div class="ui dropdown item">
Components
<div class="menu">
- <a class="item" href="/system">System</a>
+ <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>
@@ -45,10 +45,10 @@
<div class="ui dropdown item">
<a href="/docs">Docs</a>
<div class="menu">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserALE.pyqt</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>
@@ -78,19 +78,19 @@
</div> -->
<div id="docs-nav" class="ui inverted accordion">
- <div class="title">
+ <div class="active title">
<i class="dropdown icon"></i>
- Apache SensSoft
+ Apache Flagon
</div>
- <div class="content">
+ <div class="active content">
<div class="ui inverted bulleted list docs-list">
<a class="item" href="/docs/">About the Docs</a>
- <a class="item" href="/docs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/contributing/">Contributing</a>
</div>
</div>
@@ -100,14 +100,16 @@
<div class="title">
<i class="dropdown icon"></i>
- System
+ Stack
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/system/">Getting Started</a>
+ <a class="item" href="/docs/stack/">Getting Started</a>
+
+ <a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
</div>
</div>
@@ -141,9 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+
+ <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+
+ <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
- <a class="item" href="/docs/useralejs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+
+ <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
</div>
</div>
@@ -152,32 +160,32 @@
<div class="title">
<i class="dropdown icon"></i>
- UserALE.pyqt
+ UserALE.py
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/useralepyqt/">Installation</a>
+ <a class="item" href="/docs/useralepy/">Installation</a>
- <a class="item" href="/docs/useralepyqt/start.html">Getting Started</a>
+ <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
- <a class="item" href="/docs/useralepyqt/api.html">API Documentation</a>
+ <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
- <a class="item" href="/docs/useralepyqt/changelog.html">Changelog</a>
+ <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
</div>
</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">
@@ -187,13 +195,13 @@
<a class="item" href="/docs/distill/api.html">API Documentation</a>
- <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</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/analytics.html">Apache Distill Analytics</a>
+ <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a>
<a class="item" href="/docs/distill/changelog.html">Changelog</a>
@@ -237,18 +245,32 @@
</div>
<div class="docs-content">
- <h2 class="ui header">Getting Started</h2>
- <h3 id="usage">Usage</h3>
+ <h2 class="ui header">Contributing</h2>
+ <p>First, thank you for contributing to Apache Flagon!</p>
+
+<p>There are certain procedures that must be followed for all contributions. These procedures are necessary to allow us to allocate resources for reviewing and testing your contribution, as well as to communicate effectively with you during the review process.</p>
+
+<p>See individual product guides for product-specific information on getting started as a contributor, setup and testing, code style, etc.</p>
-<p>Using curl:</p>
+<p>To report a bug or other issue, simply create an issue in JIRA, as described in Step 1 below.</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>
+<h4 id="1-create-an-issue-in-jira">1. Create an issue in JIRA</h4>
+
+<p>All changes to Apache Flagon must have a corresponding issue in <a href="https://issues.apache.org/jira/browse/FLAGON">JIRA</a> so the change can be properly tracked. If you do not already have an account on JIRA, you will need to create one before creating your new issue.</p>
+
+<h4 id="2-make-and-test-your-changes-locally">2. Make and test your changes locally</h4>
+
+<p>The Apache Flagon source code is maintained in <a href="https://gitbox.apache.org/repos/asf?s=flagon">several git repositories</a> hosted by Apache. These repositories are mirrored and more easily available <a href="https://github.com/apache?q=flagon">on GitHub</a>. To make your changes, fork the appropriate GitHub repository and make commits to a topic branch in your fork. Commits should be made in logical units and must reference the JIRA issue number:</p>
+<div class="language-shell highlighter-rouge"><pre class="highlight"><code> git commit -S -m <span class="s2">"[FLAGON-123] High-level message describing the changes."</span>
</code></pre>
</div>
+<p>Note that your commits should be verifiable; each commit should be verified with a PGP certificate. The easiest way to do this is to create a PGP signature with <a href="https://www.gnupg.org/">GnuPG</a>, register it with you GitHub account and <a href="https://git-scm.com/book/en/v2/Git-Tools-Signing-Your-Work">configure git</a> to use this signature when committing.</p>
+
+<p>Avoid commits which cover multiple, distinct goals that could (and should) be handled separately. If you do not already have an account on JIRA, you will need to create one to claim an issue, discuss development, or report results.</p>
+
+<h4 id="3-submit-your-changes-via-a-pull-request-on-github">3. Submit your changes via a pull request on GitHub</h4>
+
+<p>Once your changes are ready, submit them by creating a pull request for the corresponding topic branch you created when you began working on your changes. The core team will then review your changes and, if they pass review, your changes will be merged into the primary Apache-hosted repos.</p>
</div>
</div>
@@ -261,7 +283,7 @@
<div class="column">
<h4 class="ui inverted header">About</h4>
<div class="ui inverted link list">
- <a class="item" href="/system">System</a>
+ <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>
@@ -271,10 +293,10 @@
<div class="column">
<h4 class="ui inverted header">Docs</h4>
<div class="ui inverted link list">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserAle.pyqt</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>
@@ -283,21 +305,21 @@
<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=senssoft">GitHub</a>
- <a class="item" href="http://stackoverflow.com/questions/tagged/apache-senssoft">StackOverflow</a>
- <a class="item" href="https://issues.apache.org/jira/browse/SENSSOFT">Jira Issue Tracker</a>
- <a class="item" href="https://cwiki.apache.org/confluence/display/SENSSOFT">Project Wiki</a>
- <a class="item" href="https://twitter.com/apachesenssoft">Twitter</a>
+ <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/licenses/LICENSE-2.0.html">License</a>
<a class="item" href="http://www.apache.org/">Apache Software Foundation</a>
- <a class="item" href="http://incubator.apache.org/">Apache Incubator</a>
- <a class="item" href="http://www.apache.org/foundation/sponsorship.html">Sponsor Apache</a>
- <a class="item" href="http://www.apache.org/foundation/thanks.html">Thank you</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>
@@ -305,12 +327,23 @@
<div class="ui inverted vertical segment">
<div class="ui two column middle aligned grid">
<div class="column">
- Apache SensSoft 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 th [...]
+ 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">
- <img class="component-image" src="/images/incubator-logo-white.png">
- <br>
- Copyright © 2017 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, and the Apache Incubator logo are trademarks of The Apache Software Foundation. Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc.
+ <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>
diff --git a/content/docs/distill/analytics.html b/content/docs/distill/analytics.html
index 402621e..90bc760 100644
--- a/content/docs/distill/analytics.html
+++ b/content/docs/distill/analytics.html
@@ -16,8 +16,8 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://localhost:4000/docs/distill/analytics.html">
- <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml">
+ <link rel="canonical" href="http://flagon.incubator.apache.org/docs/distill/analytics.html">
+ <link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
</head>
@@ -28,14 +28,14 @@
<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 SensSoft</h3>
+ <h3 class="ui inverted header item">Apache Flagon</h3>
</a>
<div class="right menu">
<div class="ui dropdown item">
Components
<div class="menu">
- <a class="item" href="/system">System</a>
+ <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>
@@ -45,10 +45,10 @@
<div class="ui dropdown item">
<a href="/docs">Docs</a>
<div class="menu">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserALE.pyqt</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>
@@ -81,7 +81,7 @@
<div class="title">
<i class="dropdown icon"></i>
- Apache SensSoft
+ Apache Flagon
</div>
<div class="content">
@@ -90,7 +90,7 @@
<a class="item" href="/docs/">About the Docs</a>
- <a class="item" href="/docs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/contributing/">Contributing</a>
</div>
</div>
@@ -100,14 +100,16 @@
<div class="title">
<i class="dropdown icon"></i>
- System
+ Stack
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/system/">Getting Started</a>
+ <a class="item" href="/docs/stack/">Getting Started</a>
+
+ <a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
</div>
</div>
@@ -141,9 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+
+ <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+
+ <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
- <a class="item" href="/docs/useralejs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+
+ <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
</div>
</div>
@@ -152,20 +160,20 @@
<div class="title">
<i class="dropdown icon"></i>
- UserALE.pyqt
+ UserALE.py
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/useralepyqt/">Installation</a>
+ <a class="item" href="/docs/useralepy/">Installation</a>
- <a class="item" href="/docs/useralepyqt/start.html">Getting Started</a>
+ <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
- <a class="item" href="/docs/useralepyqt/api.html">API Documentation</a>
+ <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
- <a class="item" href="/docs/useralepyqt/changelog.html">Changelog</a>
+ <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
</div>
</div>
@@ -187,13 +195,13 @@
<a class="item" href="/docs/distill/api.html">API Documentation</a>
- <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</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/analytics.html">Apache Distill Analytics</a>
+ <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a>
<a class="item" href="/docs/distill/changelog.html">Changelog</a>
@@ -343,7 +351,7 @@
<div class="column">
<h4 class="ui inverted header">About</h4>
<div class="ui inverted link list">
- <a class="item" href="/system">System</a>
+ <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>
@@ -353,10 +361,10 @@
<div class="column">
<h4 class="ui inverted header">Docs</h4>
<div class="ui inverted link list">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserAle.pyqt</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>
@@ -365,21 +373,21 @@
<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=senssoft">GitHub</a>
- <a class="item" href="http://stackoverflow.com/questions/tagged/apache-senssoft">StackOverflow</a>
- <a class="item" href="https://issues.apache.org/jira/browse/SENSSOFT">Jira Issue Tracker</a>
- <a class="item" href="https://cwiki.apache.org/confluence/display/SENSSOFT">Project Wiki</a>
- <a class="item" href="https://twitter.com/apachesenssoft">Twitter</a>
+ <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/licenses/LICENSE-2.0.html">License</a>
<a class="item" href="http://www.apache.org/">Apache Software Foundation</a>
- <a class="item" href="http://incubator.apache.org/">Apache Incubator</a>
- <a class="item" href="http://www.apache.org/foundation/sponsorship.html">Sponsor Apache</a>
- <a class="item" href="http://www.apache.org/foundation/thanks.html">Thank you</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>
@@ -387,12 +395,23 @@
<div class="ui inverted vertical segment">
<div class="ui two column middle aligned grid">
<div class="column">
- Apache SensSoft 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 th [...]
+ 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">
- <img class="component-image" src="/images/incubator-logo-white.png">
- <br>
- Copyright © 2017 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, and the Apache Incubator logo are trademarks of The Apache Software Foundation. Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc.
+ <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>
diff --git a/content/docs/distill/api.html b/content/docs/distill/api.html
index adb86a7..cc7e1a9 100644
--- a/content/docs/distill/api.html
+++ b/content/docs/distill/api.html
@@ -16,8 +16,8 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://localhost:4000/docs/distill/api.html">
- <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml">
+ <link rel="canonical" href="http://flagon.incubator.apache.org/docs/distill/api.html">
+ <link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
</head>
@@ -28,14 +28,14 @@
<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 SensSoft</h3>
+ <h3 class="ui inverted header item">Apache Flagon</h3>
</a>
<div class="right menu">
<div class="ui dropdown item">
Components
<div class="menu">
- <a class="item" href="/system">System</a>
+ <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>
@@ -45,10 +45,10 @@
<div class="ui dropdown item">
<a href="/docs">Docs</a>
<div class="menu">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserALE.pyqt</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>
@@ -81,7 +81,7 @@
<div class="title">
<i class="dropdown icon"></i>
- Apache SensSoft
+ Apache Flagon
</div>
<div class="content">
@@ -90,7 +90,7 @@
<a class="item" href="/docs/">About the Docs</a>
- <a class="item" href="/docs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/contributing/">Contributing</a>
</div>
</div>
@@ -100,14 +100,16 @@
<div class="title">
<i class="dropdown icon"></i>
- System
+ Stack
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/system/">Getting Started</a>
+ <a class="item" href="/docs/stack/">Getting Started</a>
+
+ <a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
</div>
</div>
@@ -141,9 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+
+ <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+
+ <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
- <a class="item" href="/docs/useralejs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+
+ <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
</div>
</div>
@@ -152,20 +160,20 @@
<div class="title">
<i class="dropdown icon"></i>
- UserALE.pyqt
+ UserALE.py
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/useralepyqt/">Installation</a>
+ <a class="item" href="/docs/useralepy/">Installation</a>
- <a class="item" href="/docs/useralepyqt/start.html">Getting Started</a>
+ <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
- <a class="item" href="/docs/useralepyqt/api.html">API Documentation</a>
+ <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
- <a class="item" href="/docs/useralepyqt/changelog.html">Changelog</a>
+ <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
</div>
</div>
@@ -187,13 +195,13 @@
<a class="item" href="/docs/distill/api.html">API Documentation</a>
- <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</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/analytics.html">Apache Distill Analytics</a>
+ <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a>
<a class="item" href="/docs/distill/changelog.html">Changelog</a>
@@ -238,25 +246,25 @@
</div>
<div class="docs-content">
<h2 class="ui header">API Documentation</h2>
- <h3 id="apache-distill-http-client"><a href="/docs/distill/http/">Apache Distill HTTP Client</a></h3>
+ <h3 id="apache-distill-http-client"><a href="/docs/distill/http.html">Apache Distill HTTP Client</a></h3>
<ul>
<li>RESTful Endpoints</li>
</ul>
-<h3 id="apache-distill-analytics"><a href="/docs/distill/analytics/">Apache Distill Analytics</a></h3>
+<h3 id="apache-distill-analytics"><a href="/docs/distill/analytics.html">Apache Distill Analytics</a></h3>
<ul>
<li>Graph Analytics</li>
<li>Statistics Package</li>
</ul>
-<h3 id="apache-distill-models"><a href="/docs/distill/models/">Apache Distill Models</a></h3>
+<h3 id="apache-distill-models"><a href="/docs/distill/models.html">Apache Distill Models</a></h3>
<ul>
<li>Brew Interface</li>
<li>Stout Interface</li>
<li>UserAle Interface</li>
</ul>
-<h3 id="apache-distill-utilities"><a href="/docs/distill/utilities/">Apache Distill Utilities</a></h3>
+<h3 id="apache-distill-utilities"><a href="/docs/distill/utilities.html">Apache Distill Utilities</a></h3>
<ul>
<li>Query Builder</li>
<li>Exception Handling</li>
@@ -274,7 +282,7 @@
<div class="column">
<h4 class="ui inverted header">About</h4>
<div class="ui inverted link list">
- <a class="item" href="/system">System</a>
+ <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>
@@ -284,10 +292,10 @@
<div class="column">
<h4 class="ui inverted header">Docs</h4>
<div class="ui inverted link list">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserAle.pyqt</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>
@@ -296,21 +304,21 @@
<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=senssoft">GitHub</a>
- <a class="item" href="http://stackoverflow.com/questions/tagged/apache-senssoft">StackOverflow</a>
- <a class="item" href="https://issues.apache.org/jira/browse/SENSSOFT">Jira Issue Tracker</a>
- <a class="item" href="https://cwiki.apache.org/confluence/display/SENSSOFT">Project Wiki</a>
- <a class="item" href="https://twitter.com/apachesenssoft">Twitter</a>
+ <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/licenses/LICENSE-2.0.html">License</a>
<a class="item" href="http://www.apache.org/">Apache Software Foundation</a>
- <a class="item" href="http://incubator.apache.org/">Apache Incubator</a>
- <a class="item" href="http://www.apache.org/foundation/sponsorship.html">Sponsor Apache</a>
- <a class="item" href="http://www.apache.org/foundation/thanks.html">Thank you</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>
@@ -318,12 +326,23 @@
<div class="ui inverted vertical segment">
<div class="ui two column middle aligned grid">
<div class="column">
- Apache SensSoft 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 th [...]
+ 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">
- <img class="component-image" src="/images/incubator-logo-white.png">
- <br>
- Copyright © 2017 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, and the Apache Incubator logo are trademarks of The Apache Software Foundation. Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc.
+ <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>
diff --git a/content/docs/distill/changelog.html b/content/docs/distill/changelog.html
index d349531..39c543f 100644
--- a/content/docs/distill/changelog.html
+++ b/content/docs/distill/changelog.html
@@ -16,8 +16,8 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://localhost:4000/docs/distill/changelog.html">
- <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml">
+ <link rel="canonical" href="http://flagon.incubator.apache.org/docs/distill/changelog.html">
+ <link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
</head>
@@ -28,14 +28,14 @@
<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 SensSoft</h3>
+ <h3 class="ui inverted header item">Apache Flagon</h3>
</a>
<div class="right menu">
<div class="ui dropdown item">
Components
<div class="menu">
- <a class="item" href="/system">System</a>
+ <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>
@@ -45,10 +45,10 @@
<div class="ui dropdown item">
<a href="/docs">Docs</a>
<div class="menu">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserALE.pyqt</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>
@@ -81,7 +81,7 @@
<div class="title">
<i class="dropdown icon"></i>
- Apache SensSoft
+ Apache Flagon
</div>
<div class="content">
@@ -90,7 +90,7 @@
<a class="item" href="/docs/">About the Docs</a>
- <a class="item" href="/docs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/contributing/">Contributing</a>
</div>
</div>
@@ -100,14 +100,16 @@
<div class="title">
<i class="dropdown icon"></i>
- System
+ Stack
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/system/">Getting Started</a>
+ <a class="item" href="/docs/stack/">Getting Started</a>
+
+ <a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
</div>
</div>
@@ -141,9 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+
+ <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+
+ <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
- <a class="item" href="/docs/useralejs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+
+ <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
</div>
</div>
@@ -152,20 +160,20 @@
<div class="title">
<i class="dropdown icon"></i>
- UserALE.pyqt
+ UserALE.py
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/useralepyqt/">Installation</a>
+ <a class="item" href="/docs/useralepy/">Installation</a>
- <a class="item" href="/docs/useralepyqt/start.html">Getting Started</a>
+ <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
- <a class="item" href="/docs/useralepyqt/api.html">API Documentation</a>
+ <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
- <a class="item" href="/docs/useralepyqt/changelog.html">Changelog</a>
+ <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
</div>
</div>
@@ -187,13 +195,13 @@
<a class="item" href="/docs/distill/api.html">API Documentation</a>
- <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</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/analytics.html">Apache Distill Analytics</a>
+ <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a>
<a class="item" href="/docs/distill/changelog.html">Changelog</a>
@@ -278,7 +286,7 @@
<div class="column">
<h4 class="ui inverted header">About</h4>
<div class="ui inverted link list">
- <a class="item" href="/system">System</a>
+ <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>
@@ -288,10 +296,10 @@
<div class="column">
<h4 class="ui inverted header">Docs</h4>
<div class="ui inverted link list">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserAle.pyqt</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>
@@ -300,21 +308,21 @@
<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=senssoft">GitHub</a>
- <a class="item" href="http://stackoverflow.com/questions/tagged/apache-senssoft">StackOverflow</a>
- <a class="item" href="https://issues.apache.org/jira/browse/SENSSOFT">Jira Issue Tracker</a>
- <a class="item" href="https://cwiki.apache.org/confluence/display/SENSSOFT">Project Wiki</a>
- <a class="item" href="https://twitter.com/apachesenssoft">Twitter</a>
+ <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/licenses/LICENSE-2.0.html">License</a>
<a class="item" href="http://www.apache.org/">Apache Software Foundation</a>
- <a class="item" href="http://incubator.apache.org/">Apache Incubator</a>
- <a class="item" href="http://www.apache.org/foundation/sponsorship.html">Sponsor Apache</a>
- <a class="item" href="http://www.apache.org/foundation/thanks.html">Thank you</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>
@@ -322,12 +330,23 @@
<div class="ui inverted vertical segment">
<div class="ui two column middle aligned grid">
<div class="column">
- Apache SensSoft 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 th [...]
+ 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">
- <img class="component-image" src="/images/incubator-logo-white.png">
- <br>
- Copyright © 2017 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, and the Apache Incubator logo are trademarks of The Apache Software Foundation. Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc.
+ <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>
diff --git a/content/docs/distill/http.html b/content/docs/distill/http.html
index 2ebec24..80d94f5 100644
--- a/content/docs/distill/http.html
+++ b/content/docs/distill/http.html
@@ -16,8 +16,8 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://localhost:4000/docs/distill/http.html">
- <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml">
+ <link rel="canonical" href="http://flagon.incubator.apache.org/docs/distill/http.html">
+ <link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
</head>
@@ -28,14 +28,14 @@
<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 SensSoft</h3>
+ <h3 class="ui inverted header item">Apache Flagon</h3>
</a>
<div class="right menu">
<div class="ui dropdown item">
Components
<div class="menu">
- <a class="item" href="/system">System</a>
+ <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>
@@ -45,10 +45,10 @@
<div class="ui dropdown item">
<a href="/docs">Docs</a>
<div class="menu">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserALE.pyqt</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>
@@ -81,7 +81,7 @@
<div class="title">
<i class="dropdown icon"></i>
- Apache SensSoft
+ Apache Flagon
</div>
<div class="content">
@@ -90,7 +90,7 @@
<a class="item" href="/docs/">About the Docs</a>
- <a class="item" href="/docs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/contributing/">Contributing</a>
</div>
</div>
@@ -100,14 +100,16 @@
<div class="title">
<i class="dropdown icon"></i>
- System
+ Stack
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/system/">Getting Started</a>
+ <a class="item" href="/docs/stack/">Getting Started</a>
+
+ <a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
</div>
</div>
@@ -141,9 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+
+ <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+
+ <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+
+ <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
- <a class="item" href="/docs/useralejs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
</div>
</div>
@@ -152,20 +160,20 @@
<div class="title">
<i class="dropdown icon"></i>
- UserALE.pyqt
+ UserALE.py
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/useralepyqt/">Installation</a>
+ <a class="item" href="/docs/useralepy/">Installation</a>
- <a class="item" href="/docs/useralepyqt/start.html">Getting Started</a>
+ <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
- <a class="item" href="/docs/useralepyqt/api.html">API Documentation</a>
+ <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
- <a class="item" href="/docs/useralepyqt/changelog.html">Changelog</a>
+ <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
</div>
</div>
@@ -187,13 +195,13 @@
<a class="item" href="/docs/distill/api.html">API Documentation</a>
- <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</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/analytics.html">Apache Distill Analytics</a>
+ <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a>
<a class="item" href="/docs/distill/changelog.html">Changelog</a>
@@ -357,7 +365,7 @@
<div class="language-javascript highlighter-rouge"><pre class="highlight"><code><span class="p">{</span>
<span class="s2">"author"</span> <span class="err">:</span> <span class="s2">"Michelle Beard"</span><span class="p">,</span>
- <span class="s2">"email"</span> <span class="err">:</span> <span class="s2">"mbeard@draper.com"</span><span class="p">,</span>
+ <span class="s2">"email"</span> <span class="err">:</span> <span class="s2">"msbeard@apache.org"</span><span class="p">,</span>
<span class="s2">"name"</span><span class="err">:</span> <span class="s2">"Distill"</span><span class="p">,</span>
<span class="s2">"status"</span> <span class="err">:</span> <span class="kc">true</span><span class="p">,</span>
<span class="s2">"version"</span> <span class="err">:</span> <span class="s2">"1.0"</span><span class="p">,</span>
@@ -520,10 +528,8 @@ testing/?stat<span class="o">=</span>terms&elem<span class="o">=</span>signu
<span class="p">}</span>
</code></pre>
</div>
-</blockquote>
-
-<blockquote>
- <p><strong>Parameters:</strong></p>
+ <p>w
+<strong>Parameters:</strong></p>
<ul>
<li>app_id – Application name</li>
</ul>
@@ -579,7 +585,7 @@ testing/?stat<span class="o">=</span>terms&elem<span class="o">=</span>signu
<div class="column">
<h4 class="ui inverted header">About</h4>
<div class="ui inverted link list">
- <a class="item" href="/system">System</a>
+ <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>
@@ -589,10 +595,10 @@ testing/?stat<span class="o">=</span>terms&elem<span class="o">=</span>signu
<div class="column">
<h4 class="ui inverted header">Docs</h4>
<div class="ui inverted link list">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserAle.pyqt</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>
@@ -601,21 +607,21 @@ testing/?stat<span class="o">=</span>terms&elem<span class="o">=</span>signu
<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=senssoft">GitHub</a>
- <a class="item" href="http://stackoverflow.com/questions/tagged/apache-senssoft">StackOverflow</a>
- <a class="item" href="https://issues.apache.org/jira/browse/SENSSOFT">Jira Issue Tracker</a>
- <a class="item" href="https://cwiki.apache.org/confluence/display/SENSSOFT">Project Wiki</a>
- <a class="item" href="https://twitter.com/apachesenssoft">Twitter</a>
+ <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/licenses/LICENSE-2.0.html">License</a>
<a class="item" href="http://www.apache.org/">Apache Software Foundation</a>
- <a class="item" href="http://incubator.apache.org/">Apache Incubator</a>
- <a class="item" href="http://www.apache.org/foundation/sponsorship.html">Sponsor Apache</a>
- <a class="item" href="http://www.apache.org/foundation/thanks.html">Thank you</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>
@@ -623,12 +629,23 @@ testing/?stat<span class="o">=</span>terms&elem<span class="o">=</span>signu
<div class="ui inverted vertical segment">
<div class="ui two column middle aligned grid">
<div class="column">
- Apache SensSoft 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 th [...]
+ 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">
- <img class="component-image" src="/images/incubator-logo-white.png">
- <br>
- Copyright © 2017 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, and the Apache Incubator logo are trademarks of The Apache Software Foundation. Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc.
+ 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>
diff --git a/content/docs/distill/index.html b/content/docs/distill/index.html
index 6cd8185..dcc37bd 100644
--- a/content/docs/distill/index.html
+++ b/content/docs/distill/index.html
@@ -16,8 +16,8 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://localhost:4000/docs/distill/">
- <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml">
+ <link rel="canonical" href="http://flagon.incubator.apache.org/docs/distill/">
+ <link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
</head>
@@ -28,14 +28,14 @@
<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 SensSoft</h3>
+ <h3 class="ui inverted header item">Apache Flagon</h3>
</a>
<div class="right menu">
<div class="ui dropdown item">
Components
<div class="menu">
- <a class="item" href="/system">System</a>
+ <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>
@@ -45,10 +45,10 @@
<div class="ui dropdown item">
<a href="/docs">Docs</a>
<div class="menu">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserALE.pyqt</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>
@@ -81,7 +81,7 @@
<div class="title">
<i class="dropdown icon"></i>
- Apache SensSoft
+ Apache Flagon
</div>
<div class="content">
@@ -90,7 +90,7 @@
<a class="item" href="/docs/">About the Docs</a>
- <a class="item" href="/docs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/contributing/">Contributing</a>
</div>
</div>
@@ -100,14 +100,16 @@
<div class="title">
<i class="dropdown icon"></i>
- System
+ Stack
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/system/">Getting Started</a>
+ <a class="item" href="/docs/stack/">Getting Started</a>
+
+ <a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
</div>
</div>
@@ -141,9 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+
+ <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+
+ <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
- <a class="item" href="/docs/useralejs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+
+ <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
</div>
</div>
@@ -152,20 +160,20 @@
<div class="title">
<i class="dropdown icon"></i>
- UserALE.pyqt
+ UserALE.py
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/useralepyqt/">Installation</a>
+ <a class="item" href="/docs/useralepy/">Installation</a>
- <a class="item" href="/docs/useralepyqt/start.html">Getting Started</a>
+ <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
- <a class="item" href="/docs/useralepyqt/api.html">API Documentation</a>
+ <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
- <a class="item" href="/docs/useralepyqt/changelog.html">Changelog</a>
+ <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
</div>
</div>
@@ -187,13 +195,13 @@
<a class="item" href="/docs/distill/api.html">API Documentation</a>
- <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</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/analytics.html">Apache Distill Analytics</a>
+ <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a>
<a class="item" href="/docs/distill/changelog.html">Changelog</a>
@@ -242,7 +250,7 @@
<p>The first step is to install Apache Distill. First, checkout the latest version of Apache Distill.</p>
-<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>git clone https://git-wip-us.apache.org/repos/asf/incubator-senssoft-distill.git
+<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>git clone https://gitbox.apache.org/repos/asf/incubator-flagon-distill.git
</code></pre>
</div>
@@ -263,7 +271,7 @@
<p>Users are strongly recommended to install Apache Distill in a virtualenv. Instructions to setup an virtual environment will be explained below.</p>
<blockquote>
- <p><strong>Note</strong>&
+ <p><strong>Note</strong>
When the package is installed via easy_install or pip this function will be bound to the distill executable in the Python installation’s bin directory (on Windows - the Scripts directory).</p>
</blockquote>
@@ -347,8 +355,7 @@ When the package is installed via easy_install or pip this function will be boun
<p>Download the project from the GitHub repository and copy the application to the /home/public_html directory.</p>
-<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>git clone https://git-wip-us.apache.org/repos/asf
- /incubator-senssoft-distill.git /home/public_html
+<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>git clone https://gitbox.apache.org/repos/asf/incubator-flagon-distill.git /home/public_html
</code></pre>
</div>
@@ -378,9 +385,7 @@ When the package is installed via easy_install or pip this function will be boun
<h3 id="installing-documentation">Installing Documentation</h3>
-<p>To save yourself the trouble, all up to date documentation is available at https://draperlaboratory.github.io/distill/.</p>
-
-<p>However, if you want to manully build the documentation, the instructions are below.</p>
+<p>If you want to manually build the documentation, the instructions are below.</p>
<p>First, install the documentation dependencies:</p>
@@ -418,7 +423,7 @@ When the package is installed via easy_install or pip this function will be boun
<div class="column">
<h4 class="ui inverted header">About</h4>
<div class="ui inverted link list">
- <a class="item" href="/system">System</a>
+ <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>
@@ -428,10 +433,10 @@ When the package is installed via easy_install or pip this function will be boun
<div class="column">
<h4 class="ui inverted header">Docs</h4>
<div class="ui inverted link list">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserAle.pyqt</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>
@@ -440,21 +445,21 @@ When the package is installed via easy_install or pip this function will be boun
<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=senssoft">GitHub</a>
- <a class="item" href="http://stackoverflow.com/questions/tagged/apache-senssoft">StackOverflow</a>
- <a class="item" href="https://issues.apache.org/jira/browse/SENSSOFT">Jira Issue Tracker</a>
- <a class="item" href="https://cwiki.apache.org/confluence/display/SENSSOFT">Project Wiki</a>
- <a class="item" href="https://twitter.com/apachesenssoft">Twitter</a>
+ <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/licenses/LICENSE-2.0.html">License</a>
<a class="item" href="http://www.apache.org/">Apache Software Foundation</a>
- <a class="item" href="http://incubator.apache.org/">Apache Incubator</a>
- <a class="item" href="http://www.apache.org/foundation/sponsorship.html">Sponsor Apache</a>
- <a class="item" href="http://www.apache.org/foundation/thanks.html">Thank you</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>
@@ -462,12 +467,23 @@ When the package is installed via easy_install or pip this function will be boun
<div class="ui inverted vertical segment">
<div class="ui two column middle aligned grid">
<div class="column">
- Apache SensSoft 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 th [...]
+ 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">
- <img class="component-image" src="/images/incubator-logo-white.png">
- <br>
- Copyright © 2017 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, and the Apache Incubator logo are trademarks of The Apache Software Foundation. Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc.
+ <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>
diff --git a/content/docs/distill/models.html b/content/docs/distill/models.html
index 26f145f..1ec0761 100644
--- a/content/docs/distill/models.html
+++ b/content/docs/distill/models.html
@@ -16,8 +16,8 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://localhost:4000/docs/distill/models.html">
- <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml">
+ <link rel="canonical" href="http://flagon.incubator.apache.org/docs/distill/models.html">
+ <link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
</head>
@@ -28,14 +28,14 @@
<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 SensSoft</h3>
+ <h3 class="ui inverted header item">Apache Flagon</h3>
</a>
<div class="right menu">
<div class="ui dropdown item">
Components
<div class="menu">
- <a class="item" href="/system">System</a>
+ <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>
@@ -45,10 +45,10 @@
<div class="ui dropdown item">
<a href="/docs">Docs</a>
<div class="menu">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserALE.pyqt</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>
@@ -81,7 +81,7 @@
<div class="title">
<i class="dropdown icon"></i>
- Apache SensSoft
+ Apache Flagon
</div>
<div class="content">
@@ -90,7 +90,7 @@
<a class="item" href="/docs/">About the Docs</a>
- <a class="item" href="/docs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/contributing/">Contributing</a>
</div>
</div>
@@ -100,14 +100,16 @@
<div class="title">
<i class="dropdown icon"></i>
- System
+ Stack
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/system/">Getting Started</a>
+ <a class="item" href="/docs/stack/">Getting Started</a>
+
+ <a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
</div>
</div>
@@ -141,9 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+
+ <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+
+ <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
- <a class="item" href="/docs/useralejs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+
+ <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
</div>
</div>
@@ -152,20 +160,20 @@
<div class="title">
<i class="dropdown icon"></i>
- UserALE.pyqt
+ UserALE.py
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/useralepyqt/">Installation</a>
+ <a class="item" href="/docs/useralepy/">Installation</a>
- <a class="item" href="/docs/useralepyqt/start.html">Getting Started</a>
+ <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
- <a class="item" href="/docs/useralepyqt/api.html">API Documentation</a>
+ <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
- <a class="item" href="/docs/useralepyqt/changelog.html">Changelog</a>
+ <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
</div>
</div>
@@ -187,13 +195,13 @@
<a class="item" href="/docs/distill/api.html">API Documentation</a>
- <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</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/analytics.html">Apache Distill Analytics</a>
+ <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a>
<a class="item" href="/docs/distill/changelog.html">Changelog</a>
@@ -562,7 +570,7 @@
<div class="column">
<h4 class="ui inverted header">About</h4>
<div class="ui inverted link list">
- <a class="item" href="/system">System</a>
+ <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>
@@ -572,10 +580,10 @@
<div class="column">
<h4 class="ui inverted header">Docs</h4>
<div class="ui inverted link list">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserAle.pyqt</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>
@@ -584,21 +592,21 @@
<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=senssoft">GitHub</a>
- <a class="item" href="http://stackoverflow.com/questions/tagged/apache-senssoft">StackOverflow</a>
- <a class="item" href="https://issues.apache.org/jira/browse/SENSSOFT">Jira Issue Tracker</a>
- <a class="item" href="https://cwiki.apache.org/confluence/display/SENSSOFT">Project Wiki</a>
- <a class="item" href="https://twitter.com/apachesenssoft">Twitter</a>
+ <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/licenses/LICENSE-2.0.html">License</a>
<a class="item" href="http://www.apache.org/">Apache Software Foundation</a>
- <a class="item" href="http://incubator.apache.org/">Apache Incubator</a>
- <a class="item" href="http://www.apache.org/foundation/sponsorship.html">Sponsor Apache</a>
- <a class="item" href="http://www.apache.org/foundation/thanks.html">Thank you</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>
@@ -606,12 +614,23 @@
<div class="ui inverted vertical segment">
<div class="ui two column middle aligned grid">
<div class="column">
- Apache SensSoft 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 th [...]
+ 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">
- <img class="component-image" src="/images/incubator-logo-white.png">
- <br>
- Copyright © 2017 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, and the Apache Incubator logo are trademarks of The Apache Software Foundation. Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc.
+ <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>
diff --git a/content/docs/distill/start.html b/content/docs/distill/start.html
index ccb3f2d..d4562fe 100644
--- a/content/docs/distill/start.html
+++ b/content/docs/distill/start.html
@@ -16,8 +16,8 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://localhost:4000/docs/distill/start.html">
- <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml">
+ <link rel="canonical" href="http://flagon.incubator.apache.org/docs/distill/start.html">
+ <link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
</head>
@@ -28,14 +28,14 @@
<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 SensSoft</h3>
+ <h3 class="ui inverted header item">Apache Flagon</h3>
</a>
<div class="right menu">
<div class="ui dropdown item">
Components
<div class="menu">
- <a class="item" href="/system">System</a>
+ <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>
@@ -45,10 +45,10 @@
<div class="ui dropdown item">
<a href="/docs">Docs</a>
<div class="menu">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserALE.pyqt</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>
@@ -81,7 +81,7 @@
<div class="title">
<i class="dropdown icon"></i>
- Apache SensSoft
+ Apache Flagon
</div>
<div class="content">
@@ -90,7 +90,7 @@
<a class="item" href="/docs/">About the Docs</a>
- <a class="item" href="/docs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/contributing/">Contributing</a>
</div>
</div>
@@ -100,14 +100,16 @@
<div class="title">
<i class="dropdown icon"></i>
- System
+ Stack
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/system/">Getting Started</a>
+ <a class="item" href="/docs/stack/">Getting Started</a>
+
+ <a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
</div>
</div>
@@ -141,9 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+
+ <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+
+ <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
- <a class="item" href="/docs/useralejs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+
+ <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
</div>
</div>
@@ -152,20 +160,20 @@
<div class="title">
<i class="dropdown icon"></i>
- UserALE.pyqt
+ UserALE.py
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/useralepyqt/">Installation</a>
+ <a class="item" href="/docs/useralepy/">Installation</a>
- <a class="item" href="/docs/useralepyqt/start.html">Getting Started</a>
+ <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
- <a class="item" href="/docs/useralepyqt/api.html">API Documentation</a>
+ <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
- <a class="item" href="/docs/useralepyqt/changelog.html">Changelog</a>
+ <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
</div>
</div>
@@ -187,13 +195,13 @@
<a class="item" href="/docs/distill/api.html">API Documentation</a>
- <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</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/analytics.html">Apache Distill Analytics</a>
+ <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a>
<a class="item" href="/docs/distill/changelog.html">Changelog</a>
@@ -261,7 +269,7 @@
<div class="column">
<h4 class="ui inverted header">About</h4>
<div class="ui inverted link list">
- <a class="item" href="/system">System</a>
+ <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>
@@ -271,10 +279,10 @@
<div class="column">
<h4 class="ui inverted header">Docs</h4>
<div class="ui inverted link list">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserAle.pyqt</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>
@@ -283,21 +291,21 @@
<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=senssoft">GitHub</a>
- <a class="item" href="http://stackoverflow.com/questions/tagged/apache-senssoft">StackOverflow</a>
- <a class="item" href="https://issues.apache.org/jira/browse/SENSSOFT">Jira Issue Tracker</a>
- <a class="item" href="https://cwiki.apache.org/confluence/display/SENSSOFT">Project Wiki</a>
- <a class="item" href="https://twitter.com/apachesenssoft">Twitter</a>
+ <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/licenses/LICENSE-2.0.html">License</a>
<a class="item" href="http://www.apache.org/">Apache Software Foundation</a>
- <a class="item" href="http://incubator.apache.org/">Apache Incubator</a>
- <a class="item" href="http://www.apache.org/foundation/sponsorship.html">Sponsor Apache</a>
- <a class="item" href="http://www.apache.org/foundation/thanks.html">Thank you</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>
@@ -305,12 +313,23 @@
<div class="ui inverted vertical segment">
<div class="ui two column middle aligned grid">
<div class="column">
- Apache SensSoft 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 th [...]
+ 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">
- <img class="component-image" src="/images/incubator-logo-white.png">
- <br>
- Copyright © 2017 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, and the Apache Incubator logo are trademarks of The Apache Software Foundation. Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc.
+ <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>
diff --git a/content/docs/distill/utilities.html b/content/docs/distill/utilities.html
index 8f84512..e688eac 100644
--- a/content/docs/distill/utilities.html
+++ b/content/docs/distill/utilities.html
@@ -16,8 +16,8 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://localhost:4000/docs/distill/utilities.html">
- <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml">
+ <link rel="canonical" href="http://flagon.incubator.apache.org/docs/distill/utilities.html">
+ <link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
</head>
@@ -28,14 +28,14 @@
<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 SensSoft</h3>
+ <h3 class="ui inverted header item">Apache Flagon</h3>
</a>
<div class="right menu">
<div class="ui dropdown item">
Components
<div class="menu">
- <a class="item" href="/system">System</a>
+ <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>
@@ -45,10 +45,10 @@
<div class="ui dropdown item">
<a href="/docs">Docs</a>
<div class="menu">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserALE.pyqt</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>
@@ -81,7 +81,7 @@
<div class="title">
<i class="dropdown icon"></i>
- Apache SensSoft
+ Apache Flagon
</div>
<div class="content">
@@ -90,7 +90,7 @@
<a class="item" href="/docs/">About the Docs</a>
- <a class="item" href="/docs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/contributing/">Contributing</a>
</div>
</div>
@@ -100,14 +100,16 @@
<div class="title">
<i class="dropdown icon"></i>
- System
+ Stack
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/system/">Getting Started</a>
+ <a class="item" href="/docs/stack/">Getting Started</a>
+
+ <a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
</div>
</div>
@@ -141,9 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+
+ <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+
+ <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
- <a class="item" href="/docs/useralejs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+
+ <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
</div>
</div>
@@ -152,20 +160,20 @@
<div class="title">
<i class="dropdown icon"></i>
- UserALE.pyqt
+ UserALE.py
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/useralepyqt/">Installation</a>
+ <a class="item" href="/docs/useralepy/">Installation</a>
- <a class="item" href="/docs/useralepyqt/start.html">Getting Started</a>
+ <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
- <a class="item" href="/docs/useralepyqt/api.html">API Documentation</a>
+ <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
- <a class="item" href="/docs/useralepyqt/changelog.html">Changelog</a>
+ <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
</div>
</div>
@@ -187,13 +195,13 @@
<a class="item" href="/docs/distill/api.html">API Documentation</a>
- <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</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/analytics.html">Apache Distill Analytics</a>
+ <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a>
<a class="item" href="/docs/distill/changelog.html">Changelog</a>
@@ -348,7 +356,7 @@
<div class="column">
<h4 class="ui inverted header">About</h4>
<div class="ui inverted link list">
- <a class="item" href="/system">System</a>
+ <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>
@@ -358,10 +366,10 @@
<div class="column">
<h4 class="ui inverted header">Docs</h4>
<div class="ui inverted link list">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserAle.pyqt</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>
@@ -370,21 +378,21 @@
<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=senssoft">GitHub</a>
- <a class="item" href="http://stackoverflow.com/questions/tagged/apache-senssoft">StackOverflow</a>
- <a class="item" href="https://issues.apache.org/jira/browse/SENSSOFT">Jira Issue Tracker</a>
- <a class="item" href="https://cwiki.apache.org/confluence/display/SENSSOFT">Project Wiki</a>
- <a class="item" href="https://twitter.com/apachesenssoft">Twitter</a>
+ <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/licenses/LICENSE-2.0.html">License</a>
<a class="item" href="http://www.apache.org/">Apache Software Foundation</a>
- <a class="item" href="http://incubator.apache.org/">Apache Incubator</a>
- <a class="item" href="http://www.apache.org/foundation/sponsorship.html">Sponsor Apache</a>
- <a class="item" href="http://www.apache.org/foundation/thanks.html">Thank you</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>
@@ -392,12 +400,23 @@
<div class="ui inverted vertical segment">
<div class="ui two column middle aligned grid">
<div class="column">
- Apache SensSoft 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 th [...]
+ 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">
- <img class="component-image" src="/images/incubator-logo-white.png">
- <br>
- Copyright © 2017 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, and the Apache Incubator logo are trademarks of The Apache Software Foundation. Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc.
+ <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>
diff --git a/content/docs/index.html b/content/docs/index.html
index a8b709b..4b5be6e 100644
--- a/content/docs/index.html
+++ b/content/docs/index.html
@@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>About the Docs</title>
- <meta name="description" content="The Apache SensSoft docs are organized by product. Each product’s documentation includes information like quick start guides, tutorials, full API description...">
+ <meta name="description" content="The Apache Flagon docs are organized by product. Each product’s documentation includes information like quick start guides, tutorials, full API descriptions,...">
<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,8 +16,8 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://localhost:4000/docs/">
- <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml">
+ <link rel="canonical" href="http://flagon.incubator.apache.org/docs/">
+ <link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
</head>
@@ -28,14 +28,14 @@
<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 SensSoft</h3>
+ <h3 class="ui inverted header item">Apache Flagon</h3>
</a>
<div class="right menu">
<div class="ui dropdown item">
Components
<div class="menu">
- <a class="item" href="/system">System</a>
+ <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>
@@ -45,10 +45,10 @@
<div class="ui dropdown item">
<a href="/docs">Docs</a>
<div class="menu">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserALE.pyqt</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>
@@ -81,7 +81,7 @@
<div class="active title">
<i class="dropdown icon"></i>
- Apache SensSoft
+ Apache Flagon
</div>
<div class="active content">
@@ -90,7 +90,7 @@
<a class="item" href="/docs/">About the Docs</a>
- <a class="item" href="/docs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/contributing/">Contributing</a>
</div>
</div>
@@ -100,14 +100,16 @@
<div class="title">
<i class="dropdown icon"></i>
- System
+ Stack
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/system/">Getting Started</a>
+ <a class="item" href="/docs/stack/">Getting Started</a>
+
+ <a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
</div>
</div>
@@ -141,9 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+
+ <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+
+ <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
- <a class="item" href="/docs/useralejs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+
+ <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
</div>
</div>
@@ -152,20 +160,20 @@
<div class="title">
<i class="dropdown icon"></i>
- UserALE.pyqt
+ UserALE.py
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/useralepyqt/">Installation</a>
+ <a class="item" href="/docs/useralepy/">Installation</a>
- <a class="item" href="/docs/useralepyqt/start.html">Getting Started</a>
+ <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
- <a class="item" href="/docs/useralepyqt/api.html">API Documentation</a>
+ <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
- <a class="item" href="/docs/useralepyqt/changelog.html">Changelog</a>
+ <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
</div>
</div>
@@ -187,13 +195,13 @@
<a class="item" href="/docs/distill/api.html">API Documentation</a>
- <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</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/analytics.html">Apache Distill Analytics</a>
+ <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a>
<a class="item" href="/docs/distill/changelog.html">Changelog</a>
@@ -238,7 +246,7 @@
</div>
<div class="docs-content">
<h2 class="ui header">About the Docs</h2>
- <p>The Apache SensSoft docs are organized by product. Each product’s documentation includes information like quick start guides, tutorials, full API descriptions, and contributing guides.</p>
+ <p>The Apache Flagon docs are organized by product. Each product’s documentation includes information like quick start guides, tutorials, full API descriptions, and contribution guides.</p>
</div>
</div>
@@ -251,7 +259,7 @@
<div class="column">
<h4 class="ui inverted header">About</h4>
<div class="ui inverted link list">
- <a class="item" href="/system">System</a>
+ <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>
@@ -261,10 +269,10 @@
<div class="column">
<h4 class="ui inverted header">Docs</h4>
<div class="ui inverted link list">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserAle.pyqt</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>
@@ -273,21 +281,21 @@
<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=senssoft">GitHub</a>
- <a class="item" href="http://stackoverflow.com/questions/tagged/apache-senssoft">StackOverflow</a>
- <a class="item" href="https://issues.apache.org/jira/browse/SENSSOFT">Jira Issue Tracker</a>
- <a class="item" href="https://cwiki.apache.org/confluence/display/SENSSOFT">Project Wiki</a>
- <a class="item" href="https://twitter.com/apachesenssoft">Twitter</a>
+ <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/licenses/LICENSE-2.0.html">License</a>
<a class="item" href="http://www.apache.org/">Apache Software Foundation</a>
- <a class="item" href="http://incubator.apache.org/">Apache Incubator</a>
- <a class="item" href="http://www.apache.org/foundation/sponsorship.html">Sponsor Apache</a>
- <a class="item" href="http://www.apache.org/foundation/thanks.html">Thank you</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>
@@ -295,12 +303,23 @@
<div class="ui inverted vertical segment">
<div class="ui two column middle aligned grid">
<div class="column">
- Apache SensSoft 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 th [...]
+ 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">
- <img class="component-image" src="/images/incubator-logo-white.png">
- <br>
- Copyright © 2017 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, and the Apache Incubator logo are trademarks of The Apache Software Foundation. Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc.
+ <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>
diff --git a/content/docs/stack/index.html b/content/docs/stack/index.html
new file mode 100644
index 0000000..e71a83a
--- /dev/null
+++ b/content/docs/stack/index.html
@@ -0,0 +1,393 @@
+<!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>Getting Started</title>
+ <meta name="description" content="The Apache Flagon project provides a streamlined deployment solution for including behavioral logging capabilities in your project and for monitoring and ana...">
+
+ <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/stack/">
+ <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">
+ Components
+ <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="active title">
+
+ <i class="dropdown icon"></i>
+ Stack
+ </div>
+
+ <div class="active 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="title">
+
+ <i class="dropdown icon"></i>
+ UserALE.js
+ </div>
+
+ <div class="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/API.html">UserALE.js API</a>
+
+ <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+
+ <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+
+ <a class="item" href="/docs/useralejs/troubleshooting.html">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">Getting Started</h2>
+ <p>The Apache Flagon project provides a streamlined deployment solution for including behavioral logging capabilities in your project and for monitoring and analyzing your log data in a containerized Elastic backend. Our Docker container includes an Elastic backend, pre-configured, interactive Kibana dashboards. The container also includes prototype applications for exploration, Apache Distill and Apache Tap.</p>
+
+<p>Before you begin, you’ll need <a href="https://nodejs.org/">NPM and Node.js</a>, <a href="https://www.docker.com/">Docker</a> and <a href="https://docs.docker.com/compose/install/">Docker Compose</a> installed before you start.</p>
+
+<h3 id="building-and-deploying-useralejs">Building and Deploying UserALE.js</h3>
+
+<p><a href="https://github.com/apache/incubator-flagon-useralejs">Apache UserALE.js</a> is the Apache Flagon’s thin-client behavioral logging solution. Below, you’ll find short-hand instructions for getting started with UserALE.js. For complete instructions, see our <a href="https://github.com/apache/incubator-flagon-useralejs/blob/master/README.md">README</a>.</p>
+
+<p>First, download the <a href="http://flagon.incubator.apache.org/releases/">release</a> or clone our <a href="https://github.com/apache/incubator-flagon-useralejs/tree/master">repo on GitHub</a>. Apache UserALE.js is also available as an <a href="https://www.npmjs.com/package/useralejs">NPM package</a>.</p>
+
+<p>Next, <strong>install Dependencies</strong>.</p>
+<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="c">#intall NPM packages into build directory</span>
+ <span class="nv">$ </span>npm install
+</code></pre>
+</div>
+
+<p>Then, <strong>build UserALE.js</strong>.</p>
+<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="c">#produce UserALE.js build artifacts</span>
+ <span class="nv">$ </span>npm run build
+</code></pre>
+</div>
+
+<p>The build process produces a minified version of UserALE.js and a Web Extension package, giving you two options depending on your needs. You can skip the build process if you just want to explore UserALE.js; just use the minified script found in our <a href="https://github.com/apache/incubator-flagon-useralejs/tree/master/build">repo</a>.</p>
+
+<p><strong>Option 1: Include Apache UserALE.js in your project:</strong></p>
+
+<div class="language-markdown highlighter-rouge"><pre class="highlight"><code> #include userale in your project via script tag
+ <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>
+<p>Apache UserALE.js allows for configuration via HTML 5 data parameters. For a complete list of options, see the <a href="/docs/useralejs">docs</a> or the <a href="https://github.com/apache/incubator-flagon-useralejs/blob/master/README.md">README</a>. You can also modify Apache UserALE.js using our API. Find examples in our <a href="https://github.com/apache/incubator-flagon-useralejs/tree/FLAGON-192">repos</a>.</p>
+
+<p><strong>Option 2: Follow the <a href="https://github.com/apache/incubator-flagon-useralejs/tree/FLAGON-192/src/UserALEWebExtension">instructions</a> to install the Apache UserALE.js web extension into your browser.</strong></p>
+
+<p>You can now start generating behavioral log data from your page, or through your browser. To view these logs, you can either utilize our <a href="https://github.com/apache/incubator-flagon-useralejs/tree/master/example">example logging server</a> and log to file, or you can log directly to our Elastic backend. For complete instructions, see the <a href="https://github.com/apache/incubator-flagon/tree/master/docker">README</a></p>
+<h3 id="building-and-using-the-elastic-backend">Building and Using the Elastic Backend</h3>
+
+<p><a href="https://github.com/apache/incubator-flagon">Apache Flagon</a> utilizes an Elastic stack for transforming, indexing, and storing log data. With Elastic, you’ll not only have the ability to search and query log dat, but you’ll also be able to monitor it and visualize it through Kibana.</p>
+
+<p>To build our single-node Elastic instance, <strong>first clone our <a href="https://github.com/apache/incubator-flagon/tree/master/docker">Docker repo</a></strong>. Note that for production-level deployments, you should probably check out our <a href="https://github.com/apache/incubator-flagon/tree/master/kubernetes">Kubernetes build</a> and our <a href="/docs/stack/scaling">guide for scaling</a>).</p>
+
+<p>Then, <strong>start up a virtual machine</strong>.</p>
+<div class="language-shell highlighter-rouge"><pre class="highlight"><code><span class="c"># start virtual machine and requisite network </span>
+<span class="gp">$ </span>docker-machine create --virtualbox-memory 3072 --virtualbox-cpu-count 2 senssoft
+<span class="gp">$ </span>docker-machine ssh senssoft sudo sysctl -w vm.max_map_count<span class="o">=</span>262144
+<span class="gp">$ </span>docker network create esnet
+</code></pre>
+</div>
+<p>Next, <strong>start Elastic services</strong>.</p>
+
+<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="c">#start Elastic services</span>
+ <span class="nv">$ </span>docker-compose up -d elasticsearch
+ <span class="nv">$ </span>docker-compuse up -d logstash
+ <span class="nv">$ </span>docker-compose up -d kibana
+</code></pre>
+</div>
+<p><strong>Configure UserALE.js</strong> to send logs to localhost:8100. This is easy: either modify the script tag for port 8100 or open up the “options” tab of the web extension and enter localhost:8100 as your logging end-point.</p>
+
+<p>Before starting Kibana, <strong>generate some logs</strong>. Move your mouse around, click around, etc. Do this for a couple minutes to populate the index.</p>
+
+<p>Finally, <strong>navigate to localhost:5601 (Kibaba), set an index pattern, and load our visualizations and dashboards</strong> to see your logs. Find simple instructions in our <a href="https://github.com/apache/incubator-flagon/tree/master/docker">README</a>.</p>
+
+<p>Subscribe to our <a href="dev-subscribe@flagon.incubator.apache.org">dev list</a> and join the conversation!</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/stack/scaling/index.html b/content/docs/stack/scaling/index.html
new file mode 100644
index 0000000..b58dc5d
--- /dev/null
+++ b/content/docs/stack/scaling/index.html
@@ -0,0 +1,618 @@
+<!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>Scaling Considerations</title>
+ <meta name="description" content="Scaling Apache Flagon: An Introduction and First Principles">
+
+ <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/stack/scaling/">
+ <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">
+ Components
+ <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="active title">
+
+ <i class="dropdown icon"></i>
+ Stack
+ </div>
+
+ <div class="active 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="title">
+
+ <i class="dropdown icon"></i>
+ UserALE.js
+ </div>
+
+ <div class="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/API.html">UserALE.js API</a>
+
+ <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+
+ <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+
+ <a class="item" href="/docs/useralejs/troubleshooting.html">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">Scaling Considerations</h2>
+ <h3 id="scaling-apache-flagon-an-introduction-and-first-principles">Scaling Apache Flagon: An Introduction and First Principles</h3>
+
+<p>This guide touches on some basic principles to keep in mind as you’re planning for scale with <a href="https://github.com/apache/incubator-flagon">Apache Flagon</a>. We provide some high-level guidance and considerations for working with an Elastic stack to scale Flagon that are unique to <a href="/docs/useralejs">Apache UserALE.js</a> data. We also walk through some of our benchmarking tools and methodologies, so that you walk into discussions about scale with some accurate assumptio [...]
+
+<p><strong>“It Depends…“</strong></p>
+
+<p>The best way to scale Apache Flagon depends entirely on your use-case: how you’ll use your Apache UserALE.js data and which <a href="/docs/useralejs/dataschema">UserALE.js data streams</a> you’ll use. This page provides a few Apache Flagon-specific considerations to think about as you decide how best to scale, and some useful methods for benchmarking to help you make that determination.</p>
+
+<p><strong>The Apache Flagon Single-Node Elastic Container is an Ingredient, Not a Whole Solution</strong></p>
+
+<p>The single-node Elastic (ELK) stack in the Docker container distributed by <a href="/docs/stack">Apache Flagon</a> is not alone suitable for most production-level use-cases. It may be suitable on its own, for “grab-and-go” user-testing use cases, for example. This would entail just a few days of data collection from a specific application, from just a few users. But, alone it will fail quickly for most persistent data collection uses and enterprise-scale use-cases. Rather, this contai [...]
+
+<ol>
+ <li>Our ELK .yml config files for our Docker container can be used as the building-blocks for your very own <a href="https://dzone.com/articles/elasticsearch-tutorial-creating-an-elasticsearch-c">multi-node cluster</a> with load-balancing capabilities.</li>
+ <li>You can use our <a href="https://github.com/apache/incubator-flagon/tree/master/kubernetes">Kubernetes build</a>, which relies on our Docker assets, to scale your Apache Flagon stack to meet your needs.</li>
+ <li>You can use our single-node container to scale out in <a href="https://aws.amazon.com/elasticbeanstalk/">AWS Elastic Beanstalk (EBS)</a>.</li>
+</ol>
+
+<p><strong>Apache Flagon Data Also Scales</strong></p>
+
+<p>It’s important to note that the burden of scale isn’t placed wholly on your Apache Flagon stack. Flagon’s behavioral logging capability, <a href="/docs/useralejs">Apache UserALE.js</a> also scales. This means that one of the most cost-efficient ways to manage the resources behind your Apache Flagon stack, is to <a href="/docs/useralejs/API">configure</a> or <a href="/docs/useralejs/modifying">modify</a> UserALE.js to meet your use-case.</p>
+<h3 id="sizing-up-an-elastic-stack">Sizing Up an Elastic Stack</h3>
+
+<p>When thinking about how to scale your Apache Flagon Elastic stack, it’s important to note that Elasticsearch isn’t a database, its a datastore, which stores documents. Elastic is built on top of <a href="http://lucene.apache.org/">Lucene</a>. That means that Apache Flagon “logs” aren’t logs once they’re indexed in Elastic, they become searchable documents. That’s a huge strength (and why we chose Elastic), but it also means that assumptions about resource consumptions based purely on [...]
+
+<ol>
+ <li>
+ <p>Given that documents are the atomic unit of storage in Elastic, <em>document generation rate</em> is the most important consideration to scaling. Default <a href="/docs/useralejs">Apache UserALE.js parameters</a> produce a lot of <a href="/docs/useralejs/dataschema">data</a>, even from single users in Apache UserALE.js. In fact, we used say that “drinking from the fire-hose” didn’t quite do our data-rate justice–we used to say that opening up UserALE.js was more like “drinking fro [...]
+ </li>
+ <li>Your Elastic resource needs will also grow with <em>document length</em>, especially the length of <a href="https://blog.appdynamics.com/product/estimating-costs-of-storing-documents-in-elasticsearch/">strings</a> within your logs (see also <a href="https://www.elastic.co/guide/en/elasticsearch/reference/5.5/tune-for-disk-usage.html#_use_literal_best_compression_literal">Elastic’s tips on indexing strings</a>). One of the discriminating features of Apache UserALE.js is its precisio [...]
+ <div class="language-shell highlighter-rouge"><pre class="highlight"><code> ...
+ <span class="s2">"pageTitle"</span>: <span class="s2">"Discover - Kibana"</span>,
+ <span class="s2">"toolName"</span>: <span class="s2">"test_app"</span>,
+ <span class="s2">"userId"</span>: <span class="s2">"nobody"</span>,
+ <span class="s2">"type"</span>: <span class="s2">"click"</span>,
+ <span class="s2">"target"</span>: <span class="s2">"a.kuiButton kuiButton--small kuiButton--secondary"</span>,
+ <span class="s2">"path"</span>: <span class="o">[</span>
+ <span class="s2">"a.kuiButton kuiButton--small kuiButton--secondary"</span>,
+ <span class="s2">"div.kbnDocTableDetails__actions"</span>,
+ <span class="s2">"td"</span>,
+ <span class="s2">"tr"</span>,
+ <span class="s2">"tbody"</span>,
+ <span class="s2">"table.kbn-table table"</span>,
+ <span class="s2">"div.kbnDocTable__container"</span>,
+ <span class="s2">"doc-table"</span>,
+ <span class="s2">"section.dscTable"</span>,
+ <span class="s2">"div.dscResults"</span>,
+ <span class="s2">"div.dscWrapper__content"</span>,
+ <span class="s2">"div.dscWrapper col-md-10"</span>,
+ <span class="s2">"div.row"</span>,
+ <span class="s2">"main.container-fluid"</span>,
+ <span class="s2">"discover-app.app-container"</span>,
+ <span class="s2">"div.application tab-discover"</span>,
+ <span class="s2">"div.app-wrapper-panel"</span>,
+ <span class="s2">"div.app-wrapper"</span>,
+ <span class="s2">"div.content"</span>,
+ <span class="s2">"div#kibana-body"</span>,
+ <span class="s2">"body#kibana-app.coreSystemRootDomElement"</span>,
+ <span class="s2">"html"</span>,
+ <span class="s2">"#document"</span>,
+ <span class="s2">"Window"</span>
+ ...
+</code></pre>
+ </div>
+ </li>
+ <li>Apache Flagon is built to scale as a platform, allowing you to connect additional services to your platform that consume user behavioral data. When considering scale, the <em>number of services</em> you connect to your Apache Flagon platform will affect your Elastic stacks’ performance. Any production-level deployment will require, at minimum a simple three-node <a href="https://dzone.com/articles/elasticsearch-tutorial-creating-an-elasticsearch-c">Elastic cluster</a> (with one loa [...]
+</ol>
+
+<p>For the reasons above, its really critical to do some benchmarking for your use-case prior to deciding on a scaling strategy. Below, you’ll find some guidance for how to do this with Apache Flagon and Elastic tools. We also provide some simple benchmarks and underlying assumptions. However, each webpage or application is a bit different, so it’s important create some of your own benchmarks for comparison with ours.</p>
+<h3 id="benchmarking-tools-and-methods-for-sizing-your-apache-flagon-stack">Benchmarking Tools and Methods for Sizing your Apache Flagon Stack</h3>
+
+<p>Benchmarking with Elastic isn’t as straight forward as figuring out an average log size in bytes and then calculating how many logs per second. The size of Apache UserALE.js logs is too variable (see above) within pages and across log types. Additionally, a single log may actually be indexed as separate, nested documents in Elastic. Moreover, Elastic doesn’t really ‘think’ at the document-level, they think about <em>indexes</em>.</p>
+
+<p>This guide outlines a set of tools and steps for running your own benchmarking study using Flagon’s <a href="/docs/stack">single-node container</a></p>
+
+<p>To generate log data, we’ll be using our <a href="https://github.com/apache/incubator-flagon-useralejs/tree/master/example">UserALE.js Example</a> test kit. This is a useful test utility that makes it easy to <a href="/docs/useralejs/modifying">modify</a> UserALE.js HTML5 and API parameters on the fly. Again, for your own purposes, you’ll want to experiment with your own page/application for more accurate benchmarks.</p>
+
+<ol>
+ <li>
+ <p><strong>Start up the Apache Flagon Elastic Stack (detailed instructions <a href="https://github.com/apache/incubator-flagon/tree/master/docker">here</a>).</strong></p>
+
+ <p>Important: as noted in the instructions, you’ll need to have collected some log data to establish the index.</p>
+ </li>
+ <li><strong>Once you’ve started up Elasticsearch, Logstash, Kibana, and metricbead, and confirm that you can see logs in Kibana, take a look at the <code class="highlighter-rouge">userale</code> index stats.</strong>
+ <div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="c">#Index Stats using Elastic's _stats API</span>
+ <span class="nv">$ </span>curl localhost:9200/index_name/_stats?pretty<span class="o">=</span><span class="nb">true</span>
+
+ <span class="c">#Tailored for Apache Flagon default settings</span>
+ <span class="nv">$ </span>curl localhost:9200/userale/_stats?pretty<span class="o">=</span><span class="nb">true</span>
+
+ <span class="c">#Or, view in your browser</span>
+ http://localhost:9200/userale/_stats?pretty<span class="o">=</span><span class="nb">true</span>
+</code></pre>
+ </div>
+ <p>Find the <code class="highlighter-rouge">indices</code> portion of the output. It looks like this (#note annotations):</p>
+ <div class="language-shell highlighter-rouge"><pre class="highlight"><code> ...
+ <span class="s2">"indices"</span> : <span class="o">{</span>
+ <span class="s2">"userale"</span> : <span class="o">{</span> <span class="c">#this is the index UserALE.js logs write to</span>
+ <span class="s2">"uuid"</span> : <span class="s2">"0h0Wxe2cSwqMALs4QCJ8Tw"</span>,
+ <span class="s2">"primaries"</span> : <span class="o">{</span>
+ <span class="s2">"docs"</span> : <span class="o">{</span>
+ <span class="s2">"count"</span> : 1284, <span class="c">#this is the total # of documents in the userale index</span>
+ <span class="s2">"deleted"</span> : 0
+ <span class="o">}</span>,
+ <span class="s2">"store"</span> : <span class="o">{</span>
+ <span class="s2">"size_in_bytes"</span> : 241212 <span class="c">#this is size of the index in bytes (.24 MB).</span>
+ ...
+</code></pre>
+ </div>
+ <p>Let’s call this value a baseline for your benchmarking.</p>
+
+ <p>As you continue your benchmarking, the <code class="highlighter-rouge">userale</code> index “size_in_bytes” will be one of your key metrics.</p>
+ </li>
+ <li>
+ <p><strong>Next, let’s see how much data UserALE.js produces with parameters set to default on your page or app.</strong> We’ll call this: “drinking from the flame-thrower”.</p>
+
+ <p>Drop in a UserALE.js script-tag into your project (see <a href="/docs/useralejs">instructions</a>).</p>
+
+ <p>Here is an example of the script tag (with <code class="highlighter-rouge">settings</code>) we’re using in the UserALE.js Example page for this test:</p>
+ <div class="highlighter-rouge"><pre class="highlight"><code> <script
+ src="file:/// ... /UserALEtest/userale-1.1.0.min.js"
+ data-url="http://localhost:8100/"
+ data-user="example-user"
+ data-version="1.1.1"
+ data-tool="Apache UserALE.js Example"
+ ></script>
+</code></pre>
+ </div>
+ <p>To get a conservative upper-bound, generate as many behaviors in your page/app as you can (go nuts with mouse-overs, clicks and scrolls).</p>
+
+ <p>We did just that for 5 minutes solid. Here’s what our <code class="highlighter-rouge">userale</code> index looks now (#note annotations):</p>
+
+ <div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="s2">"indices"</span> : <span class="o">{</span>
+ <span class="s2">"userale"</span> : <span class="o">{</span>
+ <span class="s2">"uuid"</span> : <span class="s2">"0h0Wxe2cSwqMALs4QCJ8Tw"</span>,
+ <span class="s2">"primaries"</span> : <span class="o">{</span>
+ <span class="s2">"docs"</span> : <span class="o">{</span>
+ <span class="s2">"count"</span> : 3282, <span class="c">#new userale document count</span>
+ <span class="s2">"deleted"</span> : 0
+ <span class="o">}</span>,
+ <span class="s2">"store"</span> : <span class="o">{</span>
+ <span class="s2">"size_in_bytes"</span> : 820978 <span class="c">#new size of the index (.82 MB)</span>
+</code></pre>
+ </div>
+ <p><strong>Some simple math gives +1,998 documents (2000) and +579,866 bytes (.58 MB) generated with UserALE.js by one user in 5 mins</strong>. Continuing our ultra-conservative benchmarking, lets assume this data generation rate over an 8 hour period each day, which gives <strong>~56 MB per day</strong>. At 20 working days in an average month, that gives <strong>1.1 GB per month</strong>.</p>
+
+ <p>Again, <strong>this is ultra-conservative</strong>; no one uses pages or applications this way (even games). That’s a lot of data for a single-user, but these are valuable, worst-case-scenario upper-bounds to start with.</p>
+
+ <p>If you’re a scientist or researcher, these figures might be fine, especially if you want to pour over this data. If you’re just interested in how people are moving through your content, this is probably overkill. The biggest culprit: take a look at our <code class="highlighter-rouge">Apache Flagon Page Usage Dashboard</code> to see.</p>
+
+ <p><img src="https://github.com/apache/incubator-flagon/blob/FLAGON-344/site/_site/images/mouseOverBench1.png" alt="alt text" title="Proportion of Mouseovers (Benchmark 1)" /></p>
+
+ <p>Mouseovers accounted for a lot of the data we just produced. Raw mouseover data is written to log very frequently and generates a lot of documents in Elastic.</p>
+ </li>
+ <li>
+ <p><strong>Now, let’s take the simplest approach to scaling back UserALE.js and see how this changes your data generation rate</strong>.</p>
+
+ <p>What we’re doing is using the UserALE.js <code class="highlighter-rouge">settings</code> that can be passed through the script tag to effectively “downsample” certain channels (e.g., mouseovers) that generate a lot of documents quickly.</p>
+
+ <p>Here’s what our script tag looks like now:</p>
+ <div class="highlighter-rouge"><pre class="highlight"><code> <script
+ src="file:/// ... /UserALEtest/userale-1.1.0.min.js"
+ data-url="http://localhost:8100/"
+ data-user="example-user"
+ data-version="1.1.1"
+ data-resolution=1000 #We've increased the delay between collection of "high-resolution" events (e.g., mouseover, scrolls) by 100% (default is 500 (ms)).
+ data-tool="Apache UserALE.js Example"
+ ></script>
+</code></pre>
+ </div>
+ <p>Next, replicate your benchmarking, behaving in a similar way for the same amount of time.</p>
+
+ <p>Here’s what our <code class="highlighter-rouge">userale</code> index looks like now after another 5 minutes of vigorous behavior.</p>
+
+ <div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="s2">"indices"</span> : <span class="o">{</span>
+ <span class="s2">"userale"</span> : <span class="o">{</span>
+ <span class="s2">"uuid"</span> : <span class="s2">"0h0Wxe2cSwqMALs4QCJ8Tw"</span>,
+ <span class="s2">"primaries"</span> : <span class="o">{</span>
+ <span class="s2">"docs"</span> : <span class="o">{</span>
+ <span class="s2">"count"</span> : 4800, <span class="c">#new userale document count</span>
+ <span class="s2">"deleted"</span> : 0
+ <span class="o">}</span>,
+ <span class="s2">"store"</span> : <span class="o">{</span>
+ <span class="s2">"size_in_bytes"</span> : 115978 <span class="c">#new size of the index (1.1 MB) </span>
+</code></pre>
+ </div>
+ <p><strong>Maths give us +1518 documents (500 fewer than our first benchmark) and +295,000 bytes (.30 MB; ~40% less growth in the store size than previous) generated by one user in 5 minutes.</strong> That would be <strong>28.8 MB per day</strong> or <strong>~576 MB per working month</strong>, per user. We’ve cut down our data generation considerably by modifying one parameter in our script tag.</p>
+
+ <p>Why? look at the new proportion of mouseover events… we shaved those down by ~50%. As that event stream has the highest data generation, net-net we generated about 25% fewer documents with the same amount and duration of behavior:</p>
+
+ <p><img src="https://github.com/apache/incubator-flagon/blob/FLAGON-344/site/_site/images/mouseOverBench2.png" alt="alt text" title="Proportion of Mouseovers (Benchmark 2)" /></p>
+ </li>
+ <li>
+ <p><strong>Still too much data? Below are some other things that you can do to curb the growth of your <code class="highlighter-rouge">userale</code> index</strong> as you continue benchmarking with your page/app.</p>
+
+ <ul>
+ <li>If you don’t need all the different types of events UserALE.js gathers by default, you can easily curate the list of events you by modifying <a href="https://github.com/apache/incubator-flagon-useralejs/tree/master/src">UserALE.js source</a> (<code class="highlighter-rouge">attachHandlers.js</code>), then build a custom UserALE.js script.</li>
+ <li>If you don’t need both raw logs (specific records of events) and interval logs (aggregates of specific events over a time interval), you can easily drop intervals by modifying UserALE.js <a href="https://github.com/apache/incubator-flagon-useralejs/tree/master/src">UserALE.js source</a> (<code class="highlighter-rouge">attachHandlers.js</code> or <code class="highlighter-rouge">packageLogs.js</code>), then build a custom UserALE.js script.</li>
+ <li>You can reduce the number of meta-data fields written to each UserALE.js log, by modifying <a href="https://github.com/apache/incubator-flagon-useralejs/tree/master/src">UserALE.js source</a> (<code class="highlighter-rouge">packageLogs.js</code>), then build a custom UserALE.js script.</li>
+ <li>If you want different levels of logging granularity (more or less data) for different pages within your site/app, you can build different versions of UserALE.js to service different pages. Just name each version differently and point to the one you want with script-tags, page-by-page.</li>
+ <li>You can use our <a href="/docs/useralejs/API">API</a> for surgical precision in how specific elements (targets) on your page generate data.</li>
+ </ul>
+ </li>
+</ol>
+
+<h3 id="other-tools-to-support-benchmarking-for-scaling">Other Tools to Support Benchmarking for Scaling</h3>
+
+<ol>
+ <li>
+ <p>In our benchmarking guide, we primarily used <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-stats.html">Elastic’s <code class="highlighter-rouge">Stats</code> API</a>. This provides very verbose output, which is pretty useful for understanding all of your indexes, indexing behavior, and how data is being distributed across nodes. You can use other <a href="https://www.datadoghq.com/blog/collect-elasticsearch-metrics/#index-stats-api">Elastic APIs< [...]
+
+ <p>http://localhost:9200/_cat/indices?format=json&bytes=b&pretty</p>
+
+ <p>Output is very simple and index sizes stack on top of one another</p>
+ <div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="o">[</span>
+ <span class="o">{</span>
+ <span class="s2">"health"</span> : <span class="s2">"green"</span>,
+ <span class="s2">"status"</span> : <span class="s2">"open"</span>,
+ <span class="s2">"index"</span> : <span class="s2">".kibana_1"</span>,
+ <span class="s2">"uuid"</span> : <span class="s2">"FnI_6AQYQEWp2mIxSlM8HQ"</span>,
+ <span class="s2">"pri"</span> : <span class="s2">"1"</span>,
+ <span class="s2">"rep"</span> : <span class="s2">"0"</span>,
+ <span class="s2">"docs.count"</span> : <span class="s2">"184"</span>,
+ <span class="s2">"docs.deleted"</span> : <span class="s2">"13"</span>,
+ <span class="s2">"store.size"</span> : <span class="s2">"366457"</span>,
+ <span class="s2">"pri.store.size"</span> : <span class="s2">"366457"</span>
+ <span class="o">}</span>,
+ <span class="o">{</span>
+ <span class="s2">"health"</span> : <span class="s2">"yellow"</span>,
+ <span class="s2">"status"</span> : <span class="s2">"open"</span>,
+ <span class="s2">"index"</span> : <span class="s2">"metricbeat-6.6.2-2019.04.22"</span>,
+ <span class="s2">"uuid"</span> : <span class="s2">"pDYNmzsxTFu9Z0Tc1_GdLw"</span>,
+ <span class="s2">"pri"</span> : <span class="s2">"5"</span>,
+ <span class="s2">"rep"</span> : <span class="s2">"1"</span>,
+ <span class="s2">"docs.count"</span> : <span class="s2">"4687"</span>,
+ <span class="s2">"docs.deleted"</span> : <span class="s2">"0"</span>,
+ <span class="s2">"store.size"</span> : <span class="s2">"6309920"</span>,
+ <span class="s2">"pri.store.size"</span> : <span class="s2">"6309920"</span>
+ <span class="o">}</span>,
+ <span class="o">{</span>
+ <span class="s2">"health"</span> : <span class="s2">"green"</span>,
+ <span class="s2">"status"</span> : <span class="s2">"open"</span>,
+ <span class="s2">"index"</span> : <span class="s2">"userale"</span>,
+ <span class="s2">"uuid"</span> : <span class="s2">"0h0Wxe2cSwqMALs4QCJ8Tw"</span>,
+ <span class="s2">"pri"</span> : <span class="s2">"1"</span>,
+ <span class="s2">"rep"</span> : <span class="s2">"0"</span>,
+ <span class="s2">"docs.count"</span> : <span class="s2">"14018"</span>,
+ <span class="s2">"docs.deleted"</span> : <span class="s2">"0"</span>,
+ <span class="s2">"store.size"</span> : <span class="s2">"2235963"</span>,
+ <span class="s2">"pri.store.size"</span> : <span class="s2">"2235963"</span>
+ <span class="o">}</span>,
+ <span class="o">{</span>
+ <span class="s2">"health"</span> : <span class="s2">"yellow"</span>,
+ <span class="s2">"status"</span> : <span class="s2">"open"</span>,
+ <span class="s2">"index"</span> : <span class="s2">"metricbeat-6.6.2-2019.04.27"</span>,
+ <span class="s2">"uuid"</span> : <span class="s2">"wTyUBXvNRMOwpR4lDF9BNA"</span>,
+ <span class="s2">"pri"</span> : <span class="s2">"5"</span>,
+ <span class="s2">"rep"</span> : <span class="s2">"1"</span>,
+ <span class="s2">"docs.count"</span> : <span class="s2">"107124"</span>,
+ <span class="s2">"docs.deleted"</span> : <span class="s2">"0"</span>,
+ <span class="s2">"store.size"</span> : <span class="s2">"63263644"</span>,
+ <span class="s2">"pri.store.size"</span> : <span class="s2">"63263644"</span>
+ <span class="o">}</span>
+ <span class="o">]</span>
+</code></pre>
+ </div>
+ </li>
+ <li>
+ <p>There are a lot of other things going on inside your Apache Flagon Elastic stack. Note above that depending on what you deploy (e.g., metricbeat) you may have additional indices that need monitoring. For one, Metricbeat indices grow fast and you’ll want to benchmark that too. The Kibana index will grow as well, but not as much; it depends on how how many additional objects you build (e.g., visualizations, indicies, dashboards). Both the <code class="highlighter-rouge">STATS</code> [...]
+ </li>
+ <li>
+ <p>There are also a lot of things going on inside your server or Docker containers, depending on how you deploy your Apache Flagon Elastic Stack. This is why we’ve configured a metricbeat service to run with Flagon. In the same way that you can benchmark your data generation rate while you generate behavioral logs in your page/app, you can also look at how your Apache Flagon stack is utilizing disk and compute resources. When you spin up our single-node Apache Flagon container, make [...]
+
+ <p><img src="https://github.com/apache/incubator-flagon/blob/FLAGON-344/site/_site/images/metricBeat.png" alt="alt text" title="Metricbeat Dashboard" /></p>
+ </li>
+</ol>
+
+<h3 id="wonky-things-that-can-and-will-happen-as-you-benchmark">Wonky Things that Can and Will Happen as You Benchmark</h3>
+
+<ol>
+ <li>You just finished a benchmarking session after modifying UserALE.js to produce less data. What you find is that your new store size is either dramatically bigger than your last benchmark or smaller (which should be impossible). What happened is a thing called <a href="https://www.elastic.co/guide/en/elasticsearch/guide/current/merge-process.html">merging</a>. It is a good thing, but it can be a confusing thing while you’re benchmarking against your store size. Essentially, each Ela [...]
+</ol>
+
+<h3 id="summary">Summary</h3>
+<p>Benchmarking and adjusting your data-rate so that you can scale how you want to is made very easy in Apache Flagon. We combine easily deployed and modified capabilities with the power of Elastic’s APIs and visualization capabilities. Again, our single-node container is not a scaling solution. It’s an ingredient, a potent one, that not only serves as the building block for your cluster, but also a benchmarking tool so that your Apache Flagon cluster meets your needs for capability, sca [...]
+
+<p>Subscribe to our <a href="dev-subscribe@flagon.incubator.apache.org">dev list</a> and join the conversation!</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/stout/index.html b/content/docs/stout/index.html
index 81599f4..13b6ac9 100644
--- a/content/docs/stout/index.html
+++ b/content/docs/stout/index.html
@@ -16,8 +16,8 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://localhost:4000/docs/stout/">
- <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml">
+ <link rel="canonical" href="http://flagon.incubator.apache.org/docs/stout/">
+ <link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
</head>
@@ -28,14 +28,14 @@
<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 SensSoft</h3>
+ <h3 class="ui inverted header item">Apache Flagon</h3>
</a>
<div class="right menu">
<div class="ui dropdown item">
Components
<div class="menu">
- <a class="item" href="/system">System</a>
+ <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>
@@ -45,10 +45,10 @@
<div class="ui dropdown item">
<a href="/docs">Docs</a>
<div class="menu">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserALE.pyqt</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>
@@ -81,7 +81,7 @@
<div class="title">
<i class="dropdown icon"></i>
- Apache SensSoft
+ Apache Flagon
</div>
<div class="content">
@@ -90,7 +90,7 @@
<a class="item" href="/docs/">About the Docs</a>
- <a class="item" href="/docs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/contributing/">Contributing</a>
</div>
</div>
@@ -100,14 +100,16 @@
<div class="title">
<i class="dropdown icon"></i>
- System
+ Stack
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/system/">Getting Started</a>
+ <a class="item" href="/docs/stack/">Getting Started</a>
+
+ <a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
</div>
</div>
@@ -141,9 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+
+ <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+
+ <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
- <a class="item" href="/docs/useralejs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+
+ <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
</div>
</div>
@@ -152,20 +160,20 @@
<div class="title">
<i class="dropdown icon"></i>
- UserALE.pyqt
+ UserALE.py
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/useralepyqt/">Installation</a>
+ <a class="item" href="/docs/useralepy/">Installation</a>
- <a class="item" href="/docs/useralepyqt/start.html">Getting Started</a>
+ <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
- <a class="item" href="/docs/useralepyqt/api.html">API Documentation</a>
+ <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
- <a class="item" href="/docs/useralepyqt/changelog.html">Changelog</a>
+ <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
</div>
</div>
@@ -187,13 +195,13 @@
<a class="item" href="/docs/distill/api.html">API Documentation</a>
- <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</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/analytics.html">Apache Distill Analytics</a>
+ <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a>
<a class="item" href="/docs/distill/changelog.html">Changelog</a>
@@ -271,7 +279,7 @@
<div class="column">
<h4 class="ui inverted header">About</h4>
<div class="ui inverted link list">
- <a class="item" href="/system">System</a>
+ <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>
@@ -281,10 +289,10 @@
<div class="column">
<h4 class="ui inverted header">Docs</h4>
<div class="ui inverted link list">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserAle.pyqt</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>
@@ -293,21 +301,21 @@
<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=senssoft">GitHub</a>
- <a class="item" href="http://stackoverflow.com/questions/tagged/apache-senssoft">StackOverflow</a>
- <a class="item" href="https://issues.apache.org/jira/browse/SENSSOFT">Jira Issue Tracker</a>
- <a class="item" href="https://cwiki.apache.org/confluence/display/SENSSOFT">Project Wiki</a>
- <a class="item" href="https://twitter.com/apachesenssoft">Twitter</a>
+ <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/licenses/LICENSE-2.0.html">License</a>
<a class="item" href="http://www.apache.org/">Apache Software Foundation</a>
- <a class="item" href="http://incubator.apache.org/">Apache Incubator</a>
- <a class="item" href="http://www.apache.org/foundation/sponsorship.html">Sponsor Apache</a>
- <a class="item" href="http://www.apache.org/foundation/thanks.html">Thank you</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>
@@ -315,12 +323,23 @@
<div class="ui inverted vertical segment">
<div class="ui two column middle aligned grid">
<div class="column">
- Apache SensSoft 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 th [...]
+ 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">
- <img class="component-image" src="/images/incubator-logo-white.png">
- <br>
- Copyright © 2017 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, and the Apache Incubator logo are trademarks of The Apache Software Foundation. Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc.
+ <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>
diff --git a/content/docs/stout/start.html b/content/docs/stout/start.html
index a059aec..137e72c 100644
--- a/content/docs/stout/start.html
+++ b/content/docs/stout/start.html
@@ -16,8 +16,8 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://localhost:4000/docs/stout/start.html">
- <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml">
+ <link rel="canonical" href="http://flagon.incubator.apache.org/docs/stout/start.html">
+ <link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
</head>
@@ -28,14 +28,14 @@
<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 SensSoft</h3>
+ <h3 class="ui inverted header item">Apache Flagon</h3>
</a>
<div class="right menu">
<div class="ui dropdown item">
Components
<div class="menu">
- <a class="item" href="/system">System</a>
+ <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>
@@ -45,10 +45,10 @@
<div class="ui dropdown item">
<a href="/docs">Docs</a>
<div class="menu">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserALE.pyqt</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>
@@ -81,7 +81,7 @@
<div class="title">
<i class="dropdown icon"></i>
- Apache SensSoft
+ Apache Flagon
</div>
<div class="content">
@@ -90,7 +90,7 @@
<a class="item" href="/docs/">About the Docs</a>
- <a class="item" href="/docs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/contributing/">Contributing</a>
</div>
</div>
@@ -100,14 +100,16 @@
<div class="title">
<i class="dropdown icon"></i>
- System
+ Stack
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/system/">Getting Started</a>
+ <a class="item" href="/docs/stack/">Getting Started</a>
+
+ <a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
</div>
</div>
@@ -141,9 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+
+ <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+
+ <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
- <a class="item" href="/docs/useralejs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+
+ <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
</div>
</div>
@@ -152,20 +160,20 @@
<div class="title">
<i class="dropdown icon"></i>
- UserALE.pyqt
+ UserALE.py
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/useralepyqt/">Installation</a>
+ <a class="item" href="/docs/useralepy/">Installation</a>
- <a class="item" href="/docs/useralepyqt/start.html">Getting Started</a>
+ <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
- <a class="item" href="/docs/useralepyqt/api.html">API Documentation</a>
+ <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
- <a class="item" href="/docs/useralepyqt/changelog.html">Changelog</a>
+ <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
</div>
</div>
@@ -187,13 +195,13 @@
<a class="item" href="/docs/distill/api.html">API Documentation</a>
- <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</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/analytics.html">Apache Distill Analytics</a>
+ <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a>
<a class="item" href="/docs/distill/changelog.html">Changelog</a>
@@ -351,7 +359,7 @@
<div class="column">
<h4 class="ui inverted header">About</h4>
<div class="ui inverted link list">
- <a class="item" href="/system">System</a>
+ <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>
@@ -361,10 +369,10 @@
<div class="column">
<h4 class="ui inverted header">Docs</h4>
<div class="ui inverted link list">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserAle.pyqt</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>
@@ -373,21 +381,21 @@
<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=senssoft">GitHub</a>
- <a class="item" href="http://stackoverflow.com/questions/tagged/apache-senssoft">StackOverflow</a>
- <a class="item" href="https://issues.apache.org/jira/browse/SENSSOFT">Jira Issue Tracker</a>
- <a class="item" href="https://cwiki.apache.org/confluence/display/SENSSOFT">Project Wiki</a>
- <a class="item" href="https://twitter.com/apachesenssoft">Twitter</a>
+ <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/licenses/LICENSE-2.0.html">License</a>
<a class="item" href="http://www.apache.org/">Apache Software Foundation</a>
- <a class="item" href="http://incubator.apache.org/">Apache Incubator</a>
- <a class="item" href="http://www.apache.org/foundation/sponsorship.html">Sponsor Apache</a>
- <a class="item" href="http://www.apache.org/foundation/thanks.html">Thank you</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>
@@ -395,12 +403,23 @@
<div class="ui inverted vertical segment">
<div class="ui two column middle aligned grid">
<div class="column">
- Apache SensSoft 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 th [...]
+ 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">
- <img class="component-image" src="/images/incubator-logo-white.png">
- <br>
- Copyright © 2017 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, and the Apache Incubator logo are trademarks of The Apache Software Foundation. Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc.
+ <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>
diff --git a/content/docs/system/index.html b/content/docs/system/index.html
index b9e425e..88b8c60 100644
--- a/content/docs/system/index.html
+++ b/content/docs/system/index.html
@@ -16,7 +16,7 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://localhost:4000/docs/system/">
+ <link rel="canonical" href="http://senssoft.incubator.apache.org/docs/system/">
<link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml">
@@ -48,7 +48,7 @@
<a class="item" href="/docs/system">System</a>
<a class="item" href="/docs/userale">UserALE</a>
<a class="item" href="/docs/useralejs">UserALE.js</a>
- <a class="item" href="/docs/useralepyqt">UserALE.pyqt</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>
@@ -90,7 +90,7 @@
<a class="item" href="/docs/">About the Docs</a>
- <a class="item" href="/docs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/contributing/">Contributing</a>
</div>
</div>
@@ -143,7 +143,7 @@
<a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
- <a class="item" href="/docs/useralejs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/useralejs/testing.html">Build and Test</a>
</div>
</div>
@@ -152,20 +152,20 @@
<div class="title">
<i class="dropdown icon"></i>
- UserALE.pyqt
+ UserALE.py
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/useralepyqt/">Installation</a>
+ <a class="item" href="/docs/useralepy/">Installation</a>
- <a class="item" href="/docs/useralepyqt/start.html">Getting Started</a>
+ <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
- <a class="item" href="/docs/useralepyqt/api.html">API Documentation</a>
+ <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
- <a class="item" href="/docs/useralepyqt/changelog.html">Changelog</a>
+ <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
</div>
</div>
@@ -187,13 +187,13 @@
<a class="item" href="/docs/distill/api.html">API Documentation</a>
- <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</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/analytics.html">Apache Distill Analytics</a>
+ <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a>
<a class="item" href="/docs/distill/changelog.html">Changelog</a>
@@ -301,7 +301,7 @@
<a class="item" href="/docs/system">System</a>
<a class="item" href="/docs/userale">UserALE</a>
<a class="item" href="/docs/useralejs">UserAle.js</a>
- <a class="item" href="/docs/useralepyqt">UserAle.pyqt</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>
@@ -320,11 +320,11 @@
<div class="column">
<h4 class="ui inverted header">Apache</h4>
<div class="ui inverted link list">
- <a class="item" href="http://www.apache.org/licenses/LICENSE-2.0.html">License</a>
<a class="item" href="http://www.apache.org/">Apache Software Foundation</a>
- <a class="item" href="http://incubator.apache.org/">Apache Incubator</a>
- <a class="item" href="http://www.apache.org/foundation/sponsorship.html">Sponsor Apache</a>
- <a class="item" href="http://www.apache.org/foundation/thanks.html">Thank you</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>
@@ -335,9 +335,21 @@
Apache SensSoft 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 th [...]
</div>
<div class="center aligned column">
- <img class="component-image" src="/images/incubator-logo-white.png">
- <br>
- Copyright © 2017 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, and the Apache Incubator logo are trademarks of The Apache Software Foundation. Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc.
+ Copyright © 2018 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 SensSoft, SensSoft, Apache, the Apache feather logo, the Apache SensSoft logo and the Apache Incubator logo are trademarks of The Apache Software Foundation.
+ Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc.
+ </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>
diff --git a/content/docs/tap/index.html b/content/docs/tap/index.html
index 1b64b55..091d3cd 100644
--- a/content/docs/tap/index.html
+++ b/content/docs/tap/index.html
@@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Getting Started</title>
- <meta name="description" content="Tap is the front end of the SensSoft system. It consists of a React-Django web app that allows you to access your applications’ usage data via data visualiza...">
+ <meta name="description" content="Tap is an experimental sandbox for Apache Flagon, highlighting customer visual analytics to highlight insights derived from Apache UserAle.js. It consists of...">
<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,8 +16,8 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://localhost:4000/docs/tap/">
- <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml">
+ <link rel="canonical" href="http://flagon.incubator.apache.org/docs/tap/">
+ <link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
</head>
@@ -28,14 +28,14 @@
<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 SensSoft</h3>
+ <h3 class="ui inverted header item">Apache Flagon</h3>
</a>
<div class="right menu">
<div class="ui dropdown item">
Components
<div class="menu">
- <a class="item" href="/system">System</a>
+ <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>
@@ -45,10 +45,10 @@
<div class="ui dropdown item">
<a href="/docs">Docs</a>
<div class="menu">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserALE.pyqt</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>
@@ -81,7 +81,7 @@
<div class="title">
<i class="dropdown icon"></i>
- Apache SensSoft
+ Apache Flagon
</div>
<div class="content">
@@ -90,7 +90,7 @@
<a class="item" href="/docs/">About the Docs</a>
- <a class="item" href="/docs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/contributing/">Contributing</a>
</div>
</div>
@@ -100,14 +100,16 @@
<div class="title">
<i class="dropdown icon"></i>
- System
+ Stack
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/system/">Getting Started</a>
+ <a class="item" href="/docs/stack/">Getting Started</a>
+
+ <a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
</div>
</div>
@@ -141,9 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+
+ <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+
+ <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
- <a class="item" href="/docs/useralejs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+
+ <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
</div>
</div>
@@ -152,20 +160,20 @@
<div class="title">
<i class="dropdown icon"></i>
- UserALE.pyqt
+ UserALE.py
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/useralepyqt/">Installation</a>
+ <a class="item" href="/docs/useralepy/">Installation</a>
- <a class="item" href="/docs/useralepyqt/start.html">Getting Started</a>
+ <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
- <a class="item" href="/docs/useralepyqt/api.html">API Documentation</a>
+ <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
- <a class="item" href="/docs/useralepyqt/changelog.html">Changelog</a>
+ <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
</div>
</div>
@@ -187,13 +195,13 @@
<a class="item" href="/docs/distill/api.html">API Documentation</a>
- <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</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/analytics.html">Apache Distill Analytics</a>
+ <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a>
<a class="item" href="/docs/distill/changelog.html">Changelog</a>
@@ -238,9 +246,9 @@
</div>
<div class="docs-content">
<h2 class="ui header">Getting Started</h2>
- <p>Tap is the front end of the SensSoft system. It consists of a React-Django web app that allows you to access your applications’ usage data via data visualizations built in D3.</p>
+ <p>Tap is an experimental sandbox for Apache Flagon, highlighting customer visual analytics to highlight insights derived from Apache UserAle.js. It consists of a React-Django web app that allows you to access your applications’ usage data via data visualizations built in D3.</p>
-<p>Work on Tap’s documentation is ongoing. To get involved, see our <a href="/docs/contributing">Contributing</a> guide. To get started with Tap, <a href="/docs/system">try out the full SensSoft system</a>.</p>
+<p>Work on Tap’s documentation is ongoing. To get involved, see our <a href="/docs/contributing">Contributing</a> guide. To get started with Tap, <a href="/docs/stack">try out the full Flagon system</a>.</p>
</div>
</div>
@@ -253,7 +261,7 @@
<div class="column">
<h4 class="ui inverted header">About</h4>
<div class="ui inverted link list">
- <a class="item" href="/system">System</a>
+ <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>
@@ -263,10 +271,10 @@
<div class="column">
<h4 class="ui inverted header">Docs</h4>
<div class="ui inverted link list">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserAle.pyqt</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>
@@ -275,21 +283,21 @@
<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=senssoft">GitHub</a>
- <a class="item" href="http://stackoverflow.com/questions/tagged/apache-senssoft">StackOverflow</a>
- <a class="item" href="https://issues.apache.org/jira/browse/SENSSOFT">Jira Issue Tracker</a>
- <a class="item" href="https://cwiki.apache.org/confluence/display/SENSSOFT">Project Wiki</a>
- <a class="item" href="https://twitter.com/apachesenssoft">Twitter</a>
+ <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/licenses/LICENSE-2.0.html">License</a>
<a class="item" href="http://www.apache.org/">Apache Software Foundation</a>
- <a class="item" href="http://incubator.apache.org/">Apache Incubator</a>
- <a class="item" href="http://www.apache.org/foundation/sponsorship.html">Sponsor Apache</a>
- <a class="item" href="http://www.apache.org/foundation/thanks.html">Thank you</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>
@@ -297,12 +305,23 @@
<div class="ui inverted vertical segment">
<div class="ui two column middle aligned grid">
<div class="column">
- Apache SensSoft 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 th [...]
+ 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">
- <img class="component-image" src="/images/incubator-logo-white.png">
- <br>
- Copyright © 2017 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, and the Apache Incubator logo are trademarks of The Apache Software Foundation. Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc.
+ <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>
diff --git a/content/docs/userale/index.html b/content/docs/userale/index.html
index 03b527c..377e683 100644
--- a/content/docs/userale/index.html
+++ b/content/docs/userale/index.html
@@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>About UserALE</title>
- <meta name="description" content="Note: Work on UserALE’s documentation is ongoing. To get involved, see our Contributing guide. To get started with UserALE, try out the full SensSoft system.">
+ <meta name="description" content="Note: Work on UserALE’s documentation is ongoing. To get involved, see our Contributing guide. To get started with UserALE, try out the full Flagon stack.">
<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,8 +16,8 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://localhost:4000/docs/userale/">
- <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml">
+ <link rel="canonical" href="http://flagon.incubator.apache.org/docs/userale/">
+ <link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
</head>
@@ -28,14 +28,14 @@
<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 SensSoft</h3>
+ <h3 class="ui inverted header item">Apache Flagon</h3>
</a>
<div class="right menu">
<div class="ui dropdown item">
Components
<div class="menu">
- <a class="item" href="/system">System</a>
+ <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>
@@ -45,10 +45,10 @@
<div class="ui dropdown item">
<a href="/docs">Docs</a>
<div class="menu">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserALE.pyqt</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>
@@ -81,7 +81,7 @@
<div class="title">
<i class="dropdown icon"></i>
- Apache SensSoft
+ Apache Flagon
</div>
<div class="content">
@@ -90,7 +90,7 @@
<a class="item" href="/docs/">About the Docs</a>
- <a class="item" href="/docs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/contributing/">Contributing</a>
</div>
</div>
@@ -100,14 +100,16 @@
<div class="title">
<i class="dropdown icon"></i>
- System
+ Stack
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/system/">Getting Started</a>
+ <a class="item" href="/docs/stack/">Getting Started</a>
+
+ <a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
</div>
</div>
@@ -141,9 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+
+ <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+
+ <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
- <a class="item" href="/docs/useralejs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+
+ <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
</div>
</div>
@@ -152,20 +160,20 @@
<div class="title">
<i class="dropdown icon"></i>
- UserALE.pyqt
+ UserALE.py
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/useralepyqt/">Installation</a>
+ <a class="item" href="/docs/useralepy/">Installation</a>
- <a class="item" href="/docs/useralepyqt/start.html">Getting Started</a>
+ <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
- <a class="item" href="/docs/useralepyqt/api.html">API Documentation</a>
+ <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
- <a class="item" href="/docs/useralepyqt/changelog.html">Changelog</a>
+ <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
</div>
</div>
@@ -187,13 +195,13 @@
<a class="item" href="/docs/distill/api.html">API Documentation</a>
- <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</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/analytics.html">Apache Distill Analytics</a>
+ <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a>
<a class="item" href="/docs/distill/changelog.html">Changelog</a>
@@ -238,19 +246,19 @@
</div>
<div class="docs-content">
<h2 class="ui header">About UserALE</h2>
- <p><em>Note</em>: Work on UserALE’s documentation is ongoing. To get involved, see our <a href="/docs/contributing">Contributing</a> guide. To get started with UserALE, <a href="/docs/system">try out the full SensSoft system</a>.</p>
+ <p><em>Note</em>: Work on UserALE’s documentation is ongoing. To get involved, see our <a href="/docs/contributing">Contributing</a> guide. To get started with UserALE, <a href="/docs/stack">try out the full Flagon stack</a>.</p>
<h3 id="about-userale">About UserALE</h3>
-<p>The User Analytic Logging Engine (User ALE) is part of Apache SensSoft. User ALE is for Software Developers, HCI/UX researchers, and project managers who develop user facing software tools—applications that are used for manipulating, analyzing, or visualizing data or other systems.</p>
+<p>The User Analytic Logging Engine (UserALE) is part of Apache Flagon. UserALE is for Software Developers, HCI/UX researchers, and project managers who develop user facing software tools—applications that are used for manipulating, analyzing, or visualizing data or other systems.</p>
-<p>User ALE provides an API for instrumenting software tools, turning them into a human usability sensors. With every user interaction User ALE will transmit specially structured messages (JSON) from software tools to an activity logging server (Elastic). These messages not only report user activities and their timing, but provide sufficient context to understand how those activities are related to the functional organization of the software tool. This allows for greater utility in under [...]
+<p>UserALE provides an API for instrumenting software tools, turning them into a human usability sensors. With every user interaction User ALE will transmit specially structured messages (JSON) from software tools to an activity logging server (<a href="http://elastic.co">Elasticsearch™</a>). These messages not only report user activities and their timing, but provide sufficient context to understand how those activities are related to the functional organization of the software tool. Th [...]
-<p>User ALE provides data provides insight into software tool usage frequency, users’ cognitive/behavioral strategy in using tools to complete tasks, their workflows, as well as their integrative use of software tool features.</p>
+<p>UserALE provides data provides insight into software tool usage frequency, users’ cognitive/behavioral strategy in using tools to complete tasks, their workflows, as well as their integrative use of software tool features.</p>
<h3 id="who-is-userale-for">Who is UserALE for?</h3>
-<p>The User Analytic Logging Engine (User ALE) is for Software Developers, HCI/UX researchers, and project managers who develop user facing software tools.</p>
+<p>UserALE is for Software Developers, HCI/UX researchers, and project managers who develop user facing software tools.</p>
</div>
</div>
@@ -263,7 +271,7 @@
<div class="column">
<h4 class="ui inverted header">About</h4>
<div class="ui inverted link list">
- <a class="item" href="/system">System</a>
+ <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>
@@ -273,10 +281,10 @@
<div class="column">
<h4 class="ui inverted header">Docs</h4>
<div class="ui inverted link list">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserAle.pyqt</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>
@@ -285,21 +293,21 @@
<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=senssoft">GitHub</a>
- <a class="item" href="http://stackoverflow.com/questions/tagged/apache-senssoft">StackOverflow</a>
- <a class="item" href="https://issues.apache.org/jira/browse/SENSSOFT">Jira Issue Tracker</a>
- <a class="item" href="https://cwiki.apache.org/confluence/display/SENSSOFT">Project Wiki</a>
- <a class="item" href="https://twitter.com/apachesenssoft">Twitter</a>
+ <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/licenses/LICENSE-2.0.html">License</a>
<a class="item" href="http://www.apache.org/">Apache Software Foundation</a>
- <a class="item" href="http://incubator.apache.org/">Apache Incubator</a>
- <a class="item" href="http://www.apache.org/foundation/sponsorship.html">Sponsor Apache</a>
- <a class="item" href="http://www.apache.org/foundation/thanks.html">Thank you</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>
@@ -307,12 +315,23 @@
<div class="ui inverted vertical segment">
<div class="ui two column middle aligned grid">
<div class="column">
- Apache SensSoft 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 th [...]
+ 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">
- <img class="component-image" src="/images/incubator-logo-white.png">
- <br>
- Copyright © 2017 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, and the Apache Incubator logo are trademarks of The Apache Software Foundation. Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc.
+ <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>
diff --git a/content/docs/useralejs/API.html b/content/docs/useralejs/API.html
new file mode 100644
index 0000000..0de35a7
--- /dev/null
+++ b/content/docs/useralejs/API.html
@@ -0,0 +1,468 @@
+<!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 API</title>
+ <meta name="description" content="Modifying UserALE.js Behavior via API">
+
+ <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.html">
+ <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">
+ Components
+ <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.html">UserALE.js Build and Test</a>
+
+ <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+
+ <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+
+ <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+
+ <a class="item" href="/docs/useralejs/troubleshooting.html">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 API</h2>
+ <h1 id="modifying-useralejs-behavior-via-api">Modifying UserALE.js Behavior via API</h1>
+
+<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 lattitude in customizing and curating your logs.</p>
+
+<p>#API Usage</p>
+
+<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>
+
+<p>##<code class="highlighter-rouge">setLogFilter</code> Examples</p>
+
+<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-javascript highlighter-rouge"><pre class="highlight"><code> <span class="o"><</span><span class="nx">script</span> <span class="nx">type</span><span class="o">=</span><span class="s2">"text/javascript"</span><span class="o">></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="o"><</span><span class="sr">/script</span><span class="err">>
+</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/useralejs">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/content/docs/useralejs/build.html b/content/docs/useralejs/build.html
new file mode 100644
index 0000000..71f528d
--- /dev/null
+++ b/content/docs/useralejs/build.html
@@ -0,0 +1,441 @@
+<!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 Build and Test</title>
+ <meta name="description" content="Building UserALE.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>
+ <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/build.html">
+ <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">
+ Components
+ <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.html">UserALE.js Build and Test</a>
+
+ <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+
+ <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+
+ <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+
+ <a class="item" href="/docs/useralejs/troubleshooting.html">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 Build and Test</h2>
+ <h3 id="building-useralejs">Building UserALE.js</h3>
+
+<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>
+
+<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
+
+#review major dependencies
+npm ls --depth=0
+</code></pre>
+</div>
+
+<h2 id="build">Build</h2>
+
+<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="highlighter-rouge"><pre class="highlight"><code>#Build UserALE.js
+npm run build
+</code></pre>
+</div>
+
+<h2 id="test">Test</h2>
+
+<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>
+
+<p>To run tests:</p>
+<div class="highlighter-rouge"><pre class="highlight"><code>#Run UserALE.js unit tests
+npm run test
+</code></pre>
+</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>
+<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>
+
+ </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/distill/changelog.html b/content/docs/useralejs/dataschema.html
similarity index 61%
copy from content/docs/distill/changelog.html
copy to content/docs/useralejs/dataschema.html
index d349531..332c414 100644
--- a/content/docs/distill/changelog.html
+++ b/content/docs/useralejs/dataschema.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>Changelog</title>
- <meta name="description" content="0.1.3 (2016-09-19) Moved to Apache. Updated all documentation. Added License headers Docker compose file added to assist deployment of ELK stack with Distill">
+ <title>UserALE.js Data Schema</title>
+ <meta name="description" content="#The UserALE.js Dataschema">
<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,8 +16,8 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://localhost:4000/docs/distill/changelog.html">
- <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml">
+ <link rel="canonical" href="http://flagon.incubator.apache.org/docs/useralejs/dataschema.html">
+ <link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
</head>
@@ -28,14 +28,14 @@
<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 SensSoft</h3>
+ <h3 class="ui inverted header item">Apache Flagon</h3>
</a>
<div class="right menu">
<div class="ui dropdown item">
Components
<div class="menu">
- <a class="item" href="/system">System</a>
+ <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>
@@ -45,10 +45,10 @@
<div class="ui dropdown item">
<a href="/docs">Docs</a>
<div class="menu">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserALE.pyqt</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>
@@ -81,7 +81,7 @@
<div class="title">
<i class="dropdown icon"></i>
- Apache SensSoft
+ Apache Flagon
</div>
<div class="content">
@@ -90,7 +90,7 @@
<a class="item" href="/docs/">About the Docs</a>
- <a class="item" href="/docs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/contributing/">Contributing</a>
</div>
</div>
@@ -100,14 +100,16 @@
<div class="title">
<i class="dropdown icon"></i>
- System
+ Stack
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/system/">Getting Started</a>
+ <a class="item" href="/docs/stack/">Getting Started</a>
+
+ <a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
</div>
</div>
@@ -129,21 +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/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+
+ <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+
+ <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
- <a class="item" href="/docs/useralejs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+
+ <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
</div>
</div>
@@ -152,32 +160,32 @@
<div class="title">
<i class="dropdown icon"></i>
- UserALE.pyqt
+ UserALE.py
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/useralepyqt/">Installation</a>
+ <a class="item" href="/docs/useralepy/">Installation</a>
- <a class="item" href="/docs/useralepyqt/start.html">Getting Started</a>
+ <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
- <a class="item" href="/docs/useralepyqt/api.html">API Documentation</a>
+ <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
- <a class="item" href="/docs/useralepyqt/changelog.html">Changelog</a>
+ <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
</div>
</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">
@@ -187,13 +195,13 @@
<a class="item" href="/docs/distill/api.html">API Documentation</a>
- <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</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/analytics.html">Apache Distill Analytics</a>
+ <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a>
<a class="item" href="/docs/distill/changelog.html">Changelog</a>
@@ -237,35 +245,21 @@
</div>
<div class="docs-content">
- <h2 class="ui header">Changelog</h2>
- <h3 id="013-2016-09-19">0.1.3 (2016-09-19)</h3>
-<ul>
- <li>Moved to Apache.</li>
- <li>Updated all documentation.</li>
- <li>Added License headers</li>
- <li>Docker compose file added to assist deployment of ELK stack with Distill</li>
-</ul>
+ <h2 class="ui header">UserALE.js Data Schema</h2>
+ <p>#The UserALE.js Dataschema</p>
-<h3 id="012-2016-07-22">0.1.2 (2016-07-22)</h3>
+<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>Moved CRUD operations from UserAle model to Brew model.</li>
- <li>Added API specs to segment UserAle data from Elasticsearch</li>
- <li>Added deployment instructions</li>
+ <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>
-<h3 id="011-2016-06-14">0.1.1 (2016-06-14)</h3>
-<ul>
- <li>Completed index route for status endpoint which lists all applications registered and their document count segmented by type.</li>
- <li>Updated setup.py to reference deploy scripts</li>
- <li>Example configuration to deploy Distll with Gunicorn and Nginx for Linux/Mac users</li>
- <li>Added UserAle and Stout classes.</li>
- <li>Updated requirements.txt for deployment.</li>
-</ul>
+<p>WIP: Under Construction</p>
-<h3 id="010-2016-04-01">0.1.0 (2016-04-01)</h3>
-<ul>
- <li>Initial release.</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>
@@ -278,7 +272,7 @@
<div class="column">
<h4 class="ui inverted header">About</h4>
<div class="ui inverted link list">
- <a class="item" href="/system">System</a>
+ <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>
@@ -288,10 +282,10 @@
<div class="column">
<h4 class="ui inverted header">Docs</h4>
<div class="ui inverted link list">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserAle.pyqt</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>
@@ -300,21 +294,21 @@
<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=senssoft">GitHub</a>
- <a class="item" href="http://stackoverflow.com/questions/tagged/apache-senssoft">StackOverflow</a>
- <a class="item" href="https://issues.apache.org/jira/browse/SENSSOFT">Jira Issue Tracker</a>
- <a class="item" href="https://cwiki.apache.org/confluence/display/SENSSOFT">Project Wiki</a>
- <a class="item" href="https://twitter.com/apachesenssoft">Twitter</a>
+ <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/licenses/LICENSE-2.0.html">License</a>
<a class="item" href="http://www.apache.org/">Apache Software Foundation</a>
- <a class="item" href="http://incubator.apache.org/">Apache Incubator</a>
- <a class="item" href="http://www.apache.org/foundation/sponsorship.html">Sponsor Apache</a>
- <a class="item" href="http://www.apache.org/foundation/thanks.html">Thank you</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>
@@ -322,12 +316,23 @@
<div class="ui inverted vertical segment">
<div class="ui two column middle aligned grid">
<div class="column">
- Apache SensSoft 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 th [...]
+ 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">
- <img class="component-image" src="/images/incubator-logo-white.png">
- <br>
- Copyright © 2017 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, and the Apache Incubator logo are trademarks of The Apache Software Foundation. Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc.
+ <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>
diff --git a/content/docs/useralejs/index.html b/content/docs/useralejs/index.html
index e7c5ea7..cb63071 100644
--- a/content/docs/useralejs/index.html
+++ b/content/docs/useralejs/index.html
@@ -16,8 +16,8 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://localhost:4000/docs/useralejs/">
- <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml">
+ <link rel="canonical" href="http://flagon.incubator.apache.org/docs/useralejs/">
+ <link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
</head>
@@ -28,14 +28,14 @@
<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 SensSoft</h3>
+ <h3 class="ui inverted header item">Apache Flagon</h3>
</a>
<div class="right menu">
<div class="ui dropdown item">
Components
<div class="menu">
- <a class="item" href="/system">System</a>
+ <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>
@@ -45,10 +45,10 @@
<div class="ui dropdown item">
<a href="/docs">Docs</a>
<div class="menu">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserALE.pyqt</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>
@@ -81,7 +81,7 @@
<div class="title">
<i class="dropdown icon"></i>
- Apache SensSoft
+ Apache Flagon
</div>
<div class="content">
@@ -90,7 +90,7 @@
<a class="item" href="/docs/">About the Docs</a>
- <a class="item" href="/docs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/contributing/">Contributing</a>
</div>
</div>
@@ -100,14 +100,16 @@
<div class="title">
<i class="dropdown icon"></i>
- System
+ Stack
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/system/">Getting Started</a>
+ <a class="item" href="/docs/stack/">Getting Started</a>
+
+ <a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
</div>
</div>
@@ -141,9 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+
+ <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+
+ <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+
+ <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
- <a class="item" href="/docs/useralejs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
</div>
</div>
@@ -152,20 +160,20 @@
<div class="title">
<i class="dropdown icon"></i>
- UserALE.pyqt
+ UserALE.py
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/useralepyqt/">Installation</a>
+ <a class="item" href="/docs/useralepy/">Installation</a>
- <a class="item" href="/docs/useralepyqt/start.html">Getting Started</a>
+ <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
- <a class="item" href="/docs/useralepyqt/api.html">API Documentation</a>
+ <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
- <a class="item" href="/docs/useralepyqt/changelog.html">Changelog</a>
+ <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
</div>
</div>
@@ -187,13 +195,13 @@
<a class="item" href="/docs/distill/api.html">API Documentation</a>
- <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</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/analytics.html">Apache Distill Analytics</a>
+ <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a>
<a class="item" href="/docs/distill/changelog.html">Changelog</a>
@@ -238,23 +246,26 @@
</div>
<div class="docs-content">
<h2 class="ui header">Getting Started</h2>
- <p>Apache UserALE.js is the UserALE client for DOM and JavaScript-based applications. It automatically attaches event handlers, is configurable through HTML5 data parameters or a JS API, and logs every user interaction on a web page, including rich JS single-page apps.</p>
-
-<p><em>Note:</em> Work on UserALE.js’ documentation is ongoing. The most notable undocumented feature is the JS API. To get involved, see our <a href="/docs/contributing">Contributing</a> guide.</p>
+ <p><a href="https://github.com/apache/incubator-flagon-useralejs">Apache UserALE.js</a> is the UserALE client for DOM and JavaScript-based applications. It automatically attaches event handlers, is configurable through HTML5 data parameters or a JS API, and logs every user interaction on a web page, including rich JS single-page apps. You can choose to include UserALE.js directly in your project to track how users engage with it, or if you’re interested in generating logs from any w [...]
+<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 include UserAle.js in your project with default configuration, simply include the script tag below:</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, or just use a sample in our <a href="https://github.com/apache/incubator-flagon-useralejs/tree/master/build">repos</a>.</p>
+
+<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>
-<div class="language-html highlighter-rouge"><pre class="highlight"><code> <span class="nt"><script </span><span class="na">src=</span><span class="s">"<yourUseraleSource>"</span><span class="nt">></script></span>
+<div class="language-html highlighter-rouge"><pre class="highlight"><code><span class="nt"><script </span><span class="na">src=</span><span class="s">"/path/to/userale-2.0.0.min.js"</span><span class="nt">></script></span>
</code></pre>
</div>
-<h3 id="configure-useralejs">Configure UserALE.js</h3>
+<p>This tag will execute the UserALE.js script in your, with no other modifications to your project needed!</p>
+
+<p><strong>Configure UserALE.js through the Script Tag</strong></p>
-<p>HTML5 Data Parameters are used to configure UserALE.js. For example, to set the logging URL:</p>
+<p>UserALE.js is designed to be easily configured to fit your use case. We use HTML data parameters to pass configuration options to the library. For example, one thing you’ll need to do is set the URL (location) of your minified UserALE.js script:</p>
-<div class="language-html highlighter-rouge"><pre class="highlight"><code> <span class="nt"><script </span><span class="na">src=</span><span class="s">"userale.js"</span> <span class="na">data-url=</span><span class="s">"http://yourLoggingUrl"</span><span class="nt">></script></span>
+<div class="language-html highlighter-rouge"><pre class="highlight"><code><span class="nt"><script </span><span class="na">src=</span><span class="s">"/path/to/userale-2.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>
@@ -263,65 +274,109 @@
<table>
<thead>
<tr>
- <th style="text-align: left">Param</th>
- <th style="text-align: left">Description</th>
- <th style="text-align: left">Default</th>
+ <th>Param</th>
+ <th>Description</th>
+ <th>Default</th>
</tr>
</thead>
<tbody>
<tr>
- <td style="text-align: left">data-url</td>
- <td style="text-align: left">Logging URL</td>
- <td style="text-align: left">http://localhost:8000</td>
+ <td>data-url</td>
+ <td>Logging URL</td>
+ <td>http://localhost:8000</td>
</tr>
<tr>
- <td style="text-align: left">data-autostart</td>
- <td style="text-align: left">Should Userale.js start on page load</td>
- <td style="text-align: left">true</td>
+ <td>data-autostart</td>
+ <td>Should UserALE.js start on page load</td>
+ <td>true</td>
</tr>
<tr>
- <td style="text-align: left">data-interval</td>
- <td style="text-align: left">Delay between transmit checks</td>
- <td style="text-align: left">5000 (ms)</td>
+ <td>data-interval</td>
+ <td>Delay between transmit checks</td>
+ <td>5000 (ms)</td>
</tr>
<tr>
- <td style="text-align: left">data-threshold</td>
- <td style="text-align: left">Minimum number of logs to send</td>
- <td style="text-align: left">5</td>
+ <td>data-threshold</td>
+ <td>Minimum number of logs to send</td>
+ <td>5</td>
</tr>
<tr>
- <td style="text-align: left">data-user</td>
- <td style="text-align: left">User identifier</td>
- <td style="text-align: left">null</td>
+ <td>data-user</td>
+ <td>User identifier</td>
+ <td>null</td>
</tr>
<tr>
- <td style="text-align: left">data-version</td>
- <td style="text-align: left">Application version identifier</td>
- <td style="text-align: left">null</td>
+ <td>data-version</td>
+ <td>Application version identifier</td>
+ <td>null</td>
</tr>
<tr>
- <td style="text-align: left">data-log-details</td>
- <td style="text-align: left">Toggle detailed logs (keys pressed and input/change values)</td>
- <td style="text-align: left">false</td>
+ <td>data-log-details</td>
+ <td>Toggle detailed logs (keys pressed and input/change values)</td>
+ <td>false</td>
</tr>
<tr>
- <td style="text-align: left">data-resolution</td>
- <td style="text-align: left">Delay between instances of high frequency logs (mouseover, scroll, etc.)</td>
- <td style="text-align: left">500 (ms)</td>
+ <td>data-resolution</td>
+ <td>Delay between instances of high frequency logs (mouseover, scroll, etc.)</td>
+ <td>500 (ms)</td>
</tr>
<tr>
- <td style="text-align: left">data-user-from-params</td>
- <td style="text-align: left">Query param in the page URL to fetch userId from</td>
- <td style="text-align: left">null</td>
+ <td>data-user-from-params</td>
+ <td>Query param in the page URL to fetch userId from</td>
+ <td>null</td>
</tr>
<tr>
- <td style="text-align: left">data-tool</td>
- <td style="text-align: left">Name of tool being logged</td>
- <td style="text-align: left">null</td>
+ <td>data-tool</td>
+ <td>Name of tool being logged</td>
+ <td>null</td>
</tr>
</tbody>
</table>
+<p>See our page on <a href="/docs/useralejs/build">Build and Test</a> for UserALE.js to learn how to build your own minified version of the UserALE.js script, or you check-out a pre-built script with default parameters in our <a href="https://github.com/apache/incubator-flagon-useralejs/tree/master/build">repo</a>.</p>
+
+<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>When you’re ready to deploy the UserALE.js web extension, follow the instructions below:</p>
+
+<ol>
+ <li>Load the web extension into your browser.
+ <ol>
+ <li>Firefox
+ <ol>
+ <li>Open Firefox</li>
+ <li>Enter about:debugging into the URL bar and press enter</li>
+ <li>Check the box to ‘Enable add-on debugging’</li>
+ <li>Press the ‘Load Temporary Add-on’ button</li>
+ <li>Navigate to the root of the web extension directory (e.g. ‘build/UserAleWebExtension’)</li>
+ <li>Press Open, and confirm that ‘User ALE Extension’ appears in the list</li>
+ <li>You may now navigate to a web page to inject the User ALE script!</li>
+ </ol>
+ </li>
+ <li>Chrome
+ <ol>
+ <li>Open Chrome</li>
+ <li>Enter chrome://extensions into the URL bar and press enter</li>
+ <li>Check the ‘Developer mode’ box</li>
+ <li>Press the ‘Load unpacked extension’ button</li>
+ <li>Navigate to the root of the build directory (e.g. ‘build/UserAleWebExtension’)</li>
+ <li>Press Ok, and confirm that ‘UserALE Extension’ appears in the list</li>
+ <li>You may now navigate to a web page to inject the User ALE script!</li>
+ </ol>
+ </li>
+ </ol>
+ </li>
+</ol>
+
+<p>You can also find more instructions in our <a href="https://github.com/apache/incubator-flagon-useralejs/blob/FLAGON-336/src/UserALEWebExtension/README.md">README</a>.</p>
+
+<h2 id="options">Options</h2>
+
+<p>You can set options for the web extension in your browser by opening the extensions page, finding the extension, and choosing either “Preferences” for Firefox, or “Options” for Chrome.</p>
+
</div>
</div>
@@ -333,7 +388,7 @@
<div class="column">
<h4 class="ui inverted header">About</h4>
<div class="ui inverted link list">
- <a class="item" href="/system">System</a>
+ <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>
@@ -343,10 +398,10 @@
<div class="column">
<h4 class="ui inverted header">Docs</h4>
<div class="ui inverted link list">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserAle.pyqt</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>
@@ -355,21 +410,21 @@
<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=senssoft">GitHub</a>
- <a class="item" href="http://stackoverflow.com/questions/tagged/apache-senssoft">StackOverflow</a>
- <a class="item" href="https://issues.apache.org/jira/browse/SENSSOFT">Jira Issue Tracker</a>
- <a class="item" href="https://cwiki.apache.org/confluence/display/SENSSOFT">Project Wiki</a>
- <a class="item" href="https://twitter.com/apachesenssoft">Twitter</a>
+ <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/licenses/LICENSE-2.0.html">License</a>
<a class="item" href="http://www.apache.org/">Apache Software Foundation</a>
- <a class="item" href="http://incubator.apache.org/">Apache Incubator</a>
- <a class="item" href="http://www.apache.org/foundation/sponsorship.html">Sponsor Apache</a>
- <a class="item" href="http://www.apache.org/foundation/thanks.html">Thank you</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>
@@ -377,12 +432,23 @@
<div class="ui inverted vertical segment">
<div class="ui two column middle aligned grid">
<div class="column">
- Apache SensSoft 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 th [...]
+ 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">
- <img class="component-image" src="/images/incubator-logo-white.png">
- <br>
- Copyright © 2017 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, and the Apache Incubator logo are trademarks of The Apache Software Foundation. Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc.
+ 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>
diff --git a/content/docs/useralejs/modifying.html b/content/docs/useralejs/modifying.html
new file mode 100644
index 0000000..0fb7980
--- /dev/null
+++ b/content/docs/useralejs/modifying.html
@@ -0,0 +1,457 @@
+<!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</title>
+ <meta name="description" content="Customizing UserALE.js Logs through Source Code Modifications">
+
+ <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.html">
+ <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">
+ Components
+ <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.html">UserALE.js Build and Test</a>
+
+ <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+
+ <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+
+ <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+
+ <a class="item" href="/docs/useralejs/troubleshooting.html">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</h2>
+ <h1 id="customizing-useralejs-logs-through-source-code-modifications">Customizing UserALE.js Logs through Source Code Modifications</h1>
+
+<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 and you might not care to worry about scaling your logging data store. Fortunately, 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 which meta data is 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>
+
+<p>###Usage</p>
+
+<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>
+
+<p>###Modifying Event Handlers: Examples</p>
+
+<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="nx">you</span> <span class="nx">can</span> <span class="nx">modify</span> <span class="nx">the</span> <span class="nx">events</span> <span class="nx">UserALE</span><span class="p">.</span><span class="nx">js</span> <span class="nx">by</span> <span class="nx">editing</span> <span class="nx">vars</span> <span class="k">in</span> <span class="err">`</span><span class="nx">attacheHandlers</span><span [...]
+<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="s1">'key'</span> <span class="p">:</span> <span class="nx">e</span><span class="p">.</span><span class="nx">keyCode< [...]
+ <span class="cm">/*'mouseover' : null,*/</span> <span class="err">#</span><span class="nx">Aliasing</span> <span class="nx">out</span> <span class="nx">events</span> <span class="nx">from</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 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>
+<p>###Modifying Meta Data Packaged in Logs: Examples</p>
+
+<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, pulling in other data from configs, window, or documents */</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/content/docs/distill/start.html b/content/docs/useralejs/testing.html
similarity index 74%
copy from content/docs/distill/start.html
copy to content/docs/useralejs/testing.html
index ccb3f2d..4900299 100644
--- a/content/docs/distill/start.html
+++ b/content/docs/useralejs/testing.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>Build and Test</title>
+ <meta name="description" content="Building UserALE.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://localhost:4000/docs/distill/start.html">
+ <link rel="canonical" href="http://senssoft.incubator.apache.org/docs/useralejs/testing.html">
<link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml">
@@ -48,7 +48,7 @@
<a class="item" href="/docs/system">System</a>
<a class="item" href="/docs/userale">UserALE</a>
<a class="item" href="/docs/useralejs">UserALE.js</a>
- <a class="item" href="/docs/useralepyqt">UserALE.pyqt</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>
@@ -90,7 +90,7 @@
<a class="item" href="/docs/">About the Docs</a>
- <a class="item" href="/docs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/contributing/">Contributing</a>
</div>
</div>
@@ -129,13 +129,13 @@
</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">
@@ -143,7 +143,7 @@
<a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
- <a class="item" href="/docs/useralejs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/useralejs/testing.html">Build and Test</a>
</div>
</div>
@@ -152,32 +152,32 @@
<div class="title">
<i class="dropdown icon"></i>
- UserALE.pyqt
+ UserALE.py
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/useralepyqt/">Installation</a>
+ <a class="item" href="/docs/useralepy/">Installation</a>
- <a class="item" href="/docs/useralepyqt/start.html">Getting Started</a>
+ <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
- <a class="item" href="/docs/useralepyqt/api.html">API Documentation</a>
+ <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
- <a class="item" href="/docs/useralepyqt/changelog.html">Changelog</a>
+ <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
</div>
</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">
@@ -187,13 +187,13 @@
<a class="item" href="/docs/distill/api.html">API Documentation</a>
- <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</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/analytics.html">Apache Distill Analytics</a>
+ <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a>
<a class="item" href="/docs/distill/changelog.html">Changelog</a>
@@ -237,19 +237,28 @@
</div>
<div class="docs-content">
- <h2 class="ui header">Getting Started</h2>
- <h3 id="usage">Usage</h3>
+ <h2 class="ui header">Build and Test</h2>
+ <h3 id="building-useralejs">Building UserALE.js</h3>
-<p>Using curl:</p>
+<p>To modify and build your own version of <code class="highlighter-rouge">UserALE.js</code>, first clone the repo, install all dependencies, and make any desired changes. Then build and minify into the build/ folder:</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>
+<div class="language-shell highlighter-rouge"><pre class="highlight"><code> git clone https://github.com/apache/incubator-senssoft-useralejs.git
+ npm install
+ npm run build
</code></pre>
</div>
+<h3 id="testing-and-linting">Testing and Linting</h3>
+
+<p>We maintain code quality through linting and our test suite. To run, or run and watch for changes:</p>
+
+<div class="language-shell highlighter-rouge"><pre class="highlight"><code> npm <span class="nb">test
+ </span>npm run example:watch
+</code></pre>
+</div>
+
+<p>See <code class="highlighter-rouge">package.json</code> for full script options.</p>
+
</div>
</div>
@@ -274,7 +283,7 @@
<a class="item" href="/docs/system">System</a>
<a class="item" href="/docs/userale">UserALE</a>
<a class="item" href="/docs/useralejs">UserAle.js</a>
- <a class="item" href="/docs/useralepyqt">UserAle.pyqt</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>
@@ -293,11 +302,11 @@
<div class="column">
<h4 class="ui inverted header">Apache</h4>
<div class="ui inverted link list">
- <a class="item" href="http://www.apache.org/licenses/LICENSE-2.0.html">License</a>
<a class="item" href="http://www.apache.org/">Apache Software Foundation</a>
- <a class="item" href="http://incubator.apache.org/">Apache Incubator</a>
- <a class="item" href="http://www.apache.org/foundation/sponsorship.html">Sponsor Apache</a>
- <a class="item" href="http://www.apache.org/foundation/thanks.html">Thank you</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>
@@ -308,9 +317,21 @@
Apache SensSoft 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 th [...]
</div>
<div class="center aligned column">
- <img class="component-image" src="/images/incubator-logo-white.png">
- <br>
- Copyright © 2017 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, and the Apache Incubator logo are trademarks of The Apache Software Foundation. Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc.
+ Copyright © 2018 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 SensSoft, SensSoft, Apache, the Apache feather logo, the Apache SensSoft logo and the Apache Incubator logo are trademarks of The Apache Software Foundation.
+ Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc.
+ </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>
diff --git a/content/docs/useralejs/troubleshooting.html b/content/docs/useralejs/troubleshooting.html
index 3502a5d..a4a3b7e 100644
--- a/content/docs/useralejs/troubleshooting.html
+++ b/content/docs/useralejs/troubleshooting.html
@@ -16,8 +16,8 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://localhost:4000/docs/useralejs/troubleshooting.html">
- <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml">
+ <link rel="canonical" href="http://flagon.incubator.apache.org/docs/useralejs/troubleshooting.html">
+ <link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
</head>
@@ -28,14 +28,14 @@
<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 SensSoft</h3>
+ <h3 class="ui inverted header item">Apache Flagon</h3>
</a>
<div class="right menu">
<div class="ui dropdown item">
Components
<div class="menu">
- <a class="item" href="/system">System</a>
+ <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>
@@ -45,10 +45,10 @@
<div class="ui dropdown item">
<a href="/docs">Docs</a>
<div class="menu">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserALE.pyqt</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>
@@ -81,7 +81,7 @@
<div class="title">
<i class="dropdown icon"></i>
- Apache SensSoft
+ Apache Flagon
</div>
<div class="content">
@@ -90,7 +90,7 @@
<a class="item" href="/docs/">About the Docs</a>
- <a class="item" href="/docs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/contributing/">Contributing</a>
</div>
</div>
@@ -100,14 +100,16 @@
<div class="title">
<i class="dropdown icon"></i>
- System
+ Stack
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/system/">Getting Started</a>
+ <a class="item" href="/docs/stack/">Getting Started</a>
+
+ <a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
</div>
</div>
@@ -141,9 +143,15 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+
+ <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+
+ <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
- <a class="item" href="/docs/useralejs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+
+ <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
</div>
</div>
@@ -152,20 +160,20 @@
<div class="title">
<i class="dropdown icon"></i>
- UserALE.pyqt
+ UserALE.py
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/useralepyqt/">Installation</a>
+ <a class="item" href="/docs/useralepy/">Installation</a>
- <a class="item" href="/docs/useralepyqt/start.html">Getting Started</a>
+ <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
- <a class="item" href="/docs/useralepyqt/api.html">API Documentation</a>
+ <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
- <a class="item" href="/docs/useralepyqt/changelog.html">Changelog</a>
+ <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
</div>
</div>
@@ -187,13 +195,13 @@
<a class="item" href="/docs/distill/api.html">API Documentation</a>
- <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</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/analytics.html">Apache Distill Analytics</a>
+ <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a>
<a class="item" href="/docs/distill/changelog.html">Changelog</a>
@@ -240,7 +248,7 @@
<h2 class="ui header">Troubleshooting</h2>
<h3 id="enable-cross-origin-resource-sharing-cors">Enable Cross-Origin Resource Sharing (CORS)</h3>
-<p>The logs generated by UserAle is sent to a logging url 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>
+<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>
<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>
@@ -255,7 +263,7 @@
<div class="column">
<h4 class="ui inverted header">About</h4>
<div class="ui inverted link list">
- <a class="item" href="/system">System</a>
+ <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>
@@ -265,10 +273,10 @@
<div class="column">
<h4 class="ui inverted header">Docs</h4>
<div class="ui inverted link list">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserAle.pyqt</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>
@@ -277,21 +285,21 @@
<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=senssoft">GitHub</a>
- <a class="item" href="http://stackoverflow.com/questions/tagged/apache-senssoft">StackOverflow</a>
- <a class="item" href="https://issues.apache.org/jira/browse/SENSSOFT">Jira Issue Tracker</a>
- <a class="item" href="https://cwiki.apache.org/confluence/display/SENSSOFT">Project Wiki</a>
- <a class="item" href="https://twitter.com/apachesenssoft">Twitter</a>
+ <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/licenses/LICENSE-2.0.html">License</a>
<a class="item" href="http://www.apache.org/">Apache Software Foundation</a>
- <a class="item" href="http://incubator.apache.org/">Apache Incubator</a>
- <a class="item" href="http://www.apache.org/foundation/sponsorship.html">Sponsor Apache</a>
- <a class="item" href="http://www.apache.org/foundation/thanks.html">Thank you</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>
@@ -299,12 +307,23 @@
<div class="ui inverted vertical segment">
<div class="ui two column middle aligned grid">
<div class="column">
- Apache SensSoft 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 th [...]
+ 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">
- <img class="component-image" src="/images/incubator-logo-white.png">
- <br>
- Copyright © 2017 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, and the Apache Incubator logo are trademarks of The Apache Software Foundation. Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc.
+ <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>
diff --git a/content/docs/useralepy/api.html b/content/docs/useralepy/api.html
new file mode 100644
index 0000000..cde7315
--- /dev/null
+++ b/content/docs/useralepy/api.html
@@ -0,0 +1,611 @@
+<!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>API Documentation</title>
+ <meta name="description" content="Apache UserALE.PyQt5 intercepts all application events by letting the developer install an event filter in their PyQt5 application to generate detailed user ...">
+
+ <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/useralepy/api.html">
+ <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">
+ Components
+ <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="title">
+
+ <i class="dropdown icon"></i>
+ UserALE.js
+ </div>
+
+ <div class="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/API.html">UserALE.js API</a>
+
+ <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+
+ <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+
+ <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+
+ </div>
+ </div>
+
+
+ <div class="active title">
+
+ <i class="dropdown icon"></i>
+ UserALE.py
+ </div>
+
+ <div class="active 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">API Documentation</h2>
+ <p>Apache UserALE.PyQt5 intercepts all application events by letting the developer install an event filter in their PyQt5 application to generate detailed user logs. Apache UserALE.PyQt5 does not capture system level logs or events generated by a non-user (a.k.a. system and signals sent between QObjects).</p>
+
+<h3 id="apache-useralepyqt5">Apache UserALE.PyQt5</h3>
+
+<blockquote>
+
+ <div class="language-python highlighter-rouge"><pre class="highlight"><code><span class="k">class</span> <span class="nc">userale</span><span class="o">.</span><span class="n">ale</span><span class="o">.</span><span class="n">Ale</span><span class="p">(</span><span class="n">output</span><span class="o">=</span><span class="s">'userale.log'</span><span class="p">,</span> <span class="n">user</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
+<span class="n">session</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">toolname</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">toolversion</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
+<span class="n">keylog</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">interval</span><span class="o">=</span><span class="mi">5000</span><span class="p">,</span> <span class="n">resolution</span><span class="o">=</span><span class="mi">100</span><span class="p">,</span> <span class="n">shutoff</span><span class="o">=</span><span class="p">[])</span>
+</code></pre>
+ </div>
+</blockquote>
+
+<blockquote>
+ <p><strong>Bases:</strong> PyQt5.QtCore.QObject</p>
+</blockquote>
+
+<blockquote>
+ <p><strong>Parameters:</strong></p>
+ <ul>
+ <li>output – [str] The file or url path to which logs will be sent</li>
+ <li>user – [str] Identifier for the user of the application</li>
+ <li>session – [str] Session tag to track same user with multiple sessions. If a session is not provided, one will be created</li>
+ <li>toolname – [str] The application name</li>
+ <li>toolversion – [str] The application version</li>
+ <li>keylog – [bool] Should detailed key logs be recorded. Default is False</li>
+ <li>interval – [int] The minimum time interval in ms between batch transmission of logs. Default is 5000ms.</li>
+ <li>resolution – [int] Delay in ms between instances of high frequency logs like mousemoves, scrolls, etc. Default is 100ms (10Hz).</li>
+ <li>shutoff – [list] Turn off logging for specific events</li>
+ </ul>
+</blockquote>
+
+<p>An example log will appear like this:</p>
+
+<div class="language-javascript highlighter-rouge"><pre class="highlight"><code> <span class="p">{</span>
+ <span class="s1">'target'</span><span class="err">:</span> <span class="s1">'testLineEdit'</span><span class="p">,</span>
+ <span class="s1">'path'</span><span class="err">:</span> <span class="p">[</span><span class="s1">'Example'</span><span class="p">,</span> <span class="s1">'testLineEdit'</span><span class="p">],</span>
+ <span class="s1">'clientTime'</span><span class="err">:</span> <span class="s1">'2016-08-03 16:12:03.460573'</span><span class="p">,</span>
+ <span class="s1">'location'</span><span class="err">:</span> <span class="p">{</span><span class="s1">'x'</span><span class="err">:</span> <span class="mi">82</span><span class="p">,</span> <span class="s1">'y'</span><span class="err">:</span> <span class="mi">0</span><span class="p">},</span>
+ <span class="s1">'type'</span><span class="err">:</span> <span class="s1">'mousemove'</span><span class="p">,</span>
+ <span class="s1">'userAction'</span><span class="err">:</span> <span class="s1">'true'</span><span class="p">,</span>
+ <span class="s1">'details'</span> <span class="err">:</span> <span class="p">{},</span>
+ <span class="s1">'userId'</span><span class="err">:</span> <span class="s1">'userABC1234'</span><span class="p">,</span>
+ <span class="s1">'session'</span><span class="err">:</span> <span class="s1">'5ee42ccc-852c-44d9-a937-28d7901e4ead'</span><span class="p">,</span>
+ <span class="s1">'toolName'</span><span class="err">:</span> <span class="s1">'myApplication'</span><span class="p">,</span>
+ <span class="s1">'toolVersion'</span><span class="err">:</span> <span class="s1">'3.5.0'</span><span class="p">,</span>
+ <span class="s1">'useraleVersion'</span><span class="err">:</span> <span class="s1">'0.1.0'</span>
+ <span class="p">}</span>
+</code></pre>
+</div>
+
+<h4 id="aggregate">aggregate()</h4>
+<p>Sample high frequency logs at self.resolution. High frequency logs are consolidated down to a single log event to be emitted later</p>
+
+<h4 id="cleanup">cleanup()</h4>
+<p>Clean up any dangling logs in self.logs or self.hlogs</p>
+
+<h4 id="dump">dump()</h4>
+<p>Write log data to file</p>
+
+<h4 id="eventfilterobject-event">eventFilter(object, event)</h4>
+<p>Filters events for the watched widget.</p>
+
+<blockquote>
+ <p><strong>Parameters:</strong></p>
+ <ul>
+ <li>object – [QObject] The object being watched.</li>
+ <li>event – [QEvent] The event triggered by a user action.</li>
+ </ul>
+</blockquote>
+
+<blockquote>
+ <p><strong>Returns:</strong></p>
+ <ul>
+ <li>[bool] Propagate filter up if other objects needs to be handled</li>
+ </ul>
+</blockquote>
+
+<h4 id="getclienttime">getClientTime()</h4>
+<p>Capture the time the event was captured in milliseconds since the UNIX epoch (January 1, 1970 00:00:00 UTC)</p>
+
+<blockquote>
+ <p><strong>Returns:</strong></p>
+ <ul>
+ <li>[str] String representation of the time the event was captured.</li>
+ </ul>
+</blockquote>
+
+<h4 id="getlocationevent">getLocation(event)</h4>
+<p>Grab the x and y position of the mouse cursor, relative to the widget that received the event.</p>
+
+<blockquote>
+ <p><strong>Parameters:</strong></p>
+ <ul>
+ <li>event – [QEvent] The base class for all event classes.</li>
+ </ul>
+</blockquote>
+
+<blockquote>
+ <p><strong>Returns:</strong></p>
+ <ul>
+ <li>[dict] A dictionary representation of the x and y positions of the mouse cursor.</li>
+ </ul>
+</blockquote>
+
+<h4 id="getpathobject">getPath(object)</h4>
+<p>Generate the entire object hierachy from root to leaf node.</p>
+
+<blockquote>
+ <p><strong>Parameters:</strong></p>
+ <ul>
+ <li>object – [QObject] The base class for all Qt objects.</li>
+ </ul>
+</blockquote>
+
+<blockquote>
+ <p><strong>Returns:</strong></p>
+ <ul>
+ <li>[list] List of QObjects.</li>
+ </ul>
+</blockquote>
+
+<h4 id="getselectorobject">getSelector(object)</h4>
+<p>Get target object’s name (object defined by user or object’s meta class name).</p>
+
+<blockquote>
+ <p><strong>Parameters:</strong></p>
+ <ul>
+ <li>object – [QObject] The base class for all Qt objects.</li>
+ </ul>
+</blockquote>
+
+<blockquote>
+ <p><strong>Returns:</strong></p>
+ <ul>
+ <li>[str] The Qt object’s name</li>
+ </ul>
+</blockquote>
+
+<h4 id="getsenderobject">getSender(object)</h4>
+<p>Fetch the QObject who triggered the event</p>
+
+<blockquote>
+ <p><strong>Parameters:</strong></p>
+ <ul>
+ <li>object – [QObject] The object being watched.</li>
+ </ul>
+</blockquote>
+
+<blockquote>
+ <p><strong>Returns:</strong></p>
+ <ul>
+ <li>[QObject] The QObject</li>
+ </ul>
+</blockquote>
+
+<h4 id="handledrageventsevent_type-event-object">handleDragEvents(event_type, event, object)</h4>
+<p>Returns the userale log representing all drag events.</p>
+
+<blockquote>
+ <p><strong>Parameters:</strong></p>
+ <ul>
+ <li>event_type – [str] The string representation of the type of event being triggered by the user.</li>
+ <li>event – [QEvent] The base class for all event classes.</li>
+ <li>object – [QObject] The base class for all Qt objects.</li>
+ </ul>
+</blockquote>
+
+<blockquote>
+ <p><strong>Returns:</strong></p>
+ <ul>
+ <li>[dict] A userale log describing a drag event.</li>
+ </ul>
+</blockquote>
+
+<h4 id="handlekeyeventsevent_type-event-object">handleKeyEvents(event_type, event, object)</h4>
+<p>Returns the userale log representing all key events, including key name and key code.</p>
+
+<blockquote>
+ <p><strong>Parameters:</strong></p>
+ <ul>
+ <li>event_type – [str] The string representation of the type of event being triggered by the user.</li>
+ <li>event – [QEvent] The base class for all event classes.</li>
+ <li>object – [QObject] The base class for all Qt objects.</li>
+ </ul>
+</blockquote>
+
+<blockquote>
+ <p><strong>Returns:</strong></p>
+ <ul>
+ <li>[dict] A userale log describing a key event.</li>
+ </ul>
+</blockquote>
+
+<h4 id="handlemouseeventsevent_type-event-object">handleMouseEvents(event_type, event, object)</h4>
+<p>Returns the userale log representing all mouse event data.</p>
+
+<blockquote>
+ <p><strong>Parameters:</strong></p>
+ <ul>
+ <li>event_type – [str] The string representation of the type of event being triggered by the user.</li>
+ <li>event – [QEvent] The base class for all event classes.</li>
+ <li>object – [QObject] The base class for all Qt objects.</li>
+ </ul>
+</blockquote>
+
+<blockquote>
+ <p><strong>Returns:</strong></p>
+ <ul>
+ <li>[dict] A userale log describing a mouse event.</li>
+ </ul>
+</blockquote>
+
+<h4 id="handlemoveeventsevent_type-event-object">handleMoveEvents(event_type, event, object)</h4>
+<p>Returns the userale log representing all move events.</p>
+
+<blockquote>
+ <p><strong>Parameters:</strong></p>
+ <ul>
+ <li>event_type – [str] The string representation of the type of event being triggered by the user.</li>
+ <li>event – [QEvent] The base class for all event classes.</li>
+ <li>object – [QObject] The base class for all Qt objects.</li>
+ </ul>
+</blockquote>
+
+<blockquote>
+ <p><strong>Returns:</strong></p>
+ <ul>
+ <li>[dict] A userale log describing a drag event.</li>
+ </ul>
+</blockquote>
+
+<h4 id="handleresizeeventsevent_type-event-object">handleResizeEvents(event_type, event, object)</h4>
+<p>Returns the userale log representing all resize events.</p>
+
+<blockquote>
+ <p><strong>Parameters:</strong></p>
+ <ul>
+ <li>event_type – [str] The string representation of the type of event being triggered by the user.</li>
+ <li>event – [QEvent] The base class for all event classes.</li>
+ <li>object – [QObject] The base class for all Qt objects.
+<strong>Returns:</strong></li>
+ <li>[dict] A userale log describing a resize event.</li>
+ </ul>
+</blockquote>
+
+<h4 id="handlescrolleventsevent_type-event-object">handleScrollEvents(event_type, event, object)</h4>
+<p>Returns the userale log representing all scroll events.</p>
+
+<blockquote>
+ <p><strong>Parameters:</strong></p>
+ <ul>
+ <li>event_type – [str] The string representation of the type of event being triggered by the user.</li>
+ <li>event – [QEvent] The base class for all event classes.</li>
+ <li>object – [QObject] The base class for all Qt objects.</li>
+ </ul>
+</blockquote>
+
+<blockquote>
+ <p><strong>Returns:</strong></p>
+ <ul>
+ <li>[dict] A userale log describing a scroll event.</li>
+ </ul>
+</blockquote>
+
+<h4 id="timereventevent">timerEvent(event)</h4>
+<p>Routinely dump data to file or send over the network</p>
+
+<blockquote>
+ <p><strong>Parameters:</strong></p>
+ <ul>
+ <li>object – [list] List of events</li>
+ </ul>
+</blockquote>
+
+<blockquote>
+ <p><strong>Returns:</strong></p>
+ <ul>
+ <li>[void] Emit events to file</li>
+ </ul>
+</blockquote>
+
+ </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/distill/changelog.html b/content/docs/useralepy/changelog.html
similarity index 58%
copy from content/docs/distill/changelog.html
copy to content/docs/useralepy/changelog.html
index d349531..47b7e6c 100644
--- a/content/docs/distill/changelog.html
+++ b/content/docs/useralepy/changelog.html
@@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Changelog</title>
- <meta name="description" content="0.1.3 (2016-09-19) Moved to Apache. Updated all documentation. Added License headers Docker compose file added to assist deployment of ELK stack with Distill">
+ <meta name="description" content="0.1.5 (2016-09-19)">
<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,8 +16,8 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://localhost:4000/docs/distill/changelog.html">
- <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml">
+ <link rel="canonical" href="http://flagon.incubator.apache.org/docs/useralepy/changelog.html">
+ <link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
</head>
@@ -28,14 +28,14 @@
<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 SensSoft</h3>
+ <h3 class="ui inverted header item">Apache Flagon</h3>
</a>
<div class="right menu">
<div class="ui dropdown item">
Components
<div class="menu">
- <a class="item" href="/system">System</a>
+ <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>
@@ -45,10 +45,10 @@
<div class="ui dropdown item">
<a href="/docs">Docs</a>
<div class="menu">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserALE.pyqt</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>
@@ -81,7 +81,7 @@
<div class="title">
<i class="dropdown icon"></i>
- Apache SensSoft
+ Apache Flagon
</div>
<div class="content">
@@ -90,7 +90,7 @@
<a class="item" href="/docs/">About the Docs</a>
- <a class="item" href="/docs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/contributing/">Contributing</a>
</div>
</div>
@@ -100,14 +100,16 @@
<div class="title">
<i class="dropdown icon"></i>
- System
+ Stack
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/system/">Getting Started</a>
+ <a class="item" href="/docs/stack/">Getting Started</a>
+
+ <a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
</div>
</div>
@@ -141,43 +143,49 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+
+ <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
- <a class="item" href="/docs/useralejs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+
+ <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+
+ <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
</div>
</div>
- <div class="title">
+ <div class="active title">
<i class="dropdown icon"></i>
- UserALE.pyqt
+ UserALE.py
</div>
- <div class="content">
+ <div class="active content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/useralepyqt/">Installation</a>
+ <a class="item" href="/docs/useralepy/">Installation</a>
- <a class="item" href="/docs/useralepyqt/start.html">Getting Started</a>
+ <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
- <a class="item" href="/docs/useralepyqt/api.html">API Documentation</a>
+ <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
- <a class="item" href="/docs/useralepyqt/changelog.html">Changelog</a>
+ <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
</div>
</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">
@@ -187,13 +195,13 @@
<a class="item" href="/docs/distill/api.html">API Documentation</a>
- <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</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/analytics.html">Apache Distill Analytics</a>
+ <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a>
<a class="item" href="/docs/distill/changelog.html">Changelog</a>
@@ -238,31 +246,71 @@
</div>
<div class="docs-content">
<h2 class="ui header">Changelog</h2>
- <h3 id="013-2016-09-19">0.1.3 (2016-09-19)</h3>
+ <h3 id="015-2016-09-19">0.1.5 (2016-09-19)</h3>
+
<ul>
- <li>Moved to Apache.</li>
+ <li>clientTime field is represented in ISO 8601 format.</li>
+ <li>Sampling mouseenter, mouseleave, and dragmove events by resolution parameter.</li>
+ <li>Batch dumping all logs to file by interval parameter.</li>
+ <li>Added Apache license headers.</li>
<li>Updated all documentation.</li>
- <li>Added License headers</li>
- <li>Docker compose file added to assist deployment of ELK stack with Distill</li>
+ <li>Updated versioning numbers.</li>
+ <li>Added docker support.</li>
</ul>
-<h3 id="012-2016-07-22">0.1.2 (2016-07-22)</h3>
+<h3 id="014-2016-08-04">0.1.4 (2016-08-04)</h3>
+
<ul>
- <li>Moved CRUD operations from UserAle model to Brew model.</li>
- <li>Added API specs to segment UserAle data from Elasticsearch</li>
- <li>Added deployment instructions</li>
+ <li>New events Apache UserAle is tracking:
+ <ul>
+ <li>move</li>
+ <li>resize</li>
+ <li>scroll</li>
+ </ul>
+ </li>
+ <li>Remove timer from dragdrop log due to incorrect time being recorded.</li>
+ <li>Session id is autogenerated if not passed into configuration.</li>
</ul>
-<h3 id="011-2016-06-14">0.1.1 (2016-06-14)</h3>
+<h3 id="013-2016-08-02">0.1.3 (2016-08-02)</h3>
+
<ul>
- <li>Completed index route for status endpoint which lists all applications registered and their document count segmented by type.</li>
- <li>Updated setup.py to reference deploy scripts</li>
- <li>Example configuration to deploy Distll with Gunicorn and Nginx for Linux/Mac users</li>
- <li>Added UserAle and Stout classes.</li>
- <li>Updated requirements.txt for deployment.</li>
+ <li>New events Apache UserAle is tracking:
+ <ul>
+ <li>mouseenter</li>
+ <li>mouseleave</li>
+ </ul>
+ </li>
</ul>
-<h3 id="010-2016-04-01">0.1.0 (2016-04-01)</h3>
+<h3 id="012-2016-08-01">0.1.2 (2016-08-01)</h3>
+
+<ul>
+ <li>The elapsed time for a drag event is being recorded in the dragdrop log.</li>
+</ul>
+
+<h3 id="011-2016-07-29">0.1.1 (2016-07-29)</h3>
+
+<ul>
+ <li>All logs will be stored to file called userale.log (configurable).</li>
+ <li>Users can specify which events to capture by passing in a list of event keys when instantiating Apache UserAle.</li>
+ <li>These are the events Apache UserAle is tracking:
+ <ul>
+ <li>mouseup</li>
+ <li>mousedown</li>
+ <li>mousemove</li>
+ <li>keypress (optional)</li>
+ <li>keydown (optional)</li>
+ <li>dragenter</li>
+ <li>dragleave</li>
+ <li>dragmove</li>
+ <li>dragdrop</li>
+ </ul>
+ </li>
+</ul>
+
+<h3 id="010-2016-06-24">0.1.0 (2016-06-24)</h3>
+
<ul>
<li>Initial release.</li>
</ul>
@@ -278,7 +326,7 @@
<div class="column">
<h4 class="ui inverted header">About</h4>
<div class="ui inverted link list">
- <a class="item" href="/system">System</a>
+ <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>
@@ -288,10 +336,10 @@
<div class="column">
<h4 class="ui inverted header">Docs</h4>
<div class="ui inverted link list">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserAle.pyqt</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>
@@ -300,21 +348,21 @@
<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=senssoft">GitHub</a>
- <a class="item" href="http://stackoverflow.com/questions/tagged/apache-senssoft">StackOverflow</a>
- <a class="item" href="https://issues.apache.org/jira/browse/SENSSOFT">Jira Issue Tracker</a>
- <a class="item" href="https://cwiki.apache.org/confluence/display/SENSSOFT">Project Wiki</a>
- <a class="item" href="https://twitter.com/apachesenssoft">Twitter</a>
+ <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/licenses/LICENSE-2.0.html">License</a>
<a class="item" href="http://www.apache.org/">Apache Software Foundation</a>
- <a class="item" href="http://incubator.apache.org/">Apache Incubator</a>
- <a class="item" href="http://www.apache.org/foundation/sponsorship.html">Sponsor Apache</a>
- <a class="item" href="http://www.apache.org/foundation/thanks.html">Thank you</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>
@@ -322,12 +370,23 @@
<div class="ui inverted vertical segment">
<div class="ui two column middle aligned grid">
<div class="column">
- Apache SensSoft 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 th [...]
+ 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">
- <img class="component-image" src="/images/incubator-logo-white.png">
- <br>
- Copyright © 2017 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, and the Apache Incubator logo are trademarks of The Apache Software Foundation. Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc.
+ <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>
diff --git a/content/docs/distill/index.html b/content/docs/useralepy/index.html
similarity index 50%
copy from content/docs/distill/index.html
copy to content/docs/useralepy/index.html
index 6cd8185..d6dcfcd 100644
--- a/content/docs/distill/index.html
+++ b/content/docs/useralepy/index.html
@@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Installation</title>
- <meta name="description" content="Installing Apache Distill">
+ <meta name="description" content="Apache UserALE.PyQt5 is the UserALE client for PyQt5 applications. It provides an easy way to generate highly detailed log streams from any PyQt5 application.">
<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,8 +16,8 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://localhost:4000/docs/distill/">
- <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml">
+ <link rel="canonical" href="http://flagon.incubator.apache.org/docs/useralepy/">
+ <link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
</head>
@@ -28,14 +28,14 @@
<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 SensSoft</h3>
+ <h3 class="ui inverted header item">Apache Flagon</h3>
</a>
<div class="right menu">
<div class="ui dropdown item">
Components
<div class="menu">
- <a class="item" href="/system">System</a>
+ <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>
@@ -45,10 +45,10 @@
<div class="ui dropdown item">
<a href="/docs">Docs</a>
<div class="menu">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserALE.pyqt</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>
@@ -81,7 +81,7 @@
<div class="title">
<i class="dropdown icon"></i>
- Apache SensSoft
+ Apache Flagon
</div>
<div class="content">
@@ -90,7 +90,7 @@
<a class="item" href="/docs/">About the Docs</a>
- <a class="item" href="/docs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/contributing/">Contributing</a>
</div>
</div>
@@ -100,14 +100,16 @@
<div class="title">
<i class="dropdown icon"></i>
- System
+ Stack
</div>
<div class="content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/system/">Getting Started</a>
+ <a class="item" href="/docs/stack/">Getting Started</a>
+
+ <a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
</div>
</div>
@@ -141,43 +143,49 @@
<a class="item" href="/docs/useralejs/">Getting Started</a>
- <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+ <a class="item" href="/docs/useralejs/build.html">UserALE.js Build and Test</a>
+
+ <a class="item" href="/docs/useralejs/API.html">UserALE.js API</a>
+
+ <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+
+ <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
- <a class="item" href="/docs/useralejs/contributing.html">Contributing</a>
+ <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
</div>
</div>
- <div class="title">
+ <div class="active title">
<i class="dropdown icon"></i>
- UserALE.pyqt
+ UserALE.py
</div>
- <div class="content">
+ <div class="active content">
<div class="ui inverted bulleted list docs-list">
- <a class="item" href="/docs/useralepyqt/">Installation</a>
+ <a class="item" href="/docs/useralepy/">Installation</a>
- <a class="item" href="/docs/useralepyqt/start.html">Getting Started</a>
+ <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
- <a class="item" href="/docs/useralepyqt/api.html">API Documentation</a>
+ <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
- <a class="item" href="/docs/useralepyqt/changelog.html">Changelog</a>
+ <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
</div>
</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">
@@ -187,13 +195,13 @@
<a class="item" href="/docs/distill/api.html">API Documentation</a>
- <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</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/analytics.html">Apache Distill Analytics</a>
+ <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a>
<a class="item" href="/docs/distill/changelog.html">Changelog</a>
@@ -238,17 +246,27 @@
</div>
<div class="docs-content">
<h2 class="ui header">Installation</h2>
- <h3 id="installing-apache-distill">Installing Apache Distill</h3>
+ <p>Apache UserALE.PyQt5 is the UserALE client for PyQt5 applications. It provides an easy way to generate highly detailed log streams from any PyQt5 application.</p>
+
+<h3 id="requirements">Requirements</h3>
-<p>The first step is to install Apache Distill. First, checkout the latest version of Apache Distill.</p>
+<ul>
+ <li>Python 3.5 or above</li>
+ <li>PyQt5, version 5.3 or above</li>
+ <li>pip3, see requirements.txt</li>
+</ul>
-<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>git clone https://git-wip-us.apache.org/repos/asf/incubator-senssoft-distill.git
+<h3 id="installing-useralepyqt5">Installing UserALE.PyQt5</h3>
+
+<p>The first step is to install Apache UserALE.PyQt5. First, checkout the latest version of Apache UserALE.PyQt5 from our Git repository.</p>
+
+<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>git clone https://gitbox.apache.org/repos/asf/incubator-flagon-userale-pyqt5.git
</code></pre>
</div>
-<p>Apache Distill is a python project, so it can be installed like any other python library. Several operating systems (Mac OS X, Major Versions of Linux/BSD) have Python pre-installed, so you should just have to run</p>
+<p>Apache UserALE.PyQt5 is a python3 project, so it can be installed like any other python library. Several operating systems (Mac OS X, Major Versions of Linux/BSD) have Python3 pre-installed, so you should just have to run</p>
-<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>easy_install distill
+<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>easy_install3 userale
</code></pre>
</div>
@@ -256,31 +274,36 @@
</code></pre>
</div>
-<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>pip install distill
+<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>pip3 install userale
</code></pre>
</div>
-<p>Users are strongly recommended to install Apache Distill in a virtualenv. Instructions to setup an virtual environment will be explained below.</p>
+<p>Users are strongly recommended to install Apache UserALE.PyQt5 in a virtualenv. Instructions to setup an virtual environment will be explained below.</p>
+
+<blockquote>
+ <p><strong>Note</strong>
+Apache UserALE.PyQt5 requires that PyQt5 and the Qt5 bindings has been installed. Instructions to install PyQt5 and Qt5 in a virtual environment will be left to the user.</p>
+</blockquote>
<blockquote>
- <p><strong>Note</strong>&
-When the package is installed via easy_install or pip this function will be bound to the distill executable in the Python installation’s bin directory (on Windows - the Scripts directory).</p>
+ <p><strong>Note</strong>
+When the package is installed via easy_install3 or pip3 this function will be bound to the userale executable in the Python installation’s bin directory (on Windows - the Scripts directory).</p>
</blockquote>
-<h3 id="installing-apache-distill-in-an-virtual-environment">Installing Apache Distill in an Virtual Environment</h3>
+<h3 id="installing-apache-useralepyqt5-in-an-virtual-environment">Installing Apache UserALE.PyQt5 in an Virtual Environment</h3>
-<p>virtualenv is a tool to create isolated Python environments. virtualenv creates a folder which contains all the necessary executables to use the packages that the Apache Distill project would need.</p>
+<p>There are multiple ways to create virtual environments for a Python3 application. virtualenv is a one of those tools to create isolated Python environments. virtualenv creates a folder which contains all the necessary executables to use the packages that the UserAle project would need.</p>
-<p>Install virtualenv via pip:</p>
+<p>Start by changing directory into the root of Apache UserALE.PyQt5’s project directory, and then use the virtualenv command-line tool to create a new environment:</p>
-<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>sudo env/bin/pip install virtualenv
+<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>virtualenv --python<span class="o">=</span>/usr/bin/python3 env
</code></pre>
</div>
-<p>Start by changing directory into the root of Apache Distill’s project directory, and then use the virtualenv command-line tool to create a new environment:</p>
+<p>Optionally, Python3 has built in support for virtual environments.</p>
<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>mkdir env
- <span class="nv">$ </span>virtualenv env
+ <span class="nv">$ </span>python3 -m venv env
</code></pre>
</div>
@@ -290,21 +313,15 @@ When the package is installed via easy_install or pip this function will be boun
</code></pre>
</div>
-<p>Install Apache Distill requirements:</p>
+<p>Install UserAle requirements:</p>
-<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>env/bin/pip -r requirements.txt
+<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>env/bin/pip3 install -r requirements.txt
</code></pre>
</div>
<p>To build the source code and run all unit tests.</p>
-<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>env/bin/python setup.py develop <span class="nb">test</span>
-</code></pre>
-</div>
-
-<p>Launch local Apache Distill server, running on localhost:8090:</p>
-
-<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>env/bin/dev
+<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>env/bin/python3 setup.py develop <span class="nb">test</span>
</code></pre>
</div>
@@ -314,96 +331,31 @@ When the package is installed via easy_install or pip this function will be boun
</code></pre>
</div>
-<h3 id="running-apache-distill-on-docker-compose">Running Apache Distill on Docker Compose</h3>
-<p>From the project directory, start up Apache Distill in the background.</p>
-
-<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>docker-compose up -d
- <span class="nv">$ </span>docker-compose ps
-</code></pre>
-</div>
-
-<p>To stop services once you’ve finished with them:</p>
-
-<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>docker-compose stop
-</code></pre>
-</div>
-
-<h3 id="deployment-with-nginx-and-gunicorn">Deployment with Nginx and Gunicorn</h3>
-
-<p>I will describe a setup with nginx as a web server on Ubuntu. A web server cannot communicate directly with a Flask application such as Apache Distill. Thus gunicorn will be used to act as a medium between the web server and Apache Distill. Gunicorn is like an application web server that will be running behind nginx, and it is WSGI compatible. It can communicate with applications that support WSGI – Flask, Django, etc.</p>
-
-<p>Install requirements.</p>
-
-<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>sudo apt-get update
- <span class="nv">$ </span>sudo apt-get install -y python python-pip nginx gunicorn
-</code></pre>
-</div>
-
-<p>Create a directory to store the project.</p>
-
-<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>sudo mkdir /home/pubic_html <span class="o">&&</span> <span class="nb">cd</span> /home/public_html
-</code></pre>
-</div>
-
-<p>Download the project from the GitHub repository and copy the application to the /home/public_html directory.</p>
-
-<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>git clone https://git-wip-us.apache.org/repos/asf
- /incubator-senssoft-distill.git /home/public_html
-</code></pre>
-</div>
-
-<p>Install Apache Distill’s requirements either globally or in a virutal environment:</p>
-
-<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>env/bin/pip install -r requirements.txt
-</code></pre>
-</div>
-
-<p>Apache Distill has provided an nginx configuration file located in distill/deploy/nginx.conf.</p>
-
-<p>Gunicorn will use port 8000 and handle the incoming HTTP requests.</p>
-
-<p>Restart nginx to load the configuration changes.</p>
-
-<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>sudo /etc/init.d/nginx restart
-</code></pre>
-</div>
-
-<p>Run gunicorn on port 8000.</p>
-
-<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>gunicorn --workers 4 --bind unix:distill.sock -m 007 deploy/run_server:app
-</code></pre>
-</div>
-
-<p>Start a new browser instance and navigate to http://localhost.</p>
-
<h3 id="installing-documentation">Installing Documentation</h3>
-<p>To save yourself the trouble, all up to date documentation is available at https://draperlaboratory.github.io/distill/.</p>
-
-<p>However, if you want to manully build the documentation, the instructions are below.</p>
-
<p>First, install the documentation dependencies:</p>
-<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>env/bin/pip install -r doc_requirements.txt
+<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>env/bin/pip3 install -r doc_requirements.txt
</code></pre>
</div>
-<p>To build Apache Distill’s documentation, create a directory at the root level of /distill called distill-docs.</p>
+<p>To build Apache UserALE.PyQt5’s documentation, create a directory at the root level of /userale.pyqt5 called userale.pyqt5-docs.</p>
-<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>mkdir distill-docs & <span class="nb">cd </span>distill-docs
+<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>mkdir userale.pyqt5-docs & <span class="nb">cd </span>userale.pyqt5-docs
</code></pre>
</div>
-<p>Execute build command:</p>
+<p>Execute build command from inside the top-level doc/ directory:</p>
-<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="c"># Inside top-level docs/ directory.</span>
- <span class="nv">$ </span>make html
+<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>make html
</code></pre>
</div>
-<p>This should build the documentation in your shell, and output HTML. At then end, it should say something about documents being ready in distill-docs/html. You can now open them in your browser by typing</p>
+<p>This should build the documentation in your shell, and output HTML. At then end, it should say something about documents being ready in userale.pyqt5-docs/html.</p>
-<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>open distill-docs/html/index.html
+<p>You can now open them in your browser by typing</p>
+
+<div class="language-shell highlighter-rouge"><pre class="highlight"><code> <span class="nv">$ </span>open userale.pyqt5-docs/html/index.html
</code></pre>
</div>
@@ -418,7 +370,7 @@ When the package is installed via easy_install or pip this function will be boun
<div class="column">
<h4 class="ui inverted header">About</h4>
<div class="ui inverted link list">
- <a class="item" href="/system">System</a>
+ <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>
@@ -428,10 +380,10 @@ When the package is installed via easy_install or pip this function will be boun
<div class="column">
<h4 class="ui inverted header">Docs</h4>
<div class="ui inverted link list">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserAle.pyqt</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>
@@ -440,21 +392,21 @@ When the package is installed via easy_install or pip this function will be boun
<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=senssoft">GitHub</a>
- <a class="item" href="http://stackoverflow.com/questions/tagged/apache-senssoft">StackOverflow</a>
- <a class="item" href="https://issues.apache.org/jira/browse/SENSSOFT">Jira Issue Tracker</a>
- <a class="item" href="https://cwiki.apache.org/confluence/display/SENSSOFT">Project Wiki</a>
- <a class="item" href="https://twitter.com/apachesenssoft">Twitter</a>
+ <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/licenses/LICENSE-2.0.html">License</a>
<a class="item" href="http://www.apache.org/">Apache Software Foundation</a>
- <a class="item" href="http://incubator.apache.org/">Apache Incubator</a>
- <a class="item" href="http://www.apache.org/foundation/sponsorship.html">Sponsor Apache</a>
- <a class="item" href="http://www.apache.org/foundation/thanks.html">Thank you</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>
@@ -462,12 +414,23 @@ When the package is installed via easy_install or pip this function will be boun
<div class="ui inverted vertical segment">
<div class="ui two column middle aligned grid">
<div class="column">
- Apache SensSoft 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 th [...]
+ 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">
- <img class="component-image" src="/images/incubator-logo-white.png">
- <br>
- Copyright © 2017 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, and the Apache Incubator logo are trademarks of The Apache Software Foundation. Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc.
+ 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>
diff --git a/content/docs/useralepy/start.html b/content/docs/useralepy/start.html
new file mode 100644
index 0000000..4e1feaa
--- /dev/null
+++ b/content/docs/useralepy/start.html
@@ -0,0 +1,383 @@
+<!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>Getting Started</title>
+ <meta name="description" content="Instrumenting Your Application Globally with Apache UserALE.PyQt5">
+
+ <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/useralepy/start.html">
+ <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">
+ Components
+ <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="title">
+
+ <i class="dropdown icon"></i>
+ UserALE.js
+ </div>
+
+ <div class="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/API.html">UserALE.js API</a>
+
+ <a class="item" href="/docs/useralejs/modifying.html">Modifying UserALE.js</a>
+
+ <a class="item" href="/docs/useralejs/dataschema.html">UserALE.js Data Schema</a>
+
+ <a class="item" href="/docs/useralejs/troubleshooting.html">Troubleshooting</a>
+
+ </div>
+ </div>
+
+
+ <div class="active title">
+
+ <i class="dropdown icon"></i>
+ UserALE.py
+ </div>
+
+ <div class="active 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">Getting Started</h2>
+ <h3 id="instrumenting-your-application-globally-with-apache-useralepyqt5">Instrumenting Your Application Globally with Apache UserALE.PyQt5</h3>
+
+<p>It’s very simple to instrument a PyQt5 application with Apache UserALE.PyQt5. Simply import the Apache UserALE.PyQt5 library and register it with your application.</p>
+
+<p>Below is an example PyQt5 application taken from ZetCode PyQt5 tutorial instrumented with Apache UserALE.PyQt5.</p>
+
+<div class="language-python highlighter-rouge"><pre class="highlight"><code> <span class="kn">import</span> <span class="nn">sys</span>
+ <span class="kn">from</span> <span class="nn">PyQt5.QtWidgets</span> <span class="kn">import</span> <span class="n">QWidget</span><span class="p">,</span> <span class="n">QLabel</span><span class="p">,</span> <span class="n">QPushButton</span><span class="p">,</span> <span class="n">QApplication</span><span class="p">,</span> <span class="n">QMessageBox</span>
+ <span class="kn">from</span> <span class="nn">PyQt5.QtCore</span> <span class="kn">import</span> <span class="n">QCoreApplication</span><span class="p">,</span> <span class="n">QObject</span><span class="p">,</span> <span class="n">QEvent</span>
+
+ <span class="kn">from</span> <span class="nn">userale.ale</span> <span class="kn">import</span> <span class="n">Ale</span>
+
+ <span class="k">class</span> <span class="nc">TestApplication</span> <span class="p">(</span><span class="n">QWidget</span><span class="p">):</span>
+
+ <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">__init__</span><span class="p">()</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">initUI</span><span class="p">()</span>
+
+ <span class="k">def</span> <span class="nf">initUI</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="n">qbtn</span> <span class="o">=</span> <span class="n">QPushButton</span><span class="p">(</span><span class="s">'Quit'</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span>
+ <span class="n">qbtn</span><span class="o">.</span><span class="n">setObjectName</span> <span class="p">(</span><span class="s">"testApplicationButton"</span><span class="p">)</span>
+ <span class="n">qbtn</span><span class="o">.</span><span class="n">clicked</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="n">QCoreApplication</span><span class="o">.</span><span class="n">instance</span><span class="p">()</span><span class="o">.</span><span class="n">quit</span><span class="p">)</span>
+ <span class="n">qbtn</span><span class="o">.</span><span class="n">resize</span><span class="p">(</span><span class="n">qbtn</span><span class="o">.</span><span class="n">sizeHint</span><span class="p">())</span>
+ <span class="n">qbtn</span><span class="o">.</span><span class="n">move</span><span class="p">(</span><span class="mi">50</span><span class="p">,</span> <span class="mi">50</span><span class="p">)</span>
+
+ <span class="bp">self</span><span class="o">.</span><span class="n">setGeometry</span><span class="p">(</span><span class="mi">300</span><span class="p">,</span> <span class="mi">300</span><span class="p">,</span> <span class="mi">250</span><span class="p">,</span> <span class="mi">150</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">setWindowTitle</span><span class="p">(</span><span class="s">'Quit button'</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span class="n">show</span><span class="p">()</span>
+
+ <span class="k">if</span> <span class="n">__name__</span> <span class="o">==</span> <span class="s">'__main__'</span><span class="p">:</span>
+ <span class="n">app</span> <span class="o">=</span> <span class="n">QApplication</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">)</span>
+ <span class="n">ex</span> <span class="o">=</span> <span class="n">TestApplication</span><span class="p">()</span>
+ <span class="c"># Initiate Apache UserALE.PyQt5</span>
+ <span class="n">ale</span> <span class="o">=</span> <span class="n">Ale</span> <span class="p">(</span><span class="n">output</span><span class="o">=</span><span class="s">"mouse.log"</span><span class="p">,</span> <span class="n">user</span><span class="o">=</span><span class="s">"testUser"</span><span class="p">,</span> <span class="n">toolversion</span><span class="o">=</span><span class="s">"0.0.1"</span><span class="p">)</span>
+ <span class="c"># install globally</span>
+ <span class="n">app</span><span class="o">.</span><span class="n">installEventFilter</span> <span class="p">(</span><span class="n">ale</span><span class="p">)</span>
+
+ <span class="n">sys</span><span class="o">.</span><span class="nb">exit</span> <span class="p">(</span><span class="n">app</span><span class="o">.</span><span class="n">exec_</span><span class="p">())</span>
+</code></pre>
+</div>
+
+<p>Before we enter the mainloop of the application, UserAle needs to register the application to be instrumented. Simply instantiate Apache UserALE.PyQt5 and install it as an event filter in your application.</p>
+
+<div class="language-python highlighter-rouge"><pre class="highlight"><code> <span class="c"># Initiate UserAle</span>
+ <span class="n">ale</span> <span class="o">=</span> <span class="n">Ale</span> <span class="p">(</span><span class="n">output</span><span class="o">=</span><span class="s">"mouse.log"</span><span class="p">,</span> <span class="n">user</span><span class="o">=</span><span class="s">"testUser"</span><span class="p">,</span> <span class="n">toolversion</span><span class="o">=</span><span class="s">"0.0.1"</span><span class="p">)</span>
+ <span class="c"># install globally</span>
+ <span class="n">app</span><span class="o">.</span><span class="n">installEventFilter</span> <span class="p">(</span><span class="n">ale</span><span class="p">)</span>
+</code></pre>
+</div>
+
+<h3 id="instrumenting-your-application-manually-with-apache-useralepyqt5">Instrumenting Your Application Manually with Apache UserALE.PyQt5</h3>
+
+<p><em>Todo:</em> Write guidelines for instrumenting specific PyQt5 Widgets with Apache UserALE.PyQt5.</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/feed.xml b/content/feed.xml
index 459cf32..d0e8baf 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://localhost:4000/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://localhost:4000/feed.xml" rel="self" type="application/atom+xml" /><link href="http://localhost:4000/" rel="alternate" type="text/html" /><updated>2017-01-12T12:02:56-05:00</updated><id>http://localhost:4000//</id><title type="html">Apache SensSo [...]
+<?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 [...]
diff --git a/content/images/incubator-logo-white.jpg b/content/images/incubator-logo-white.jpg
new file mode 100644
index 0000000..da7369b
Binary files /dev/null and b/content/images/incubator-logo-white.jpg differ
diff --git a/content/images/metricBeat.png b/content/images/metricBeat.png
new file mode 100644
index 0000000..f6f9091
Binary files /dev/null and b/content/images/metricBeat.png differ
diff --git a/content/images/mouseOverBench1.png b/content/images/mouseOverBench1.png
new file mode 100644
index 0000000..6e2a9d4
Binary files /dev/null and b/content/images/mouseOverBench1.png differ
diff --git a/content/images/mouseOverBench2.png b/content/images/mouseOverBench2.png
new file mode 100644
index 0000000..61de35b
Binary files /dev/null and b/content/images/mouseOverBench2.png differ
diff --git a/content/images/stack.png b/content/images/stack.png
new file mode 100644
index 0000000..6849d34
Binary files /dev/null and b/content/images/stack.png differ
diff --git a/content/index.html b/content/index.html
index a9984a7..90343d7 100644
--- a/content/index.html
+++ b/content/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 SensSoft</title>
- <meta name="description" content="The homepage for Apache SensSoft">
+ <title>Apache Flagon</title>
+ <meta name="description" content="The homepage for Apache Flagon">
<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,8 +16,8 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://localhost:4000/">
- <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml">
+ <link rel="canonical" href="http://flagon.incubator.apache.org/">
+ <link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
</head>
@@ -28,14 +28,14 @@
<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 SensSoft</h3>
+ <h3 class="ui inverted header item">Apache Flagon</h3>
</a>
<div class="right menu">
<div class="ui dropdown item">
Components
<div class="menu">
- <a class="item" href="/system">System</a>
+ <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>
@@ -45,10 +45,10 @@
<div class="ui dropdown item">
<a href="/docs">Docs</a>
<div class="menu">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserALE.pyqt</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>
@@ -64,7 +64,7 @@
<div class="main-wrapper">
<div id="main-masthead" class="ui masthead padded center aligned inverted vertical segment">
- <h1 class="ui header">Apache SensSoft</h1>
+ <h1 class="ui header">Apache Flagon</h1>
<h2 class="ui header">Instrument Software. Understand Humans.</h2>
</div>
@@ -72,19 +72,19 @@
<div class="ui very padded vertical segment">
<div class="ui center aligned text container">
<p>
- Apache Software as a Sensor™ (SensSoft) incorporates a number of components that work together to provide user-experience researchers, project managers and software developers insights about how web applications are used. Each of the components of Apache SensSoft is made available through its own repository, allowing its distinctive capabilities to grow organically. A simplified system architecture ensures that the components will continue to share data and work together efficientl [...]
+ Apache Flagon is an open-soure, thin-client behavioral logging capability useful for business analytics, usage analytics, usability and user testing. It's also for science into how information technology is used. Flagon supports a range of streamlined deployment schemas ranging from single webpage analysis to enterprise level monitoring, making it easy to collect data without heavy modification of your own code. Using Elastic products, Flagon makes it easy to scale, integrate other [...]
</p>
<br>
- <a class="ui big red button" href="/system">
- Learn More
+ <a class="ui big red button" href="/docs/stack/">
+ Get Started
</a>
<a class="ui big blue button" href="/releases">
- Download SensSoft
+ Download Flagon
</a>
- <a class="ui big yellow button" href="mailto:user-subscribe@senssoft.incubator.apache.org">
- Sign Up For News
+ <a class="ui big yellow button" href="mailto:dev-subscribe@flagon.incubator.apache.org">
+ Join our Dev List
</a>
</div>
</div>
@@ -93,7 +93,7 @@
<div class="ui text container">
<div class="ui two column middle aligned grid">
<div class="column">
- With a single line of code, capture all of your users’ behavior on your web page with enough resolution and granularity for advanced behavioral modeling. Apache UserALE is a free, open-source application for standard user event tracking, but is specially tailored for capturing behavior in web applications build for productivity—data analysis, logistics, system monitoring, and service provisioning.
+ With a single line of code capture all of your users' behavior on your web page with enough resolution and granularity for advanced behavioral modeling. Apache UserALE is Flagon's free, open-source application for thin-client behavioral logging. It's perfect for business analytics and enterprise application monitoring, but powerful enough for UI/UX research and user-testing. Check out our slick demo!
</div>
<div class="center aligned column">
<a href="/userale">
@@ -166,7 +166,7 @@
<div class="field">
<div id="demo-dropdown" class="ui fluid selection dropdown">
- <input type="hidden" name="senssoft-component">
+ <input type="hidden" name="flagon-component">
<i class="dropdown icon"></i>
<div class="default text">Select Component</div>
<div class="menu">
@@ -249,7 +249,7 @@
</a>
</div>
<div class="column">
- Process and control your own user event data. Apache Distill is a scalable, customizable analytics stack built in Python that allows you to segment your user data and generate both simple usage statistics on different features of your application and complex graph models of user workflow. Distill provides an easy access point into databases storing your user event data and packages data for discovery through visual analytics.
+ Process and control your own user event data. Apache Distill is Flagon's experimental, customizable analytics stack built in Python that interfaces directly with Elastic. It gives data scientists and developers the power to segment and model user data in Python or push modeling output to visual analytic applications. From simple aggregations to complex graph models of user workflow, Distill provides access to user data and the python libraries you love in a streamlined analytical [...]
</div>
</div>
</div>
@@ -259,7 +259,7 @@
<div class="ui text container">
<div class="ui two column middle aligned grid">
<div class="column">
- Explore your users’ behavior and discover trends through visual analytics. Apache TAP is a customizable visual analytics application that allows you to see trends in usage across users of different types, usage trends across different versions of your application, and rich visualizations of users’ workflow. Tailor visual analytics to your needs customizing TAP with your favorite D3 visualizations.
+ Apache TAP is Flagon's experimental collection of specially modified D3 visual analytic libraries for exploring Apache UserALE.js data. You can explore them in our sandbox environment, or embed them in your own applications. With TAP, Gain insight from advanced sequential and graph models and reveal trends in usage across users of different types and experience, and trends across different versions of your application. Try out our Bowie plot demo below!
</div>
<div class="center aligned column">
<a href="/tap">
@@ -384,7 +384,7 @@
<div class="ui text container">
<h2 class="ui inverted header">About the Project</h2>
<p>
- Apache SensSoft is a user activity logging and analytics system that enables developers to instrument and extract design and user insights from their applications. It was originally developed at Draper for DARPA's XDATA program as a means of evaluating and improving tools for big data analysis and exploration. Commercially available as Draper's Software as a Sensor™, Apache SensSoft aims to provide a more complete and customizable user analytics platform.
+ Apache Flagon is a free and open-source, thin-client behavioral logging solution for business analytics, usage analytics, usability testing and scientific research. Formerly named Apache SensSoft, Flagon had its start at Draper for DARPA's XDATA program and represents the hard-work and innovations of an interdisciplinary team of data scientists, psychologists, developers and system architects. Apache Flagon is maintained by the people that love it under the mentorship and guidance [...]
</p>
</div>
</div>
@@ -397,7 +397,7 @@
<div class="column">
<h4 class="ui inverted header">About</h4>
<div class="ui inverted link list">
- <a class="item" href="/system">System</a>
+ <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>
@@ -407,10 +407,10 @@
<div class="column">
<h4 class="ui inverted header">Docs</h4>
<div class="ui inverted link list">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserAle.pyqt</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>
@@ -419,21 +419,21 @@
<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=senssoft">GitHub</a>
- <a class="item" href="http://stackoverflow.com/questions/tagged/apache-senssoft">StackOverflow</a>
- <a class="item" href="https://issues.apache.org/jira/browse/SENSSOFT">Jira Issue Tracker</a>
- <a class="item" href="https://cwiki.apache.org/confluence/display/SENSSOFT">Project Wiki</a>
- <a class="item" href="https://twitter.com/apachesenssoft">Twitter</a>
+ <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/licenses/LICENSE-2.0.html">License</a>
<a class="item" href="http://www.apache.org/">Apache Software Foundation</a>
- <a class="item" href="http://incubator.apache.org/">Apache Incubator</a>
- <a class="item" href="http://www.apache.org/foundation/sponsorship.html">Sponsor Apache</a>
- <a class="item" href="http://www.apache.org/foundation/thanks.html">Thank you</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>
@@ -441,12 +441,23 @@
<div class="ui inverted vertical segment">
<div class="ui two column middle aligned grid">
<div class="column">
- Apache SensSoft 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 th [...]
+ 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">
- <img class="component-image" src="/images/incubator-logo-white.png">
- <br>
- Copyright © 2017 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, and the Apache Incubator logo are trademarks of The Apache Software Foundation. Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc.
+ 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>
diff --git a/content/releases/index.html b/content/releases/index.html
index 4512cfa..7c28df5 100644
--- a/content/releases/index.html
+++ b/content/releases/index.html
@@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Releases</title>
- <meta name="description" content="The homepage for Apache SensSoft">
+ <meta name="description" content="The homepage for Apache Flagon">
<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,8 +16,8 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://localhost:4000/releases/">
- <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml">
+ <link rel="canonical" href="http://flagon.incubator.apache.org/releases/">
+ <link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
</head>
@@ -28,14 +28,14 @@
<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 SensSoft</h3>
+ <h3 class="ui inverted header item">Apache Flagon</h3>
</a>
<div class="right menu">
<div class="ui dropdown item">
Components
<div class="menu">
- <a class="item" href="/system">System</a>
+ <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>
@@ -45,10 +45,10 @@
<div class="ui dropdown item">
<a href="/docs">Docs</a>
<div class="menu">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserALE.pyqt</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>
@@ -68,20 +68,103 @@
</h1>
<div class="page-content">
<p>
- Apache SensSoft is currently preparing for its first full release. Stay tuned and sign up for our mailing lists to keep up to date!
+ Below you can find the official Apache Flagon release distrbution artifacts. Older releases can be found at the <a heref="http://archive.apache.org/dist/incubator/flagon/">Apache Flagon Archives</a>.
+
+ For ongoing development and future release announcements, stay tuned and sign up for our <a href="./community.html">mailing lists</a> to keep up to date!
</p>
- <p>
- You can always find current SensSoft code in our <a href="http://incubator.apache.org/projects/senssoft.html">git repositories</a>, or on <a href="https://github.com/apache?q=senssoft">github</a>.
+<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>.
+
+ The CHANGELOG file shipped with each artifact can be consulted for more information on the list of updates in each release.
+
+ Apache Flagon artifacts are always distributed under the <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache License, version 2.0</a>.
+</p>
+
+<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>.
+
+<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.
+
+<table class="table">
+ <thead>
+ <tr>
+ <th align="left">Version</th>
+ <th align="left">Download Artifact</th>
+ <th align="left">ASCII signature</th>
+ <th align="left">SHA512 Checksum</th>
+ </tr>
+ </thead>
+ <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>
+ </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>
+ </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>
+ </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>
+ </tr>
+ </tbody>
+</table>
+
+<h1>Verify Releases</h1>
+<p>
+ It is essential that you verify the integrity of the downloaded files using the PGP, and/or SHA signatures. published with every Gora release.
+
+ Please read <a href="http://httpd.apache.org/dev/verification.html">Verifying Apache HTTP Server Releases</a> for more information on why you should verify our releases.
+
+ We strongly recommend you verify your downloads with at least PGP. Guidance for doing so is provided below.
+</p>
+
+<h2>PGP Signatures</h2>
+<p>
+ The PGP signatures can be verified using PGP or GPG. First download the <a href="http://www.apache.org/dist/incubator/flagon/KEYS">KEYS</a> as well as the asc signature file for the relevant distribution.
+
+ <b>N.B.</b> Make sure you get these files from the main distribution directory, rather than from a mirror. Then verify the signatures using the following example</p>
+
+<p>
+ <code>
+ $ gpg --import KEYS
+ </code>
+</p>
+<p>
+ <code>
+ $ gpg --verify apache-flagon-useralejs-1.0.0-src.zip.asc
+ </code>
</p>
-<a class="ui blue button" href="mailto:dev-subscribe@senssoft.incubator.apache.org">
- Dev List
-</a>
-<a class="ui yellow button" href="mailto:users-subscribe@senssoft.incubator.apache.org">
- User List
-</a>
+<p>
+ The files in the most recent release are signed by Lewis John McGibbney (CODE SIGNING KEY) lewismc@apache.org 48BAEBF6
+</p>
+<h2>SHA512 Signatures</h2>
+<p>
+ 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>
+</p>
+<p>
+ ... output should match the string in apache-flagon-useralejs-1.0.0-src.zip.sha512
+</p>
</div>
</div>
@@ -93,7 +176,7 @@
<div class="column">
<h4 class="ui inverted header">About</h4>
<div class="ui inverted link list">
- <a class="item" href="/system">System</a>
+ <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>
@@ -103,10 +186,10 @@
<div class="column">
<h4 class="ui inverted header">Docs</h4>
<div class="ui inverted link list">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserAle.pyqt</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>
@@ -115,21 +198,21 @@
<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=senssoft">GitHub</a>
- <a class="item" href="http://stackoverflow.com/questions/tagged/apache-senssoft">StackOverflow</a>
- <a class="item" href="https://issues.apache.org/jira/browse/SENSSOFT">Jira Issue Tracker</a>
- <a class="item" href="https://cwiki.apache.org/confluence/display/SENSSOFT">Project Wiki</a>
- <a class="item" href="https://twitter.com/apachesenssoft">Twitter</a>
+ <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/licenses/LICENSE-2.0.html">License</a>
<a class="item" href="http://www.apache.org/">Apache Software Foundation</a>
- <a class="item" href="http://incubator.apache.org/">Apache Incubator</a>
- <a class="item" href="http://www.apache.org/foundation/sponsorship.html">Sponsor Apache</a>
- <a class="item" href="http://www.apache.org/foundation/thanks.html">Thank you</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>
@@ -137,12 +220,23 @@
<div class="ui inverted vertical segment">
<div class="ui two column middle aligned grid">
<div class="column">
- Apache SensSoft 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 th [...]
+ 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">
- <img class="component-image" src="/images/incubator-logo-white.png">
- <br>
- Copyright © 2017 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, and the Apache Incubator logo are trademarks of The Apache Software Foundation. Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc.
+ 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>
diff --git a/site/_site/system/index.html b/content/stack/index.html
similarity index 70%
rename from site/_site/system/index.html
rename to content/stack/index.html
index 3245890..1e38857 100644
--- a/site/_site/system/index.html
+++ b/content/stack/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>The Apache SensSoft System</title>
- <meta name="description" content="The homepage for Apache SensSoft">
+ <title>The Apache Flagon Stack</title>
+ <meta name="description" content="The homepage for Apache Flagon">
<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,8 +16,8 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://senssoft.incubator.apache.org/system/">
- <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml">
+ <link rel="canonical" href="http://flagon.incubator.apache.org/stack/">
+ <link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
</head>
@@ -28,14 +28,14 @@
<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 SensSoft</h3>
+ <h3 class="ui inverted header item">Apache Flagon</h3>
</a>
<div class="right menu">
<div class="ui dropdown item">
Components
<div class="menu">
- <a class="item" href="/system">System</a>
+ <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>
@@ -45,7 +45,7 @@
<div class="ui dropdown item">
<a href="/docs">Docs</a>
<div class="menu">
- <a class="item" href="/docs/system">System</a>
+ <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>
@@ -64,7 +64,7 @@
<div class="main-wrapper">
<div class="ui blank-masthead masthead padded center aligned inverted vertical segment">
- <h1 class="ui header">The Apache SensSoft System</h1>
+ <h1 class="ui header">The Apache Flagon Stack</h1>
<h2 class="ui header">Easy combined deployment with Docker</h2>
</div>
@@ -72,7 +72,7 @@
<div class="ui very padded vertical segment">
<div class="ui center aligned text container">
<p>
- Apache SensSoft is a line of products that provides all the components needed for tracking, analyzing and visualizing user event data. Apache UserALE provides comprehensive user event tracking for web pages, but it is specially engineered for tools–applications users will use in their work. Apache Distill is an analytics framework for handling and analyzing UserALE data. Apache TAP provides you with a customizable array of interactive visual analytic libraries (D3) to extract insig [...]
+ Apache Flagon is a set of project that provide all the components needed for tracking, analyzing and visualizing user event data. Apache UserALE provides comprehensive user event tracking for web pages, but it is specially engineered for tools–applications users will use in their work. Apache Distill is an analytics framework for handling and analyzing UserALE data. Apache TAP provides you with a customizable array of interactive visual analytic libraries (D3) to extract insights f [...]
</p>
</div>
</div>
@@ -130,9 +130,9 @@
<div class="ui center aligned text container">
<h2 class="ui header">What's Included?</h2>
<p>
- The Apache SensSoft System includes a complete backend deployment of UserALE, Distill, and Tap. The different components are connected as seen below and ready to work together out of the box. UserALE clients will still need to be included in the target applications to push logs into the system.
+ The Apache Flagon stack includes a complete backend deployment for Apache UserALE, as well as demonstration versions of Apache Distill, and Apache Tap. These components are connected as seen below and ready to work together out of the box. UserALE clients will still need to be included in the target applications to push logs into the system.
</p>
- <img class="segment-image" src="/images/system.png">
+ <img class="segment-image" src="/images/stack.png">
</div>
</div>
@@ -141,12 +141,12 @@
<div class="ui inverted grey very padded vertical segment">
<div class="ui center aligned text container">
<h2 class="ui inverted header">
- Ready to try Apache SensSoft?
+ Ready to try Apache Flagon Stack?
</h2>
<a class="ui big blue button" href="/releases">
Get the Release
</a>
- <a class="ui big yellow button" href="/docs/system/">
+ <a class="ui big yellow button" href="/docs/stack/">
Read the Docs
</a>
</div>
@@ -160,7 +160,7 @@
<div class="column">
<h4 class="ui inverted header">About</h4>
<div class="ui inverted link list">
- <a class="item" href="/system">System</a>
+ <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>
@@ -170,7 +170,7 @@
<div class="column">
<h4 class="ui inverted header">Docs</h4>
<div class="ui inverted link list">
- <a class="item" href="/docs/system">System</a>
+ <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>
@@ -182,11 +182,11 @@
<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=senssoft">GitHub</a>
- <a class="item" href="http://stackoverflow.com/questions/tagged/apache-senssoft">StackOverflow</a>
- <a class="item" href="https://issues.apache.org/jira/browse/SENSSOFT">Jira Issue Tracker</a>
- <a class="item" href="https://cwiki.apache.org/confluence/display/SENSSOFT">Project Wiki</a>
- <a class="item" href="https://twitter.com/apachesenssoft">Twitter</a>
+ <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">
@@ -204,12 +204,11 @@
<div class="ui inverted vertical segment">
<div class="ui two column middle aligned grid">
<div class="column">
- Apache SensSoft 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 th [...]
+ 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 © 2018 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 SensSoft, SensSoft, Apache, the Apache feather logo, the Apache SensSoft logo and the Apache Incubator logo are trademarks of The Apache Software Foundation.
- Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc.
+ 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>
diff --git a/content/stout/index.html b/content/stout/index.html
index d8dbb74..91ff65e 100644
--- a/content/stout/index.html
+++ b/content/stout/index.html
@@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Stout</title>
- <meta name="description" content="The homepage for Apache SensSoft">
+ <meta name="description" content="The homepage for Apache Flagon">
<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,8 +16,8 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://localhost:4000/stout/">
- <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" href="/feed.xml">
+ <link rel="canonical" href="http://flagon.incubator.apache.org/stout/">
+ <link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
</head>
@@ -28,14 +28,14 @@
<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 SensSoft</h3>
+ <h3 class="ui inverted header item">Apache Flagon</h3>
</a>
<div class="right menu">
<div class="ui dropdown item">
Components
<div class="menu">
- <a class="item" href="/system">System</a>
+ <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>
@@ -45,10 +45,10 @@
<div class="ui dropdown item">
<a href="/docs">Docs</a>
<div class="menu">
- <a class="item" href="/docs/system">System</a>
+ <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/useralepyqt">UserALE.pyqt</a>
+ <a class="item" href="/docs/useralepy">UserALE.py</a>
... 626 lines suppressed ...