You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flagon.apache.org by jk...@apache.org on 2024/11/08 23:05:18 UTC
(flagon) branch master updated: Copy changes to content/
This is an automated email from the ASF dual-hosted git repository.
jky pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flagon.git
The following commit(s) were added to refs/heads/master by this push:
new 7d7bcba Copy changes to content/
7d7bcba is described below
commit 7d7bcbae26216082065e81930d59c824977d905e
Author: Jason Young <jk...@pm.me>
AuthorDate: Fri Nov 8 15:04:11 2024 -0800
Copy changes to content/
---
content/Gemfile | 21 -
content/_config.yml | 53 --
content/assets/main.css | 248 +++++---
content/assets/main.css.map | 1 +
content/community/index.html | 68 +-
content/distill/index.html | 30 +-
content/docs/contributing.html | 334 ----------
content/docs/contributing/index.html | 147 +----
content/docs/distill/analytics.html | 416 ------------
content/docs/distill/api.html | 354 -----------
content/docs/distill/changelog.html | 358 -----------
content/docs/distill/http.html | 636 -------------------
content/docs/distill/index.html | 282 +--------
content/docs/distill/models.html | 623 ------------------
content/docs/distill/start.html | 342 ----------
content/docs/distill/utilities.html | 423 -------------
content/docs/index.html | 139 +---
content/docs/stack/index.html | 388 ------------
content/docs/stack/scaling/index.html | 699 ---------------------
content/docs/stout/index.html | 353 -----------
content/docs/stout/start.html | 425 -------------
content/docs/system/index.html | 361 -----------
content/docs/tap/index.html | 335 ----------
content/docs/userale/index.html | 343 ----------
content/docs/useralejs/API.html | 468 --------------
content/docs/useralejs/API/index.html | 309 ++-------
content/docs/useralejs/build.html | 441 -------------
content/docs/useralejs/build/index.html | 163 +----
content/docs/useralejs/contributing.html | 331 ----------
content/docs/useralejs/dataschema.html | 344 ----------
content/docs/useralejs/dataschema/index.html | 419 ++++--------
content/docs/useralejs/index.html | 187 +-----
content/docs/useralejs/modifying.html | 457 --------------
content/docs/useralejs/modifying/index.html | 221 ++-----
content/docs/useralejs/testing.html | 343 ----------
content/docs/useralejs/troubleshooting.html | 335 ----------
content/docs/useralejs/troubleshooting/index.html | 139 +---
content/docs/useralepy/api.html | 609 ------------------
content/docs/useralepy/changelog.html | 398 ------------
content/docs/useralepy/index.html | 428 -------------
content/docs/useralepy/start.html | 381 -----------
content/docs/useralepyqt/api.html | 592 -----------------
content/docs/useralepyqt/changelog.html | 379 -----------
content/docs/useralepyqt/index.html | 423 -------------
content/docs/useralepyqt/start.html | 364 -----------
content/feed.xml | 2 +-
content/feed.xslt.xml | 4 -
content/images/system.png | Bin 203346 -> 0 bytes
content/index.html | 157 +----
content/releases/index.html | 30 +-
content/stack/index.html | 232 -------
content/stout/index.html | 250 --------
content/tap/index.html | 316 ----------
content/userale/index.html | 32 +-
site/_site/assets/main.css | 248 +++++---
site/_site/assets/main.css.map | 1 +
site/_site/community/index.html | 68 +-
site/_site/distill/index.html | 30 +-
site/_site/docs/contributing.html | 334 ----------
site/_site/docs/contributing/index.html | 147 +----
site/_site/docs/distill/analytics.html | 416 ------------
site/_site/docs/distill/api.html | 354 -----------
site/_site/docs/distill/changelog.html | 358 -----------
site/_site/docs/distill/http.html | 636 -------------------
site/_site/docs/distill/index.html | 282 +--------
site/_site/docs/distill/models.html | 623 ------------------
site/_site/docs/distill/start.html | 342 ----------
site/_site/docs/distill/utilities.html | 423 -------------
site/_site/docs/index.html | 139 +---
site/_site/docs/stack/index.html | 388 ------------
site/_site/docs/stack/scaling/index.html | 699 ---------------------
site/_site/docs/stout/index.html | 353 -----------
site/_site/docs/stout/start.html | 425 -------------
site/_site/docs/system/index.html | 361 -----------
site/_site/docs/tap/index.html | 335 ----------
site/_site/docs/userale/index.html | 343 ----------
site/_site/docs/useralejs/API.html | 468 --------------
site/_site/docs/useralejs/API/index.html | 309 ++-------
site/_site/docs/useralejs/build.html | 441 -------------
site/_site/docs/useralejs/build/index.html | 163 +----
site/_site/docs/useralejs/contributing.html | 331 ----------
site/_site/docs/useralejs/dataschema.html | 344 ----------
site/_site/docs/useralejs/dataschema/index.html | 419 ++++--------
site/_site/docs/useralejs/index.html | 187 +-----
site/_site/docs/useralejs/modifying.html | 457 --------------
site/_site/docs/useralejs/modifying/index.html | 221 ++-----
site/_site/docs/useralejs/testing.html | 343 ----------
site/_site/docs/useralejs/troubleshooting.html | 335 ----------
.../docs/useralejs/troubleshooting/index.html | 139 +---
site/_site/docs/useralepy/api.html | 609 ------------------
site/_site/docs/useralepy/changelog.html | 398 ------------
site/_site/docs/useralepy/index.html | 428 -------------
site/_site/docs/useralepy/start.html | 381 -----------
site/_site/docs/useralepyqt/api.html | 592 -----------------
site/_site/docs/useralepyqt/changelog.html | 379 -----------
site/_site/docs/useralepyqt/index.html | 423 -------------
site/_site/docs/useralepyqt/start.html | 364 -----------
site/_site/feed.xml | 2 +-
site/_site/feed.xslt.xml | 4 -
site/_site/images/system.png | Bin 203346 -> 0 bytes
site/_site/index.html | 157 +----
site/_site/releases/index.html | 30 +-
site/_site/tap/index.html | 316 ----------
site/_site/userale/index.html | 32 +-
104 files changed, 950 insertions(+), 30760 deletions(-)
diff --git a/content/Gemfile b/content/Gemfile
deleted file mode 100644
index c2474b4..0000000
--- a/content/Gemfile
+++ /dev/null
@@ -1,21 +0,0 @@
-source "https://rubygems.org"
-ruby RUBY_VERSION
-
-# Hello! This is where you manage which Jekyll version is used to run.
-# When you want to use a different version, change it below, save the
-# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
-#
-# bundle exec jekyll serve
-#
-# This will help ensure the proper Jekyll version is running.
-# Happy Jekylling!
-gem "jekyll", ">= 3.6.3"
-
-# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
-# uncomment the line below. To upgrade, run `bundle update github-pages`.
-# gem "github-pages", group: :jekyll_plugins
-
-# If you have any plugins, put them here!
-group :jekyll_plugins do
- gem "jekyll-feed", "~> 0.6"
-end
diff --git a/content/_config.yml b/content/_config.yml
deleted file mode 100644
index 209b79a..0000000
--- a/content/_config.yml
+++ /dev/null
@@ -1,53 +0,0 @@
-# Welcome to Jekyll!
-#
-# This config file is meant for settings that affect your whole blog, values
-# which you are expected to set up once and rarely edit after that. If you find
-# yourself editing this file very often, consider using Jekyll's data files
-# feature for the data you need to update frequently.
-#
-# For technical reasons, this file is *NOT* reloaded automatically when you use
-# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
-
-# Site settings
-# These are used to personalize your new site. If you look in the HTML files,
-# 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 Flagon
-description: The homepage for Apache Flagon
-baseurl: "" # the subpath of your site, e.g. /blog
-url: "https://flagon.apache.org" # the base hostname & protocol for your site, e.g. http://example.com
-twitter_username: ApacheFlagon
-github_username: apache
-
-collections:
- docs:
- output: true
-
-defaults:
- -
- scope:
- path: ""
- type: "docs"
- values:
- layout: "docs"
- priority: 10
-
-# Build settings
-markdown: kramdown
-gems:
- - jekyll-feed
-include:
- - _pages
-exclude:
- - Gemfile
- - Gemfile.lock
- - node_modules
- - semantic/src
- - semantic/tasks
- - semantic/gulpfile.js
- - semantic/dist/components
- - semantic/dist/semantic.js
- - semantic/dist/semantic.css
- - package.json
- - semantic.json
diff --git a/content/assets/main.css b/content/assets/main.css
index a6c448d..543ebaa 100644
--- a/content/assets/main.css
+++ b/content/assets/main.css
@@ -1,204 +1,282 @@
body {
display: flex;
- flex-direction: column; }
+ flex-direction: column;
+}
.site-header {
- flex: 0 0; }
+ flex: 0 0;
+}
.main-wrapper {
flex: 1 0;
height: auto;
- padding-top: 50px; }
+ padding-top: 50px;
+}
.footer {
flex: 0 0;
width: 100%;
- text-align: center; }
+ text-align: center;
+}
#main-menu {
- height: 50px !important; }
+ height: 50px !important;
+}
.page-wrapper {
- padding: 2em 0 2em 0; }
+ padding: 2em 0 2em 0;
+}
#main-masthead {
padding: 10em;
background-image: url("/images/header.svg");
background-repeat: no-repeat;
- background-position: center; }
+ background-position: center;
+}
.blank-masthead {
- padding: 10em !important; }
+ padding: 10em !important;
+}
.image-masthead {
- padding: 6.8em !important; }
+ padding: 6.8em !important;
+}
.docs-wrapper {
- display: flex; }
+ display: flex;
+}
.docs-sidebar {
flex: 1 0 180px;
padding: 2em;
background-color: #54595B;
- min-height: calc(100vh - 50px); }
+ min-height: calc(100vh - 50px);
+}
.docs-content {
flex: 8;
- padding: 2em; }
+ padding: 2em;
+}
.docs-list {
- margin-left: 3em !important; }
+ margin-left: 3em !important;
+}
.docs-list > a.item:before {
- color: #EBEBEB !important; }
+ color: #EBEBEB !important;
+}
.component-image {
max-width: 100%;
- max-height: 170px; }
+ max-height: 170px;
+}
.site-title {
- white-space: nowrap; }
+ white-space: nowrap;
+}
.segment-image {
- max-width: 100%; }
+ max-width: 100%;
+}
.feature-description {
- color: #EBEBEB; }
+ color: #EBEBEB;
+}
.indented {
- padding-left: 2em; }
+ padding-left: 2em;
+}
/**
* Syntax highlighting styles
*/
.highlight .c {
color: #54595B;
- font-style: italic; }
+ font-style: italic;
+}
.highlight .err {
- color: #E24614; }
+ color: #E24614;
+}
.highlight .k {
- font-weight: bold; }
+ font-weight: bold;
+}
.highlight .o {
- font-weight: bold; }
+ font-weight: bold;
+}
.highlight .cm {
color: #54595B;
- font-style: italic; }
+ font-style: italic;
+}
.highlight .cp {
color: #54595B;
- font-weight: bold; }
+ font-weight: bold;
+}
.highlight .c1 {
color: #54595B;
- font-style: italic; }
+ font-style: italic;
+}
.highlight .cs {
color: #54595B;
font-weight: bold;
- font-style: italic; }
+ font-style: italic;
+}
.highlight .gd {
- color: #262626; }
+ color: #262626;
+}
.highlight .gd .x {
- color: #262626; }
+ color: #262626;
+}
.highlight .ge {
- font-style: italic; }
+ font-style: italic;
+}
.highlight .gr {
- color: #E24614; }
+ color: #E24614;
+}
.highlight .gh {
- color: #54595B; }
+ color: #54595B;
+}
.highlight .gi {
- color: #262626; }
+ color: #262626;
+}
.highlight .gi .x {
- color: #262626; }
+ color: #262626;
+}
.highlight .go {
- color: #54595B; }
+ color: #54595B;
+}
.highlight .gp {
- color: #54595B; }
+ color: #54595B;
+}
.highlight .gs {
- font-weight: bold; }
+ font-weight: bold;
+}
.highlight .gu {
- color: #54595B; }
+ color: #54595B;
+}
.highlight .gt {
- color: #E24614; }
+ color: #E24614;
+}
.highlight .kc {
- font-weight: bold; }
+ font-weight: bold;
+}
.highlight .kd {
- font-weight: bold; }
+ font-weight: bold;
+}
.highlight .kp {
- font-weight: bold; }
+ font-weight: bold;
+}
.highlight .kr {
- font-weight: bold; }
+ font-weight: bold;
+}
.highlight .kt {
color: #283F4E;
- font-weight: bold; }
+ font-weight: bold;
+}
.highlight .m {
- color: #38A6D8; }
+ color: #38A6D8;
+}
.highlight .s {
- color: #E24614; }
+ color: #E24614;
+}
.highlight .na {
- color: #283F4E; }
+ color: #283F4E;
+}
.highlight .nb {
- color: #38A6D8; }
+ color: #38A6D8;
+}
.highlight .nc {
color: #38A6D8;
- font-weight: bold; }
+ font-weight: bold;
+}
.highlight .no {
- color: #283F4E; }
+ color: #283F4E;
+}
.highlight .ni {
- color: #852EB7; }
+ color: #852EB7;
+}
.highlight .ne {
color: #E24614;
- font-weight: bold; }
+ font-weight: bold;
+}
.highlight .nf {
color: #E24614;
- font-weight: bold; }
+ font-weight: bold;
+}
.highlight .nn {
- color: #54595B; }
+ color: #54595B;
+}
.highlight .nt {
- color: #38A6D8; }
+ color: #38A6D8;
+}
.highlight .nv {
- color: #283F4E; }
+ color: #283F4E;
+}
.highlight .ow {
- font-weight: bold; }
+ font-weight: bold;
+}
.highlight .w {
- color: #54595B; }
+ color: #54595B;
+}
.highlight .mf {
- color: #BFD02C; }
+ color: #BFD02C;
+}
.highlight .mh {
- color: #BFD02C; }
+ color: #BFD02C;
+}
.highlight .mi {
- color: #BFD02C; }
+ color: #BFD02C;
+}
.highlight .mo {
- color: #BFD02C; }
+ color: #BFD02C;
+}
.highlight .sb {
- color: #E24614; }
+ color: #E24614;
+}
.highlight .sc {
- color: #E24614; }
+ color: #E24614;
+}
.highlight .sd {
- color: #E24614; }
+ color: #E24614;
+}
.highlight .s2 {
- color: #E24614; }
+ color: #E24614;
+}
.highlight .se {
- color: #E24614; }
+ color: #E24614;
+}
.highlight .sh {
- color: #E24614; }
+ color: #E24614;
+}
.highlight .si {
- color: #E24614; }
+ color: #E24614;
+}
.highlight .sx {
- color: #E24614; }
+ color: #E24614;
+}
.highlight .sr {
- color: #BFD02C; }
+ color: #BFD02C;
+}
.highlight .s1 {
- color: #E24614; }
+ color: #E24614;
+}
.highlight .ss {
- color: #852EB7; }
+ color: #852EB7;
+}
.highlight .bp {
- color: #54595B; }
+ color: #54595B;
+}
.highlight .vc {
- color: #283F4E; }
+ color: #283F4E;
+}
.highlight .vg {
- color: #283F4E; }
+ color: #283F4E;
+}
.highlight .vi {
- color: #283F4E; }
+ color: #283F4E;
+}
.highlight .il {
- color: #BFD02C; }
+ color: #BFD02C;
+}
.tooltip {
position: absolute;
@@ -211,16 +289,22 @@ body {
background-color: #EBEBEB;
border-style: solid;
border-width: 1px;
- border-color: #54595B; }
+ border-color: #54595B;
+}
#log-feed {
height: 720px;
- overflow-y: hidden; }
+ overflow-y: hidden;
+}
#map-example {
min-height: 300px;
width: 100%;
- z-index: 0; }
+ z-index: 0;
+}
#demo-dropdown > .default.text {
- color: #54595B !important; }
+ color: #54595B !important;
+}
+
+/*# sourceMappingURL=main.css.map */
\ No newline at end of file
diff --git a/content/assets/main.css.map b/content/assets/main.css.map
new file mode 100644
index 0000000..02c7bc5
--- /dev/null
+++ b/content/assets/main.css.map
@@ -0,0 +1 @@
+{"version":3,"sourceRoot":"","sources":["../_sass/_flagon.scss","main.scss","../_sass/_highlighting.scss","../_sass/_bowie.scss","../_sass/_userale.scss"],"names":[],"mappings":"AAAA;EACE;EACA;;;AAGF;EACE;;;AAGF;EACE;EACA;EACA;;;AAGF;EACE;EACA;EACA;;;AAGF;EACE;;;AAGF;EACE;;;AAGF;EACE;EACA;EACA;EACA;;;AAGF;EACE;;;AAGF;EACE;;;AAGF;EACE;;;AAGF;EACE;EACA;EACA,kBClCgB;EDmChB;;;AAGF;EACE;EACA;;;AAGF;EACE;;;AAGF;EACE;;;AAGF;EACE;EACA;;;AAGF;EACE;;;AAGF;EACE;;;AAGF;EACE,OClEgB;;;ADqElB;EACE;;;AE [...]
\ No newline at end of file
diff --git a/content/community/index.html b/content/community/index.html
index ada900a..28fe50b 100644
--- a/content/community/index.html
+++ b/content/community/index.html
@@ -16,7 +16,7 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://flagon.apache.org/community/">
+ <link rel="canonical" href="https://flagon.apache.org/community/">
<link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
@@ -35,23 +35,15 @@
<div class="ui dropdown item">
Products
<div class="menu">
- <a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
<a class="item" href="/distill">Distill</a>
- <a class="item" href="/tap">Tap</a>
- <a class="item" href="/stout">Stout</a>
</div>
</div>
<div class="ui dropdown item">
<a href="/docs">Docs</a>
<div class="menu">
- <a class="item" href="/docs/stack">Stack</a>
- <a class="item" href="/docs/userale">UserALE</a>
<a class="item" href="/docs/useralejs">UserALE.js</a>
- <a class="item" href="/docs/useralepy">UserALE.py</a>
<a class="item" href="/docs/distill">Distill</a>
- <a class="item" href="/docs/tap">Tap</a>
- <a class="item" href="/docs/stout">Stout</a>
</div>
</div>
<a class="item" href="/releases">Releases</a>
@@ -80,8 +72,8 @@
<div class="content">Users</div>
</h3>
<p>
- 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:user-subscribe@flagon.incubator.apache.org">User List</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.apache.org">user-subscribe@flagon.apache.org</a>.
+ <a class="ui yellow button" href="mailto:user-subscribe@flagon.apache.org">User List</a>
</p>
<h3 class="ui header">
@@ -89,16 +81,16 @@
<div class="content">Dev</div>
</h3>
<p>
- 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>
+ For contributors to Apache Flagon or those interested in ongoing design and development efforts. To subscribe, email <a href="mailto:dev-subscribe@flagon.apache.org">dev-subscribe@flagon.apache.org</a>.
+ <a class="ui blue button" href="mailto:dev-subscribe@flagon.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 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>
+ For emails-on-commit across all Apache Flagon products. To subscribe, email <a href="mailto:commits-subscribe@flagon.apache.org">commits-subscribe@flagon.apache.org</a>.
+ <a class="ui blue button" href="mailto:commits-subscribe@flagon.apache.org">Commits List</a>
</p>
</div>
@@ -109,14 +101,7 @@
<div class="content">GitHub</div>
</h3>
<p>
- <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/ApacheFlagon">Follow us on Twitter</a> to keep up to date on Apache Flagon and related developments.
+ <a href="https://github.com/apache?q=flagon">Find our code on Github</a> to browse, contribute, and submit issues.
</p>
<h3 class="ui header">
<i class="stack overflow icon"></i>
@@ -125,26 +110,11 @@
<p>
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/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/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@flagon.incubator.apache.org">contact us!</a>
+ Thank you to all our contributors! Want to be added? Contribute and <a href="mailto:dev@flagon.apache.org">contact us!</a>
</p>
<ul class="ui list">
<li>Michelle Beard</li>
@@ -176,23 +146,15 @@
<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">
@@ -200,9 +162,6 @@
<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">
@@ -213,17 +172,15 @@
<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>
+ <a class="item" href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy</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 © 2023 The Apache Software Foundation, Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.<br>
+ Copyright © 2024 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>
@@ -231,9 +188,6 @@
<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>
diff --git a/content/distill/index.html b/content/distill/index.html
index 354ff3b..661309b 100644
--- a/content/distill/index.html
+++ b/content/distill/index.html
@@ -16,7 +16,7 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://flagon.apache.org/distill/">
+ <link rel="canonical" href="https://flagon.apache.org/distill/">
<link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
@@ -35,23 +35,15 @@
<div class="ui dropdown item">
Products
<div class="menu">
- <a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
<a class="item" href="/distill">Distill</a>
- <a class="item" href="/tap">Tap</a>
- <a class="item" href="/stout">Stout</a>
</div>
</div>
<div class="ui dropdown item">
<a href="/docs">Docs</a>
<div class="menu">
- <a class="item" href="/docs/stack">Stack</a>
- <a class="item" href="/docs/userale">UserALE</a>
<a class="item" href="/docs/useralejs">UserALE.js</a>
- <a class="item" href="/docs/useralepy">UserALE.py</a>
<a class="item" href="/docs/distill">Distill</a>
- <a class="item" href="/docs/tap">Tap</a>
- <a class="item" href="/docs/stout">Stout</a>
</div>
</div>
<a class="item" href="/releases">Releases</a>
@@ -164,23 +156,15 @@
<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">
@@ -188,9 +172,6 @@
<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">
@@ -201,17 +182,15 @@
<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>
+ <a class="item" href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy</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 © 2023 The Apache Software Foundation, Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.<br>
+ Copyright © 2024 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>
@@ -219,9 +198,6 @@
<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>
diff --git a/content/docs/contributing.html b/content/docs/contributing.html
deleted file mode 100644
index 4461299..0000000
--- a/content/docs/contributing.html
+++ /dev/null
@@ -1,334 +0,0 @@
-<!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>Contributing</title>
- <meta name="description" content="First, thank you for contributing to Apache SensSoft!">
-
- <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://localhost:4000/docs/contributing.html">
- <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" 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 SensSoft</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="/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/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/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="active title">
-
- <i class="dropdown icon"></i>
- Apache SensSoft
- </div>
-
- <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>
-
- </div>
- </div>
-
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- System
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/system/">Getting Started</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/troubleshooting.html">Troubleshooting</a>
-
- <a class="item" href="/docs/useralejs/contributing.html">Contributing</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- UserALE.pyqt
- </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/useralepyqt/start.html">Getting Started</a>
-
- <a class="item" href="/docs/useralepyqt/api.html">API Documentation</a>
-
- <a class="item" href="/docs/useralepyqt/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/utilities.html">Apache Distill Utilities</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/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">Contributing</h2>
- <p>First, thank you for contributing to Apache SensSoft!</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>To report a bug or other issue, simply create an issue in JIRA, as described in Step 1 below.</p>
-
-<h4 id="1-create-an-issue-in-jira">1. Create an issue in JIRA</h4>
-
-<p>All changes to Apache Distill must have a corresponding issue in <a href="https://issues.apache.org/jira/browse/SENSSOFT">JIRA</a> so the change can be properly tracked. If you do not already have an account on Apache 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 SensSoft source code is maintained in <a href="https://git-wip-us.apache.org/repos/asf?s=senssoft">several git repositories</a> hosted by Apache. These repositories are mirrored and more easily available <a href="https://github.com/apache?q=senssoft">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 -m <span class="s2">"#SENSSOFT-123: #High-level message describing the changes."</span>
-</code></pre>
-</div>
-<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>
-
- </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="/system">System</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/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/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=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>
- </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>
- </div>
- </div>
- </div>
- </div>
- <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 [...]
- </div>
- <div class="center aligned column">
- <img class="component-image" src="/images/incubator-logo-white.png">
- <br>
- © Copyright 2016 The Charles Stark Draper Laboratory, Inc. All rights reserved., 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.
- </div>
- </div>
- </div>
-</div>
-
-
- </body>
-
-</html>
diff --git a/content/docs/contributing/index.html b/content/docs/contributing/index.html
index 9e30f13..f1efd9b 100644
--- a/content/docs/contributing/index.html
+++ b/content/docs/contributing/index.html
@@ -16,7 +16,7 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://flagon.apache.org/docs/contributing/">
+ <link rel="canonical" href="https://flagon.apache.org/docs/contributing/">
<link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
@@ -35,23 +35,15 @@
<div class="ui dropdown item">
Products
<div class="menu">
- <a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
<a class="item" href="/distill">Distill</a>
- <a class="item" href="/tap">Tap</a>
- <a class="item" href="/stout">Stout</a>
</div>
</div>
<div class="ui dropdown item">
<a href="/docs">Docs</a>
<div class="menu">
- <a class="item" href="/docs/stack">Stack</a>
- <a class="item" href="/docs/userale">UserALE</a>
<a class="item" href="/docs/useralejs">UserALE.js</a>
- <a class="item" href="/docs/useralepy">UserALE.py</a>
<a class="item" href="/docs/distill">Distill</a>
- <a class="item" href="/docs/tap">Tap</a>
- <a class="item" href="/docs/stout">Stout</a>
</div>
</div>
<a class="item" href="/releases">Releases</a>
@@ -68,11 +60,6 @@
-
-
-
-
-
<!-- <div class="ui inverted list">
<a class="item" href="/docs">About the Docs</a>
</div> -->
@@ -95,41 +82,6 @@
</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">
@@ -157,28 +109,6 @@
</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>
@@ -191,56 +121,9 @@
<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>
@@ -252,15 +135,15 @@
<p>See individual product guides for product-specific information on getting started as a contributor, setup and testing, code style, etc.</p>
-<p>To report a bug or other issue, simply create an issue in JIRA, as described in Step 1 below.</p>
+<p>To report a bug or other issue, simply create an issue in Giithub, as described in Step 1 below.</p>
-<h4 id="1-create-an-issue-in-jira">1. Create an issue in JIRA</h4>
+<h4 id="1-create-an-issue-in-github">1. Create an issue in Github</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>
+<p>All changes to Apache Flagon must have a corresponding issue in <a href="https://github.com/apache?q=flagon">GitHub</a> so the change can be properly tracked. If you do not already have an account on Github, 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>
+<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:</p>
<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code> git commit <span class="nt">-S</span> <span class="nt">-m</span> <span class="s2">"[FLAGON-123] High-level message describing the changes."</span>
</code></pre></div></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>
@@ -282,23 +165,15 @@
<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">
@@ -306,9 +181,6 @@
<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">
@@ -319,17 +191,15 @@
<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>
+ <a class="item" href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy</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 © 2023 The Apache Software Foundation, Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.<br>
+ Copyright © 2024 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>
@@ -337,9 +207,6 @@
<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>
diff --git a/content/docs/distill/analytics.html b/content/docs/distill/analytics.html
deleted file mode 100644
index 32e6a25..0000000
--- a/content/docs/distill/analytics.html
+++ /dev/null
@@ -1,416 +0,0 @@
-<!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>Apache Distill Analytics</title>
- <meta name="description" content="Graph Analytics">
-
- <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.apache.org/docs/distill/analytics.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">
- Products
- <div class="menu">
- <a class="item" href="/stack">Stack</a>
- <a class="item" href="/userale">UserALE</a>
- <a class="item" href="/distill">Distill</a>
- <a class="item" href="/tap">Tap</a>
- <a class="item" href="/stout">Stout</a>
- </div>
- </div>
- <div class="ui dropdown item">
- <a href="/docs">Docs</a>
- <div class="menu">
- <a class="item" href="/docs/stack">Stack</a>
- <a class="item" href="/docs/userale">UserALE</a>
- <a class="item" href="/docs/useralejs">UserALE.js</a>
- <a class="item" href="/docs/useralepy">UserALE.py</a>
- <a class="item" href="/docs/distill">Distill</a>
- <a class="item" href="/docs/tap">Tap</a>
- <a class="item" href="/docs/stout">Stout</a>
- </div>
- </div>
- <a class="item" href="/releases">Releases</a>
- <a class="item" href="/community">Community</a>
- </div>
- </div>
-</div>
-
-
- <div class="main-wrapper">
- <div class="docs-wrapper">
- <div class="docs-sidebar">
-
-
-
-
-
-
-
-
-
-<!-- <div class="ui inverted list">
- <a class="item" href="/docs">About the Docs</a>
-</div> -->
-<div id="docs-nav" class="ui inverted accordion">
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Apache Flagon
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/">About the Docs</a>
-
- <a class="item" href="/docs/contributing/">Contributing</a>
-
- </div>
- </div>
-
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Stack
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/stack/">Getting Started</a>
-
- <a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- UserALE
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/userale/">About UserALE</a>
-
- </div>
- </div>
-
-
- <div class="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/">UserALE.js Build and Test</a>
-
- <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
-
- <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
-
- <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
-
- <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- UserALE.py
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/useralepy/">Installation</a>
-
- <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
-
- <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
-
- <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
-
- </div>
- </div>
-
-
- <div class="active title">
-
- <i class="dropdown icon"></i>
- Distill
- </div>
-
- <div class="active 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">Apache Distill Analytics</h2>
- <h3 id="graph-analytics">Graph Analytics</h3>
-
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">class</span> <span class="nc">distill</span><span class="o">.</span><span class="n">algorithms</span><span class="o">.</span><span class="n">graphs</span><span class="o">.</span><span class="n">graph</span><span class="o">.</span><span class="n">GraphAnalytics</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p><strong>Bases:</strong> object</p>
-</blockquote>
-
-<blockquote>
- <p>Distill’s graph analytics package. Apply graph algorithms to User Ale log data segmented with Stout.</p>
-</blockquote>
-
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">static</span> <span class="n">foo</span><span class="p">()</span>
-</code></pre></div> </div>
-</blockquote>
-
-<h3 id="statistics-package">Statistics Package</h3>
-
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">class</span> <span class="nc">distill</span><span class="o">.</span><span class="n">algorithms</span><span class="o">.</span><span class="n">stats</span><span class="o">.</span><span class="n">hist</span><span class="o">.</span><span class="n">Hist</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p><strong>Bases:</strong> object</p>
-</blockquote>
-
-<blockquote>
- <p>Distill’s statistics package. Apply statistical algorithms to User Ale log data segmented with Stout. Need to query/filter by session or user id.</p>
-</blockquote>
-
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">get_value</span><span class="p">()</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">static</span> <span class="n">histogram</span><span class="p">(</span><span class="n">app</span><span class="p">,</span> <span class="n">app_type</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">q</span><span class="o">=</span><span class="s">''</span><span class="p">)</span>
-</code></pre></div> </div>
- <p>Only works on numerical data.</p>
-</blockquote>
-
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">static</span> <span class="n">terms</span><span class="p">(</span><span class="n">app</span><span class="p">,</span> <span class="n">app_type</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">q</span><span class="o">=</span><span class="s">''</span><span class="p">)</span>
-</code></pre></div> </div>
- <p>Group by field (find all elements )</p>
-</blockquote>
-
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">static</span> <span class="n">unique_terms</span><span class="p">(</span><span class="n">app</span><span class="p">,</span> <span class="n">app_type</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">q</span><span class="o">=</span><span class="s">''</span><span class="p">)</span>
-</code></pre></div> </div>
- <p>Aggregate the number of unique terms in a field. Missing values are counted and marked as “N/A”.</p>
-</blockquote>
-
-<blockquote>
- <p><strong>Todo:</strong> Need to incorporate QueryBuilder library instead of manually generating queries.</p>
-</blockquote>
-
-<blockquote>
- <p><strong>Parameters:</strong></p>
- <ul>
- <li>app – [string] application name</li>
- <li>app_type – [string] application type</li>
- <li>field – [string] field to search against for unique values</li>
- <li>size – [int] the top size terms returned in the result. Default value is 10.</li>
- <li>min_hits – [int] return tags which have been found in min_hits or more. Default value is 1.</li>
- </ul>
-</blockquote>
-
-<blockquote>
- <p><strong>Returns:</strong></p>
- <ul>
- <li>[dict] dictionary of results</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 © 2023 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/api.html b/content/docs/distill/api.html
deleted file mode 100644
index c815948..0000000
--- a/content/docs/distill/api.html
+++ /dev/null
@@ -1,354 +0,0 @@
-<!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 Distill HTTP Client RESTful Endpoints">
-
- <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.apache.org/docs/distill/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">
- Products
- <div class="menu">
- <a class="item" href="/stack">Stack</a>
- <a class="item" href="/userale">UserALE</a>
- <a class="item" href="/distill">Distill</a>
- <a class="item" href="/tap">Tap</a>
- <a class="item" href="/stout">Stout</a>
- </div>
- </div>
- <div class="ui dropdown item">
- <a href="/docs">Docs</a>
- <div class="menu">
- <a class="item" href="/docs/stack">Stack</a>
- <a class="item" href="/docs/userale">UserALE</a>
- <a class="item" href="/docs/useralejs">UserALE.js</a>
- <a class="item" href="/docs/useralepy">UserALE.py</a>
- <a class="item" href="/docs/distill">Distill</a>
- <a class="item" href="/docs/tap">Tap</a>
- <a class="item" href="/docs/stout">Stout</a>
- </div>
- </div>
- <a class="item" href="/releases">Releases</a>
- <a class="item" href="/community">Community</a>
- </div>
- </div>
-</div>
-
-
- <div class="main-wrapper">
- <div class="docs-wrapper">
- <div class="docs-sidebar">
-
-
-
-
-
-
-
-
-
-<!-- <div class="ui inverted list">
- <a class="item" href="/docs">About the Docs</a>
-</div> -->
-<div id="docs-nav" class="ui inverted accordion">
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Apache Flagon
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/">About the Docs</a>
-
- <a class="item" href="/docs/contributing/">Contributing</a>
-
- </div>
- </div>
-
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Stack
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/stack/">Getting Started</a>
-
- <a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- UserALE
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/userale/">About UserALE</a>
-
- </div>
- </div>
-
-
- <div class="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/">UserALE.js Build and Test</a>
-
- <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
-
- <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
-
- <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
-
- <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- UserALE.py
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/useralepy/">Installation</a>
-
- <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
-
- <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
-
- <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
-
- </div>
- </div>
-
-
- <div class="active title">
-
- <i class="dropdown icon"></i>
- Distill
- </div>
-
- <div class="active 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>
- <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.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.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.html">Apache Distill Utilities</a></h3>
-<ul>
- <li>Query Builder</li>
- <li>Exception Handling</li>
- <li>Validation Library</li>
-</ul>
-
- </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 © 2023 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/distill/changelog.html
deleted file mode 100644
index dceacf1..0000000
--- a/content/docs/distill/changelog.html
+++ /dev/null
@@ -1,358 +0,0 @@
-<!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>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">
-
- <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.apache.org/docs/distill/changelog.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">
- Products
- <div class="menu">
- <a class="item" href="/stack">Stack</a>
- <a class="item" href="/userale">UserALE</a>
- <a class="item" href="/distill">Distill</a>
- <a class="item" href="/tap">Tap</a>
- <a class="item" href="/stout">Stout</a>
- </div>
- </div>
- <div class="ui dropdown item">
- <a href="/docs">Docs</a>
- <div class="menu">
- <a class="item" href="/docs/stack">Stack</a>
- <a class="item" href="/docs/userale">UserALE</a>
- <a class="item" href="/docs/useralejs">UserALE.js</a>
- <a class="item" href="/docs/useralepy">UserALE.py</a>
- <a class="item" href="/docs/distill">Distill</a>
- <a class="item" href="/docs/tap">Tap</a>
- <a class="item" href="/docs/stout">Stout</a>
- </div>
- </div>
- <a class="item" href="/releases">Releases</a>
- <a class="item" href="/community">Community</a>
- </div>
- </div>
-</div>
-
-
- <div class="main-wrapper">
- <div class="docs-wrapper">
- <div class="docs-sidebar">
-
-
-
-
-
-
-
-
-
-<!-- <div class="ui inverted list">
- <a class="item" href="/docs">About the Docs</a>
-</div> -->
-<div id="docs-nav" class="ui inverted accordion">
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Apache Flagon
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/">About the Docs</a>
-
- <a class="item" href="/docs/contributing/">Contributing</a>
-
- </div>
- </div>
-
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Stack
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/stack/">Getting Started</a>
-
- <a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- UserALE
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/userale/">About UserALE</a>
-
- </div>
- </div>
-
-
- <div class="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/">UserALE.js Build and Test</a>
-
- <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
-
- <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
-
- <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
-
- <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- UserALE.py
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/useralepy/">Installation</a>
-
- <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
-
- <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
-
- <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
-
- </div>
- </div>
-
-
- <div class="active title">
-
- <i class="dropdown icon"></i>
- Distill
- </div>
-
- <div class="active 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">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>
-
-<h3 id="012-2016-07-22">0.1.2 (2016-07-22)</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>
-</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>
-
-<h3 id="010-2016-04-01">0.1.0 (2016-04-01)</h3>
-<ul>
- <li>Initial release.</li>
-</ul>
-
- </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 © 2023 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/http.html b/content/docs/distill/http.html
deleted file mode 100644
index 513a9b1..0000000
--- a/content/docs/distill/http.html
+++ /dev/null
@@ -1,636 +0,0 @@
-<!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>Apache Distill HTTP Client</title>
- <meta name="description" content="RESTful Endpoints distill.app.create(app_id)">
-
- <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.apache.org/docs/distill/http.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">
- Products
- <div class="menu">
- <a class="item" href="/stack">Stack</a>
- <a class="item" href="/userale">UserALE</a>
- <a class="item" href="/distill">Distill</a>
- <a class="item" href="/tap">Tap</a>
- <a class="item" href="/stout">Stout</a>
- </div>
- </div>
- <div class="ui dropdown item">
- <a href="/docs">Docs</a>
- <div class="menu">
- <a class="item" href="/docs/stack">Stack</a>
- <a class="item" href="/docs/userale">UserALE</a>
- <a class="item" href="/docs/useralejs">UserALE.js</a>
- <a class="item" href="/docs/useralepy">UserALE.py</a>
- <a class="item" href="/docs/distill">Distill</a>
- <a class="item" href="/docs/tap">Tap</a>
- <a class="item" href="/docs/stout">Stout</a>
- </div>
- </div>
- <a class="item" href="/releases">Releases</a>
- <a class="item" href="/community">Community</a>
- </div>
- </div>
-</div>
-
-
- <div class="main-wrapper">
- <div class="docs-wrapper">
- <div class="docs-sidebar">
-
-
-
-
-
-
-
-
-
-<!-- <div class="ui inverted list">
- <a class="item" href="/docs">About the Docs</a>
-</div> -->
-<div id="docs-nav" class="ui inverted accordion">
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Apache Flagon
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/">About the Docs</a>
-
- <a class="item" href="/docs/contributing/">Contributing</a>
-
- </div>
- </div>
-
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Stack
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/stack/">Getting Started</a>
-
- <a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- UserALE
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/userale/">About UserALE</a>
-
- </div>
- </div>
-
-
- <div class="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/">UserALE.js Build and Test</a>
-
- <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
-
- <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
-
- <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
-
- <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- UserALE.py
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/useralepy/">Installation</a>
-
- <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
-
- <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
-
- <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
-
- </div>
- </div>
-
-
- <div class="active title">
-
- <i class="dropdown icon"></i>
- Distill
- </div>
-
- <div class="active 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">Apache Distill HTTP Client</h2>
- <h3 id="restful-endpoints">RESTful Endpoints</h3>
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">distill</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">app_id</span><span class="p">)</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p>Registers an application in Distill.</p>
-</blockquote>
-
-<blockquote>
-
- <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>curl <span class="nt">-XPOST</span> https://localhost:8090/xdata_v3
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p><strong>Parameters:</strong></p>
- <ul>
- <li>app_id – Application name</li>
- </ul>
-</blockquote>
-
-<blockquote>
- <p><strong>Returns:</strong></p>
- <ul>
- <li>Newly created application’s status as JSON blob</li>
- </ul>
-</blockquote>
-
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">distill</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">app_id</span><span class="p">)</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p>Deletes an application permentantly from Distill</p>
-</blockquote>
-
-<blockquote>
-
- <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>curl <span class="nt">-XDELETE</span> https://localhost:8090/xdata_v3
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p><strong>Parameters:</strong></p>
- <ul>
- <li>app_id – Application name</li>
- </ul>
-</blockquote>
-
-<blockquote>
- <p><strong>Returns:</strong></p>
- <ul>
- <li>Boolean response message as JSON blob</li>
- </ul>
-</blockquote>
-
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">distill</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">denoise</span><span class="p">(</span><span class="n">app_id</span><span class="p">)</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p>Bootstrap script to cleanup the raw logs. A document type called “parsed” will be stored with new log created unless specified in the request. Have option to save parsed results back to data store. These parsed logs can be intergrated with STOUT results by running the stout bootstrap script.</p>
-</blockquote>
-
-<blockquote>
-
- <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>curl <span class="nt">-XGET</span> https://localhost:8090/denoise/xdata_v3?save<span class="o">=</span><span class="nb">true</span>&type<span class="o">=</span>parsed
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p><strong>Parameters:</strong></p>
- <ul>
- <li>app_id – Application name</li>
- </ul>
-</blockquote>
-
-<blockquote>
- <p><strong>Returns:</strong></p>
- <ul>
- <li>[dict]</li>
- </ul>
-</blockquote>
-
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">distill</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">index</span><span class="p">()</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p>Show Distill version information, connection status, and all registered applications.</p>
-</blockquote>
-
-<blockquote>
-
- <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>curl <span class="nt">-XGET</span> https://localhost:8090
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
-
- <div class="language-javascript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="p">{</span>
- <span class="s2">"author"</span> <span class="p">:</span> <span class="s2">"Michelle Beard"</span><span class="p">,</span>
- <span class="s2">"email"</span> <span class="p">:</span> <span class="s2">"msbeard@apache.org"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Distill"</span><span class="p">,</span>
- <span class="s2">"status"</span> <span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
- <span class="s2">"version"</span> <span class="p">:</span> <span class="s2">"1.0"</span><span class="p">,</span>
- <span class="s2">"applications"</span> <span class="p">:</span> <span class="p">{</span>
- <span class="s2">"xdata_v3"</span> <span class="p">:</span> <span class="p">{</span>
- <span class="nl">testing</span><span class="p">:</span> <span class="mi">205</span><span class="p">,</span>
- <span class="nx">parsed</span><span class="p">:</span> <span class="mi">500</span><span class="p">,</span>
- <span class="p">},</span>
- <span class="s2">"test_app"</span> <span class="p">:</span> <span class="p">{</span>
- <span class="nl">logs</span><span class="p">:</span> <span class="mi">500</span><span class="p">,</span>
- <span class="nx">parsed</span><span class="p">:</span> <span class="mi">100</span><span class="p">,</span>
- <span class="p">}</span>
- <span class="p">}</span>
-<span class="p">}</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p><strong>Returns:</strong></p>
- <ul>
- <li>Distill’s status information as JSON blob</li>
- </ul>
-</blockquote>
-
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">distill</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">merge_stout</span><span class="p">()</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p>Bootstrap script to aggregate user ale logs to stout master answer table This will save the merged results back to ES instance at new index stout OR denoise data first, then merge with the stout index… If STOUT is enabled, the select method expects a stout index to exist or otherwise it will return an error message.</p>
-</blockquote>
-
-<blockquote>
-
- <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>curl <span class="nt">-XGET</span> https://locahost:8090/stout/xdata_v3
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p><strong>Returns:</strong></p>
- <ul>
- <li>Status message</li>
- </ul>
-</blockquote>
-
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">distill</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">page_not_found</span><span class="p">(</span><span class="n">error</span><span class="p">)</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p>Generic Error Message</p>
-</blockquote>
-
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">distill</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">segment</span><span class="p">(</span><span class="n">app_id</span><span class="p">,</span> <span class="n">app_type</span><span class="p">)</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p>Search against an application on various fields.</p>
-</blockquote>
-
-<blockquote>
-
- <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>curl <span class="nt">-XGET</span> https://[hostname]:[port]/search/
-xdata_v3?q<span class="o">=</span>session_id:A1234&size<span class="o">=</span>100
-&scroll<span class="o">=</span><span class="nb">false</span>&fl<span class="o">=</span>param1,param2
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p><strong>Parameters:</strong></p>
- <ul>
- <li>app_id – Application name</li>
- <li>app_type – Optional document type to filter against</li>
- <li>q – Main search query. To return all documents, pass in q=<em>:</em></li>
- <li>size – Maximum number of documents to return in request</li>
- <li>scroll – Scroll id if the number of documents exceeds 10,000</li>
- <li>fl – List of fields to restrict the result set</li>
- </ul>
-</blockquote>
-
-<blockquote>
- <p><strong>Returns:</strong></p>
- <ul>
- <li>JSON blob of result set</li>
- </ul>
-</blockquote>
-
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">distill</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">stat</span><span class="p">(</span><span class="n">app_id</span><span class="p">,</span> <span class="n">app_type</span><span class="p">)</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p>Generic histogram counts for a single registered application filtered optionally by document type. View the Statistics document page for method definitions and arguments</p>
-</blockquote>
-
-<blockquote>
-
- <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>curl <span class="nt">-XGET</span> https://localhost:8090/stat/xdata_v3/
-testing/?stat<span class="o">=</span>terms&elem<span class="o">=</span>signup&event<span class="o">=</span>click
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p><strong>Parameters:</strong></p>
- <ul>
- <li>app_id – Application name</li>
- <li>app_type – Application type</li>
- </ul>
-</blockquote>
-
-<blockquote>
- <p><strong>Returns:</strong></p>
- <ul>
- <li>JSON blob of result set</li>
- </ul>
-</blockquote>
-
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">distill</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">status</span><span class="p">(</span><span class="n">app_id</span><span class="p">,</span> <span class="n">app_type</span><span class="p">)</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p>Presents meta information about an registered application, including field names and document types.</p>
-</blockquote>
-
-<blockquote>
-
- <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>curl <span class="nt">-XGET</span> https://localhost:8090/status/xdata_v3
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
-
- <div class="language-javascript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="p">{</span>
- <span class="s2">"application"</span><span class="p">:</span> <span class="s2">"xdata_v3"</span><span class="p">,</span>
- <span class="s2">"health"</span><span class="p">:</span> <span class="s2">"green"</span><span class="p">,</span>
- <span class="s2">"num_docs"</span><span class="p">:</span> <span class="s2">"433"</span><span class="p">,</span>
- <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"open"</span>
-<span class="p">}</span>
-</code></pre></div> </div>
- <p>w
-<strong>Parameters:</strong></p>
- <ul>
- <li>app_id – Application name</li>
- </ul>
-</blockquote>
-
-<blockquote>
- <p><strong>Returns:</strong></p>
- <ul>
- <li>Registered applications meta data as JSON blob</li>
- </ul>
-</blockquote>
-
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">distill</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">app_id</span><span class="p">)</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p>Renames a specific application</p>
-</blockquote>
-
-<blockquote>
-
- <div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>curl <span class="nt">-XPOST</span> https://localhost:8090/update/xdata_v3?name<span class="o">=</span><span class="s2">"xdata_v4"</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p><strong>Parameters:</strong></p>
- <ul>
- <li>app_id – Application name</li>
- </ul>
-</blockquote>
-
-<blockquote>
- <p><strong>Returns:</strong></p>
- <ul>
- <li>Boolean response message as JSON blob</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 © 2023 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/index.html b/content/docs/distill/index.html
index f55894d..cb30687 100644
--- a/content/docs/distill/index.html
+++ b/content/docs/distill/index.html
@@ -16,7 +16,7 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://flagon.apache.org/docs/distill/">
+ <link rel="canonical" href="https://flagon.apache.org/docs/distill/">
<link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
@@ -35,23 +35,15 @@
<div class="ui dropdown item">
Products
<div class="menu">
- <a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
<a class="item" href="/distill">Distill</a>
- <a class="item" href="/tap">Tap</a>
- <a class="item" href="/stout">Stout</a>
</div>
</div>
<div class="ui dropdown item">
<a href="/docs">Docs</a>
<div class="menu">
- <a class="item" href="/docs/stack">Stack</a>
- <a class="item" href="/docs/userale">UserALE</a>
<a class="item" href="/docs/useralejs">UserALE.js</a>
- <a class="item" href="/docs/useralepy">UserALE.py</a>
<a class="item" href="/docs/distill">Distill</a>
- <a class="item" href="/docs/tap">Tap</a>
- <a class="item" href="/docs/stout">Stout</a>
</div>
</div>
<a class="item" href="/releases">Releases</a>
@@ -68,11 +60,6 @@
-
-
-
-
-
<!-- <div class="ui inverted list">
<a class="item" href="/docs">About the Docs</a>
</div> -->
@@ -95,41 +82,6 @@
</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">
@@ -157,28 +109,6 @@
</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="active title">
<i class="dropdown icon"></i>
@@ -191,56 +121,9 @@
<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>
@@ -248,148 +131,7 @@
<h2 class="ui header">Installation</h2>
<h3 id="installing-apache-distill">Installing Apache Distill</h3>
-<h4 id="this-project-is-not-currently-maintained-and-will-be-refactored-if-you-are-interested-in-distill-join-the-discussion-on-our-dev-list">This project is not currently maintained and will be refactored. If you are interested in Distill, join the discussion on our <a href="mailto:dev-subscribe@flagon.incubator.apache.org">dev list</a>.</h4>
-
-<p>The first step is to install Apache Distill. First, checkout the latest version of Apache Distill.</p>
-
-<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nv">$ </span>git clone https://gitbox.apache.org/repos/asf/incubator-flagon-distill.git
-</code></pre></div></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>
-
-<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nv">$ </span>easy_install distill
-</code></pre></div></div>
-
-<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code> or
-</code></pre></div></div>
-
-<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nv">$ </span>pip install distill
-</code></pre></div></div>
-
-<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>
-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>
-
-<h3 id="installing-apache-distill-in-an-virtual-environment">Installing Apache Distill 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>Install virtualenv via pip:</p>
-
-<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nv">$ </span><span class="nb">sudo </span>env/bin/pip install virtualenv
-</code></pre></div></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>
-
-<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nv">$ </span>mkdir env
- <span class="nv">$ </span>virtualenv env
-</code></pre></div></div>
-
-<p>Activate environment:</p>
-
-<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nv">$ </span><span class="nb">source </span>env/bin/activate
-</code></pre></div></div>
-
-<p>Install Apache Distill requirements:</p>
-
-<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nv">$ </span>env/bin/pip <span class="nt">-r</span> requirements.txt
-</code></pre></div></div>
-
-<p>To build the source code and run all unit tests.</p>
-
-<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nv">$ </span>env/bin/python setup.py develop <span class="nb">test</span>
-</code></pre></div></div>
-
-<p>Launch local Apache Distill server, running on localhost:8090:</p>
-
-<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nv">$ </span>env/bin/dev
-</code></pre></div></div>
-
-<p>Deactivate environment</p>
-
-<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nv">$ </span>deactivate
-</code></pre></div></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"><div class="highlight"><pre class="highlight"><code> <span class="nv">$ </span>docker-compose up <span class="nt">-d</span>
- <span class="nv">$ </span>docker-compose ps
-</code></pre></div></div>
-
-<p>To stop services once you’ve finished with them:</p>
-
-<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nv">$ </span>docker-compose stop
-</code></pre></div></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"><div class="highlight"><pre class="highlight"><code> <span class="nv">$ </span><span class="nb">sudo </span>apt-get update
- <span class="nv">$ </span><span class="nb">sudo </span>apt-get install <span class="nt">-y</span> python python-pip nginx gunicorn
-</code></pre></div></div>
-
-<p>Create a directory to store the project.</p>
-
-<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nv">$ </span><span class="nb">sudo </span>mkdir /home/pubic_html <span class="o">&&</span> <span class="nb">cd</span> /home/public_html
-</code></pre></div></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"><div class="highlight"><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></div>
-
-<p>Install Apache Distill’s requirements either globally or in a virutal environment:</p>
-
-<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nv">$ </span>env/bin/pip install <span class="nt">-r</span> requirements.txt
-</code></pre></div></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"><div class="highlight"><pre class="highlight"><code> <span class="nv">$ </span><span class="nb">sudo</span> /etc/init.d/nginx restart
-</code></pre></div></div>
-
-<p>Run gunicorn on port 8000.</p>
-
-<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nv">$ </span>gunicorn <span class="nt">--workers</span> 4 <span class="nt">--bind</span> unix:distill.sock <span class="nt">-m</span> 007 deploy/run_server:app
-</code></pre></div></div>
-
-<p>Start a new browser instance and navigate to http://localhost.</p>
-
-<h3 id="installing-documentation">Installing Documentation</h3>
-
-<p>If you want to manually build the documentation, the instructions are below.</p>
-
-<p>First, install the documentation dependencies:</p>
-
-<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nv">$ </span>env/bin/pip install <span class="nt">-r</span> doc_requirements.txt
-</code></pre></div></div>
-
-<p>To build Apache Distill’s documentation, create a directory at the root level of /distill called distill-docs.</p>
-
-<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nv">$ </span>mkdir distill-docs & <span class="nb">cd </span>distill-docs
-</code></pre></div></div>
-
-<p>Execute build command:</p>
-
-<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="c"># Inside top-level docs/ directory.</span>
- <span class="nv">$ </span>make html
-</code></pre></div></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>
-
-<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nv">$ </span>open distill-docs/html/index.html
-</code></pre></div></div>
+<h4 id="this-project-is-currently-being-refactored-if-you-are-interested-in-distill-join-the-discussion-on-our-dev-list">This project is currently being refactored. If you are interested in Distill, join the discussion on our <a href="mailto:dev-subscribe@flagon.incubator.apache.org">dev list</a>.</h4>
</div>
</div>
@@ -402,23 +144,15 @@ 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="/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">
@@ -426,9 +160,6 @@ When the package is installed via easy_install or pip this function will be boun
<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">
@@ -439,17 +170,15 @@ When the package is installed via easy_install or pip this function will be boun
<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>
+ <a class="item" href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy</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 © 2023 The Apache Software Foundation, Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.<br>
+ Copyright © 2024 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>
@@ -457,9 +186,6 @@ When the package is installed via easy_install or pip this function will be boun
<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>
diff --git a/content/docs/distill/models.html b/content/docs/distill/models.html
deleted file mode 100644
index 9fa93da..0000000
--- a/content/docs/distill/models.html
+++ /dev/null
@@ -1,623 +0,0 @@
-<!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>Apache Distill Models</title>
- <meta name="description" content="Brew Interface class distill.models.brew.Brew">
-
- <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.apache.org/docs/distill/models.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">
- Products
- <div class="menu">
- <a class="item" href="/stack">Stack</a>
- <a class="item" href="/userale">UserALE</a>
- <a class="item" href="/distill">Distill</a>
- <a class="item" href="/tap">Tap</a>
- <a class="item" href="/stout">Stout</a>
- </div>
- </div>
- <div class="ui dropdown item">
- <a href="/docs">Docs</a>
- <div class="menu">
- <a class="item" href="/docs/stack">Stack</a>
- <a class="item" href="/docs/userale">UserALE</a>
- <a class="item" href="/docs/useralejs">UserALE.js</a>
- <a class="item" href="/docs/useralepy">UserALE.py</a>
- <a class="item" href="/docs/distill">Distill</a>
- <a class="item" href="/docs/tap">Tap</a>
- <a class="item" href="/docs/stout">Stout</a>
- </div>
- </div>
- <a class="item" href="/releases">Releases</a>
- <a class="item" href="/community">Community</a>
- </div>
- </div>
-</div>
-
-
- <div class="main-wrapper">
- <div class="docs-wrapper">
- <div class="docs-sidebar">
-
-
-
-
-
-
-
-
-
-<!-- <div class="ui inverted list">
- <a class="item" href="/docs">About the Docs</a>
-</div> -->
-<div id="docs-nav" class="ui inverted accordion">
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Apache Flagon
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/">About the Docs</a>
-
- <a class="item" href="/docs/contributing/">Contributing</a>
-
- </div>
- </div>
-
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Stack
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/stack/">Getting Started</a>
-
- <a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- UserALE
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/userale/">About UserALE</a>
-
- </div>
- </div>
-
-
- <div class="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/">UserALE.js Build and Test</a>
-
- <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
-
- <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
-
- <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
-
- <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- UserALE.py
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/useralepy/">Installation</a>
-
- <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
-
- <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
-
- <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
-
- </div>
- </div>
-
-
- <div class="active title">
-
- <i class="dropdown icon"></i>
- Distill
- </div>
-
- <div class="active 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">Apache Distill Models</h2>
- <h3 id="brew-interface">Brew Interface</h3>
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">class</span> <span class="nc">distill</span><span class="o">.</span><span class="n">models</span><span class="o">.</span><span class="n">brew</span><span class="o">.</span><span class="n">Brew</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p><strong>Bases:</strong> object</p>
-</blockquote>
-
-<blockquote>
- <p>Distill supports basic CRUD operations and publishes the status of an persistenct database. Eventually it will support ingesting logs sent from an registered application.</p>
-</blockquote>
-
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">static</span> <span class="n">create</span><span class="p">(</span><span class="n">app</span><span class="p">)</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p>Register a new application in Distill</p>
-</blockquote>
-
-<blockquote>
-
- <div class="language-javascript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="p">{</span>
- <span class="s2">"application"</span> <span class="p">:</span> <span class="s2">"xdata_v3"</span><span class="p">,</span>
- <span class="s2">"health"</span> <span class="p">:</span> <span class="s2">"green"</span><span class="p">,</span>
- <span class="s2">"num_docs"</span> <span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"status"</span> <span class="p">:</span> <span class="s2">"open"</span>
-<span class="p">}</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p><strong>Parameters:</strong></p>
- <ul>
- <li>app – [string] application name (e.g. xdata_v3)</li>
- </ul>
-</blockquote>
-
-<blockquote>
- <p><strong>Returns:</strong></p>
- <ul>
- <li>[dict] dictionary of application and its meta information</li>
- </ul>
-</blockquote>
-
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">static</span> <span class="n">delete</span><span class="p">(</span><span class="n">app</span><span class="p">)</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p>Technically closes the index so its content is not searchable.</p>
-</blockquote>
-
-<blockquote>
- <p><strong>Parameters:</strong></p>
- <ul>
- <li>app – [string] application name (e.g. xdata_v3)</li>
- </ul>
-</blockquote>
-
-<blockquote>
- <p><strong>Returns:</strong></p>
- <ul>
- <li>[dict] status message of the event</li>
- </ul>
-</blockquote>
-
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">static</span> <span class="n">get_applications</span><span class="p">()</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p>Fetch all the registered applications in Distill.</p>
-</blockquote>
-
-<blockquote>
- <p><em>Note:</em> Private indexes starting with a period are not included in the result set</p>
-</blockquote>
-
-<blockquote>
- <p><strong>Returns:</strong></p>
- <ul>
- <li>[dict] dictionary of all registered applications and meta information</li>
- </ul>
-</blockquote>
-
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">static</span> <span class="n">get_status</span><span class="p">()</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p>Fetch the status of the underlying database instance.</p>
-</blockquote>
-
-<blockquote>
- <p><strong>Returns:</strong></p>
- <ul>
- <li>[bool] if connection to database instance has been established</li>
- </ul>
-</blockquote>
-
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">static</span> <span class="n">read</span><span class="p">(</span><span class="n">app</span><span class="p">,</span> <span class="n">app_type</span><span class="o">=</span><span class="bp">None</span><span class="p">)</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p>Fetch meta data associated with an application</p>
-</blockquote>
-
-<blockquote>
- <p>Example:</p>
- <div class="language-javascript highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="p">{</span>
- <span class="s2">"application"</span> <span class="p">:</span> <span class="s2">"xdata_v3"</span><span class="p">,</span>
- <span class="s2">"health"</span> <span class="p">:</span> <span class="s2">"green"</span><span class="p">,</span>
- <span class="s2">"num_docs"</span> <span class="p">:</span> <span class="s2">"100"</span><span class="p">,</span>
- <span class="s2">"status"</span> <span class="p">:</span> <span class="s2">"open"</span>
- <span class="s2">"types"</span> <span class="p">:</span> <span class="p">{</span>
- <span class="s2">"raw_logs"</span> <span class="p">:</span> <span class="p">{</span>
- <span class="s2">"@timestamp"</span> <span class="p">:</span> <span class="s2">"date"</span><span class="p">,</span>
- <span class="s2">"action"</span> <span class="p">:</span> <span class="s2">"string"</span><span class="p">,</span>
- <span class="s2">"elementId"</span> <span class="p">:</span> <span class="s2">"string"</span>
- <span class="p">},</span>
- <span class="s2">"parsed"</span> <span class="p">:</span> <span class="p">{</span>
- <span class="s2">"@timestamp"</span> <span class="p">:</span> <span class="s2">"date"</span><span class="p">,</span>
- <span class="s2">"elementId_interval"</span> <span class="p">:</span> <span class="s2">"string"</span>
- <span class="p">},</span>
- <span class="s2">"graph"</span> <span class="p">:</span> <span class="p">{</span>
- <span class="s2">"uniqueID"</span> <span class="p">:</span> <span class="s2">"string"</span><span class="p">,</span>
- <span class="s2">"transition_count"</span> <span class="p">:</span> <span class="s2">"long"</span><span class="p">,</span>
- <span class="s2">"p_value"</span> <span class="p">:</span> <span class="s2">"float"</span>
- <span class="p">}</span>
- <span class="p">}</span>
-<span class="p">}</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p><strong>Parameters:</strong></p>
- <ul>
- <li>app – [string] application name (e.g. xdata_v3)</li>
- </ul>
-</blockquote>
-
-<blockquote>
- <p><strong>Returns:</strong></p>
- <ul>
- <li>[dict] dictionary of application and its meta information</li>
- </ul>
-</blockquote>
-
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">static</span> <span class="n">update</span><span class="p">(</span><span class="n">app</span><span class="p">)</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p><strong>Todo:</strong> Currently not implemented</p>
-</blockquote>
-
-<h3 id="stout-interface">Stout Interface</h3>
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">class</span> <span class="nc">distill</span><span class="o">.</span><span class="n">models</span><span class="o">.</span><span class="n">stout</span><span class="o">.</span><span class="n">Stout</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p><strong>Bases:</strong> object</p>
-</blockquote>
-
-<blockquote>
- <p>Main Stout class to support ingest and search operations.</p>
-</blockquote>
-
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">static</span> <span class="n">ingest</span><span class="p">()</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p>Ingest data coming from Stout to Distill</p>
-</blockquote>
-
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">class</span> <span class="nc">distill</span><span class="o">.</span><span class="n">models</span><span class="o">.</span><span class="n">stout</span><span class="o">.</span><span class="n">StoutDoc</span><span class="p">(</span><span class="n">meta</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kw [...]
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p><strong>Bases:</strong> elasticsearch_dsl.document.DocType</p>
-</blockquote>
-
-<blockquote>
- <p>Representation of a Stout document.</p>
-</blockquote>
-
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">save</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p>Save data from parsing as a Stout document in Distill</p>
-</blockquote>
-
-<h3 id="userale-interface">UserAle Interface</h3>
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">class</span> <span class="nc">distill</span><span class="o">.</span><span class="n">models</span><span class="o">.</span><span class="n">userale</span><span class="o">.</span><span class="n">UserAle</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p><strong>Bases:</strong> object</p>
-</blockquote>
-
-<blockquote>
- <p>Main method of entry to perform segmentation and integration of STOUT’s master answer table (if STOUT is enabled). Advanced and basic analytics is performed in the distill.algorithms.stats and distill.algorithms.graphs module.</p>
-</blockquote>
-
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">static</span> <span class="n">denoise</span><span class="p">(</span><span class="n">app</span><span class="p">,</span> <span class="n">app_type</span><span class="o">=</span><span class="s">'parsed'</span><span class="p">,</span> <span class="n">save</span><span class="o">=</span><span class="bp">False</span><span class="p">)</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">static</span> <span class="n">search</span><span class="p">(</span><span class="n">app</span><span class="p">,</span> <span class="n">app_type</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">filters</span><span class="o">=</span><span class="p">[],</span>
-<span class="n">size</span><span class="o">=</span><span class="mi">100</span><span class="p">,</span> <span class="n">include</span><span class="o">=</span><span class="s">'*'</span><span class="p">,</span> <span class="n">scroll</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">sort_field</span><span class="o">=</span><span class="bp">None</span><span class="p">)</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p>Perform a search query.</p>
-</blockquote>
-
-<blockquote>
- <p><strong>Parameters:</strong></p>
- <ul>
- <li>app – [string] application id (e.g. “xdata_v3”)</li>
- <li>app_type – [string] name of the application type. If None all application types are searched.</li>
- <li>filters – [list of strings] list of filters for a query.</li>
- <li>size – [int] maximum number of hits that should be returned</li>
- <li>sort_field – [string] sorting field. Currently supported fields: “timestamp”, “date”</li>
- </ul>
-</blockquote>
-
-<blockquote>
- <p><strong>Returns</strong></p>
- <ul>
- <li>[dict] dictionary with processed results. If STOUT is enabled, STOUT data will be merged with final result.</li>
- </ul>
-</blockquote>
-
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">static</span> <span class="n">segment</span><span class="p">(</span><span class="n">app</span><span class="p">,</span> <span class="n">app_type</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">params</span><span class="o">=</span><span class="s">''</span><span class="p">)</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p>Just support match all for now.</p>
-</blockquote>
-
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">distill</span><span class="o">.</span><span class="n">models</span><span class="o">.</span><span class="n">userale</span><span class="o">.</span><span class="n">merge_dicts</span><span class="p">(</span><span class="n">lst</span><span class="p">)</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">distill</span><span class="o">.</span><span class="n">models</span><span class="o">.</span><span class="n">userale</span><span class="o">.</span><span class="n">parse_query_parameters</span><span class="p">(</span><span class="n">indx</span><span class="p">,</span> <span class="n">app_type</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> < [...]
-</code></pre></div> </div>
-</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 © 2023 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/distill/start.html
deleted file mode 100644
index ca2dbb6..0000000
--- a/content/docs/distill/start.html
+++ /dev/null
@@ -1,342 +0,0 @@
-<!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="This project is not currently maintained and will be refactored. If you are interested in Distill, join the discussion on our dev list.">
-
- <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.apache.org/docs/distill/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">
- Products
- <div class="menu">
- <a class="item" href="/stack">Stack</a>
- <a class="item" href="/userale">UserALE</a>
- <a class="item" href="/distill">Distill</a>
- <a class="item" href="/tap">Tap</a>
- <a class="item" href="/stout">Stout</a>
- </div>
- </div>
- <div class="ui dropdown item">
- <a href="/docs">Docs</a>
- <div class="menu">
- <a class="item" href="/docs/stack">Stack</a>
- <a class="item" href="/docs/userale">UserALE</a>
- <a class="item" href="/docs/useralejs">UserALE.js</a>
- <a class="item" href="/docs/useralepy">UserALE.py</a>
- <a class="item" href="/docs/distill">Distill</a>
- <a class="item" href="/docs/tap">Tap</a>
- <a class="item" href="/docs/stout">Stout</a>
- </div>
- </div>
- <a class="item" href="/releases">Releases</a>
- <a class="item" href="/community">Community</a>
- </div>
- </div>
-</div>
-
-
- <div class="main-wrapper">
- <div class="docs-wrapper">
- <div class="docs-sidebar">
-
-
-
-
-
-
-
-
-
-<!-- <div class="ui inverted list">
- <a class="item" href="/docs">About the Docs</a>
-</div> -->
-<div id="docs-nav" class="ui inverted accordion">
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Apache Flagon
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/">About the Docs</a>
-
- <a class="item" href="/docs/contributing/">Contributing</a>
-
- </div>
- </div>
-
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Stack
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/stack/">Getting Started</a>
-
- <a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- UserALE
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/userale/">About UserALE</a>
-
- </div>
- </div>
-
-
- <div class="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/">UserALE.js Build and Test</a>
-
- <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
-
- <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
-
- <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
-
- <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- UserALE.py
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/useralepy/">Installation</a>
-
- <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
-
- <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
-
- <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
-
- </div>
- </div>
-
-
- <div class="active title">
-
- <i class="dropdown icon"></i>
- Distill
- </div>
-
- <div class="active 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>
- <h4 id="this-project-is-not-currently-maintained-and-will-be-refactored-if-you-are-interested-in-distill-join-the-discussion-on-our-dev-list">This project is not currently maintained and will be refactored. If you are interested in Distill, join the discussion on our <a href="mailto:dev-subscribe@flagon.incubator.apache.org">dev list</a>.</h4>
-
-<h3 id="usage">Usage</h3>
-
-<p>Using curl:</p>
-
-<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nv">$ </span>curl <span class="nt">-XGET</span> <span class="s1">'http://localhost:8090/app/register'</span> <span class="nt">-d</span> <span class="s1">'{
- "application_name" : "my_app",
- "version" : "0.1",
- "application_description" : "my test app"
- }'</span>
-</code></pre></div></div>
-
- </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 © 2023 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/utilities.html b/content/docs/distill/utilities.html
deleted file mode 100644
index e7162ca..0000000
--- a/content/docs/distill/utilities.html
+++ /dev/null
@@ -1,423 +0,0 @@
-<!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>Apache Distill Utilities</title>
- <meta name="description" content="Query Builder class distill.utils.query_builder.QueryBuilder(query=None)">
-
- <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.apache.org/docs/distill/utilities.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">
- Products
- <div class="menu">
- <a class="item" href="/stack">Stack</a>
- <a class="item" href="/userale">UserALE</a>
- <a class="item" href="/distill">Distill</a>
- <a class="item" href="/tap">Tap</a>
- <a class="item" href="/stout">Stout</a>
- </div>
- </div>
- <div class="ui dropdown item">
- <a href="/docs">Docs</a>
- <div class="menu">
- <a class="item" href="/docs/stack">Stack</a>
- <a class="item" href="/docs/userale">UserALE</a>
- <a class="item" href="/docs/useralejs">UserALE.js</a>
- <a class="item" href="/docs/useralepy">UserALE.py</a>
- <a class="item" href="/docs/distill">Distill</a>
- <a class="item" href="/docs/tap">Tap</a>
- <a class="item" href="/docs/stout">Stout</a>
- </div>
- </div>
- <a class="item" href="/releases">Releases</a>
- <a class="item" href="/community">Community</a>
- </div>
- </div>
-</div>
-
-
- <div class="main-wrapper">
- <div class="docs-wrapper">
- <div class="docs-sidebar">
-
-
-
-
-
-
-
-
-
-<!-- <div class="ui inverted list">
- <a class="item" href="/docs">About the Docs</a>
-</div> -->
-<div id="docs-nav" class="ui inverted accordion">
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Apache Flagon
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/">About the Docs</a>
-
- <a class="item" href="/docs/contributing/">Contributing</a>
-
- </div>
- </div>
-
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Stack
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/stack/">Getting Started</a>
-
- <a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- UserALE
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/userale/">About UserALE</a>
-
- </div>
- </div>
-
-
- <div class="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/">UserALE.js Build and Test</a>
-
- <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
-
- <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
-
- <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
-
- <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- UserALE.py
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/useralepy/">Installation</a>
-
- <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
-
- <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
-
- <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
-
- </div>
- </div>
-
-
- <div class="active title">
-
- <i class="dropdown icon"></i>
- Distill
- </div>
-
- <div class="active 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">Apache Distill Utilities</h2>
- <h3 id="query-builder">Query Builder</h3>
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">class</span> <span class="nc">distill</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">query_builder</span><span class="o">.</span><span class="n">QueryBuilder</span><span class="p">(</span><span class="n">query</span><span class="o">=</span><span class="bp">None</span><span class="p">)</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p><strong>Bases:</strong> object</p>
-</blockquote>
-
-<h4 id="add_filtersfilters">add_filters(filters)</h4>
-
-<h4 id="add_sortingsort_field-sort_order">add_sorting(sort_field=’’, sort_order=’’)</h4>
-
-<h3 id="exception-handling">Exception Handling</h3>
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">exception</span> <span class="n">distill</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">exceptions</span><span class="o">.</span><span class="n">Error</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p><strong>Bases:</strong> exceptions.Exception</p>
-</blockquote>
-
-<blockquote>
- <p>Base class for exceptions.</p>
-</blockquote>
-
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">exception</span> <span class="n">distill</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">exceptions</span><span class="o">.</span><span class="n">ValidationError</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">msg</span><span class="p">)</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p><strong>Bases:</strong> distill.utils.exceptions.Error</p>
-</blockquote>
-
-<blockquote>
- <p>Exceptions raised for errors in validated a url.</p>
-</blockquote>
-
-<h3 id="validation-library">Validation Library</h3>
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">distill</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">validation</span><span class="o">.</span><span class="n">str2bool</span><span class="p">(</span><span class="n">v</span><span class="p">)</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p>Convert string expression to boolean</p>
-</blockquote>
-
-<blockquote>
- <p><strong>Parameters:</strong></p>
- <ul>
- <li>v – Input value</li>
- </ul>
-</blockquote>
-
-<blockquote>
- <p><strong>Returns:</strong></p>
- <ul>
- <li>Converted message as boolean type</li>
- <li>Return type: bool</li>
- </ul>
-</blockquote>
-
-<blockquote>
-
- <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">distill</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">validation</span><span class="o">.</span><span class="n">validate_request</span><span class="p">(</span><span class="n">q</span><span class="p">)</span>
-</code></pre></div> </div>
-</blockquote>
-
-<blockquote>
- <p>Parse out request message and validate inputs</p>
-</blockquote>
-
-<blockquote>
- <p><strong>Parameters:</strong></p>
- <ul>
- <li>q – Url query string</li>
- </ul>
-</blockquote>
-
-<blockquote>
- <p><strong>Raises:</strong></p>
- <ul>
- <li>ValidationError – if the query is missing required parameters</li>
- </ul>
-</blockquote>
-
- </div>
-</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 © 2023 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/index.html b/content/docs/index.html
index 3b56dc8..7141e1f 100644
--- a/content/docs/index.html
+++ b/content/docs/index.html
@@ -16,7 +16,7 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://flagon.apache.org/docs/">
+ <link rel="canonical" href="https://flagon.apache.org/docs/">
<link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
@@ -35,23 +35,15 @@
<div class="ui dropdown item">
Products
<div class="menu">
- <a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
<a class="item" href="/distill">Distill</a>
- <a class="item" href="/tap">Tap</a>
- <a class="item" href="/stout">Stout</a>
</div>
</div>
<div class="ui dropdown item">
<a href="/docs">Docs</a>
<div class="menu">
- <a class="item" href="/docs/stack">Stack</a>
- <a class="item" href="/docs/userale">UserALE</a>
<a class="item" href="/docs/useralejs">UserALE.js</a>
- <a class="item" href="/docs/useralepy">UserALE.py</a>
<a class="item" href="/docs/distill">Distill</a>
- <a class="item" href="/docs/tap">Tap</a>
- <a class="item" href="/docs/stout">Stout</a>
</div>
</div>
<a class="item" href="/releases">Releases</a>
@@ -68,11 +60,6 @@
-
-
-
-
-
<!-- <div class="ui inverted list">
<a class="item" href="/docs">About the Docs</a>
</div> -->
@@ -95,41 +82,6 @@
</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">
@@ -157,28 +109,6 @@
</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>
@@ -191,56 +121,9 @@
<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>
@@ -259,23 +142,15 @@
<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">
@@ -283,9 +158,6 @@
<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">
@@ -296,17 +168,15 @@
<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>
+ <a class="item" href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy</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 © 2023 The Apache Software Foundation, Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.<br>
+ Copyright © 2024 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>
@@ -314,9 +184,6 @@
<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>
diff --git a/content/docs/stack/index.html b/content/docs/stack/index.html
deleted file mode 100644
index e7d216b..0000000
--- a/content/docs/stack/index.html
+++ /dev/null
@@ -1,388 +0,0 @@
-<!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.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">
- Products
- <div class="menu">
- <a class="item" href="/stack">Stack</a>
- <a class="item" href="/userale">UserALE</a>
- <a class="item" href="/distill">Distill</a>
- <a class="item" href="/tap">Tap</a>
- <a class="item" href="/stout">Stout</a>
- </div>
- </div>
- <div class="ui dropdown item">
- <a href="/docs">Docs</a>
- <div class="menu">
- <a class="item" href="/docs/stack">Stack</a>
- <a class="item" href="/docs/userale">UserALE</a>
- <a class="item" href="/docs/useralejs">UserALE.js</a>
- <a class="item" href="/docs/useralepy">UserALE.py</a>
- <a class="item" href="/docs/distill">Distill</a>
- <a class="item" href="/docs/tap">Tap</a>
- <a class="item" href="/docs/stout">Stout</a>
- </div>
- </div>
- <a class="item" href="/releases">Releases</a>
- <a class="item" href="/community">Community</a>
- </div>
- </div>
-</div>
-
-
- <div class="main-wrapper">
- <div class="docs-wrapper">
- <div class="docs-sidebar">
-
-
-
-
-
-
-
-
-
-<!-- <div class="ui inverted list">
- <a class="item" href="/docs">About the Docs</a>
-</div> -->
-<div id="docs-nav" class="ui inverted accordion">
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Apache Flagon
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/">About the Docs</a>
-
- <a class="item" href="/docs/contributing/">Contributing</a>
-
- </div>
- </div>
-
-
-
- <div class="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/">UserALE.js Build and Test</a>
-
- <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
-
- <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
-
- <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
-
- <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- UserALE.py
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/useralepy/">Installation</a>
-
- <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
-
- <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
-
- <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Distill
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/distill/">Installation</a>
-
- <a class="item" href="/docs/distill/start.html">Getting Started</a>
-
- <a class="item" href="/docs/distill/api.html">API Documentation</a>
-
- <a class="item" href="/docs/distill/analytics.html">Apache Distill Analytics</a>
-
- <a class="item" href="/docs/distill/http.html">Apache Distill HTTP Client</a>
-
- <a class="item" href="/docs/distill/models.html">Apache Distill Models</a>
-
- <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a>
-
- <a class="item" href="/docs/distill/changelog.html">Changelog</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Tap
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/tap/">Getting Started</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Stout
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/stout/">About Stout</a>
-
- <a class="item" href="/docs/stout/start.html">Getting Started</a>
-
- </div>
- </div>
-</div>
-
- </div>
- <div class="docs-content">
- <h2 class="ui header">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"><div class="highlight"><pre class="highlight"><code> <span class="c">#intall NPM packages into build directory</span>
- <span class="nv">$ </span>npm install
-</code></pre></div></div>
-
-<p>Then, <strong>build UserALE.js</strong>.</p>
-<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="c">#produce UserALE.js build artifacts</span>
- <span class="nv">$ </span>npm run build
-</code></pre></div></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"><div class="highlight"><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-2.0.2.min.js"</span> <span class="na">data-url=</span><span class="s">"http://yourLoggingUrl"</span><span class="nt">></script></span>
-</code></pre></div></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 data, 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"><div class="highlight"><pre class="highlight"><code><span class="c"># start virtual machine and requisite network </span>
-<span class="nv">$ </span>docker-machine create <span class="nt">--virtualbox-memory</span> 3072 <span class="nt">--virtualbox-cpu-count</span> 2 flagon
-<span class="nv">$ </span>docker-machine ssh flagon <span class="nb">sudo </span>sysctl <span class="nt">-w</span> vm.max_map_count<span class="o">=</span>262144
-<span class="nv">$ </span>docker network create esnet
-</code></pre></div></div>
-<p>Next, <strong>start Elastic services</strong>.</p>
-
-<div class="language-shell highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="c">#start Elastic services</span>
- <span class="nv">$ </span>docker-compose up <span class="nt">-d</span> elasticsearch
- <span class="nv">$ </span>docker-compuse up <span class="nt">-d</span> logstash
- <span class="nv">$ </span>docker-compose up <span class="nt">-d</span> kibana
-</code></pre></div></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 (Kibana), 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="mailto: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 © 2023 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
deleted file mode 100644
index e8c0815..0000000
--- a/content/docs/stack/scaling/index.html
+++ /dev/null
@@ -1,699 +0,0 @@
-<!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.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">
- Products
- <div class="menu">
- <a class="item" href="/stack">Stack</a>
- <a class="item" href="/userale">UserALE</a>
- <a class="item" href="/distill">Distill</a>
- <a class="item" href="/tap">Tap</a>
- <a class="item" href="/stout">Stout</a>
- </div>
- </div>
- <div class="ui dropdown item">
- <a href="/docs">Docs</a>
- <div class="menu">
- <a class="item" href="/docs/stack">Stack</a>
- <a class="item" href="/docs/userale">UserALE</a>
- <a class="item" href="/docs/useralejs">UserALE.js</a>
- <a class="item" href="/docs/useralepy">UserALE.py</a>
- <a class="item" href="/docs/distill">Distill</a>
- <a class="item" href="/docs/tap">Tap</a>
- <a class="item" href="/docs/stout">Stout</a>
- </div>
- </div>
- <a class="item" href="/releases">Releases</a>
- <a class="item" href="/community">Community</a>
- </div>
- </div>
-</div>
-
-
- <div class="main-wrapper">
- <div class="docs-wrapper">
- <div class="docs-sidebar">
-
-
-
-
-
-
-
-
-
-<!-- <div class="ui inverted list">
- <a class="item" href="/docs">About the Docs</a>
-</div> -->
-<div id="docs-nav" class="ui inverted accordion">
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Apache Flagon
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/">About the Docs</a>
-
- <a class="item" href="/docs/contributing/">Contributing</a>
-
- </div>
- </div>
-
-
-
- <div class="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/">UserALE.js Build and Test</a>
-
- <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
-
- <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
-
- <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
-
- <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- UserALE.py
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/useralepy/">Installation</a>
-
- <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
-
- <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
-
- <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Distill
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/distill/">Installation</a>
-
- <a class="item" href="/docs/distill/start.html">Getting Started</a>
-
- <a class="item" href="/docs/distill/api.html">API Documentation</a>
-
- <a class="item" href="/docs/distill/analytics.html">Apache Distill Analytics</a>
-
- <a class="item" href="/docs/distill/http.html">Apache Distill HTTP Client</a>
-
- <a class="item" href="/docs/distill/models.html">Apache Distill Models</a>
-
- <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a>
-
- <a class="item" href="/docs/distill/changelog.html">Changelog</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Tap
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/tap/">Getting Started</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Stout
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/stout/">About Stout</a>
-
- <a class="item" href="/docs/stout/start.html">Getting Started</a>
-
- </div>
- </div>
-</div>
-
- </div>
- <div class="docs-content">
- <h2 class="ui header">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>.</p>
-
-<p>We provide high-level guidance and considerations for working with an Elastic stack to scale <a href="/docs/useralejs">Apache UserALE.js</a> services.</p>
-
-<p>This guide also provides an overview of benchmarking tools and methodologies for accurately gauging your scaling needs.</p>
-
-<p><strong>“It Depends…“</strong></p>
-
-<p>The best way to scale Apache Flagon depends entirely on your use-case:</p>
-
-<ul>
- <li>how you’ll use your Apache UserALE.js data;</li>
- <li>which <a href="/docs/useralejs/dataschema">data streams</a> you’ll use;</li>
- <li>how long you need to keep your data.</li>
-</ul>
-
-<p><strong>The Apache Flagon Single-Node Elastic Container is an Ingredient, Not a Whole Solution</strong></p>
-
-<p>The single-node Elastic (ELK) build distributed by <a href="/docs/stack">Apache Flagon</a> is not alone suitable for most production-level use-cases.</p>
-
-<p>This build may be suitable for limited user-testing; just a few days of data collection from a specific application, from just a few users.</p>
-
-<p>However, a single-node Elastic build will fail quickly for any enterprise-scale use-cases.</p>
-
-<p>Instead, this container is meant to be a building block for larger solutions:</p>
-
-<ol>
- <li>Our ELK .yml config files for our Docker container can be used as the building-blocks for your very own load-balanced, <a href="https://dzone.com/articles/elasticsearch-tutorial-creating-an-elasticsearch-c">multi-node cluster</a>.</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>Flagon’s behavioral logging capability, <a href="/docs/useralejs">Apache UserALE.js</a> also scales. The most efficient way to manage scale and resources, is to <a href="/docs/useralejs/API">configure</a> or <a href="/docs/useralejs/modifying">modify</a> UserALE.js.</p>
-<h3 id="sizing-up-an-elastic-stack">Sizing Up an Elastic Stack</h3>
-
-<p>Elasticsearch isn’t a database, its a document store; UserALE.js “logs” aren’t logs once they’re indexed in Elastic, they become searchable documents.</p>
-
-<p>Elastic has many useful <a href="(https://www.elastic.co/blog/found-sizing-elasticsearch)">guides</a> on sizing and scaling. Below, we’re adding some thoughts based on Apache Flagon’s own eccentricities.</p>
-
-<p>####Document generation rate is the most important consideration to scaling</p>
-
-<p>Default <a href="/docs/useralejs">Apache UserALE.js parameters</a> produce loads of <a href="/docs/useralejs/dataschema">data</a>, even from a single users.</p>
-
-<p>We strongly suggest that you consider whether you need data from all our event-handlers.</p>
-
-<p>If you don’t need mouseover events, for example, you can dramatically reduce the rate at which you generate data and the resources you’ll need.</p>
-
-<p>Instead, you can <a href="/docs/useralejs/modifying">modify source</a> or use the <a href="/docs/useralejs/API">UserALE.js API</a>, and/or use <a href="/docs/useralejs">configurable HTLM5 parameters in our script tag</a> to manage data generation rate.</p>
-
-<p>####Resource needs will also grow with document length</p>
-
-<p><a href="https://blog.appdynamics.com/product/estimating-costs-of-storing-documents-in-elasticsearch/">Strings</a> within UserALE.js 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>) can add to scaling needs.</p>
-
-<p>One of the discriminating features of Apache UserALE.js is its precision:</p>
-
-<ul>
- <li>it captures target DOM elements;</li>
- <li>it captures the DOM path that elements are nested in;</li>
- <li>it captures loads of metadata (URI, page title, page url, referrer, etc.).</li>
-</ul>
-
-<p>UserALE.js fields like <code class="highlighter-rouge">path</code> and <code class="highlighter-rouge">pageUrl</code> can be lengthy for certain pages, increasing string length per document.</p>
-
-<p>Instead, you might consider relying on <code class="highlighter-rouge">pageTitle</code> rather than <code class="highlighter-rouge">pageUrl</code>, or just <code class="highlighter-rouge">target</code> instead of <code class="highlighter-rouge">path</code></p>
-
-<p>Below is a sample <code class="highlighter-rouge">path</code> for a Kibana element:</p>
-
-<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>```shell
-...
- "pageTitle": "Discover - Kibana",
- "toolName": "test_app",
- "userId": "nobody",
- "type": "click",
- "target": "a.kuiButton kuiButton--small kuiButton--secondary",
- "path": [
- "a.kuiButton kuiButton--small kuiButton--secondary",
- "div.kbnDocTableDetails__actions",
- "td",
- "tr",
- "tbody",
- "table.kbn-table table",
- "div.kbnDocTable__container",
- "doc-table",
- "section.dscTable",
- "div.dscResults",
- "div.dscWrapper__content",
- "div.dscWrapper col-md-10",
- "div.row",
- "main.container-fluid",
- "discover-app.app-container",
- "div.application tab-discover",
- "div.app-wrapper-panel",
- "div.app-wrapper",
- "div.content",
- "div#kibana-body",
- "body#kibana-app.coreSystemRootDomElement",
- "html",
- "#document",
- "Window"
- ...
-```
-</code></pre></div></div>
-
-<p>Through simple <a href="/docs/useralejs/modifying">modifications to UserALE.js source</a> or with the UserALE.js <a href="/docs/useralejs/API">API</a> you can alias verbose fields in your logs to reduce resource consumption.</p>
-
-<p>####Additional services attached to your stack can increase resource consumption</p>
-
-<p>Apache Flagon scales–Elastic products make it easy to attach other services to your Apache Flagon stack.</p>
-
-<p>The <em>number of services</em> connected to your stack will affect your Elastic stacks’ performance.</p>
-
-<p>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 load-balancing node).</p>
-
-<p>As you configure that cluster, be mindful that Elasticsearch is indexing and servicing queries and aggregations for connected servies.</p>
-
-<p>Analytical services connected to the stack can consume significant resources and increase indexing and search time.</p>
-
-<p>This can be problematic for real-time analytical and monitoring applications (including Kibana).</p>
-
-<p>For hefty analytical services, it may be worth dedicating specific nodes in your cluster to service them.</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>For the reasons above, its really critical to do some benchmarking for your use-case prior to deciding on a scaling strategy.</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, use our <a href="https://github.com/apache/incubator-flagon-useralejs/tree/master/example">UserALE.js Example</a> test utility or your own website.</p>
-
-<p>Our test utility that makes it easy to <a href="/docs/useralejs/modifying">modify</a> UserALE.js HTML5 and API parameters on the fly.</p>
-
-<p>However, 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 Elasticsearch, Logstash, Kibana, and metricbeat are up, look at the <code class="highlighter-rouge">userale</code> index stats.</strong>
- <div class="language-shell highlighter-rouge"><div class="highlight"><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> </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"><div class="highlight"><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> </div>
- <p>Let’s call this value a simple benchmark.</p>
-
- <p>As you continue 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 default parameters on your page or app.</strong></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"><div class="highlight"><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> </div>
- <p>To get a conservative upper-bound, generate as many mouseover and scroll behaviors in your page/app as you can.</p>
-
- <p>Doing that for 5 minutes solid, our <code class="highlighter-rouge">userale</code> index looks like this (#note annotations):</p>
-
- <div class="language-shell highlighter-rouge"><div class="highlight"><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> </div>
- <p><strong>That’s +1,998 documents (2000) and +579,866 bytes (.58 MB) generated with UserALE.js by one user in 5 mins</strong>.</p>
-
- <p>Assuming this rate over an 8 hour period each day for 20 working days: that’s <strong>1.1 GB per month</strong>.</p>
-
- <p><strong>This is an ultra-conservative, worst-case-scenario estimate</strong> because no one uses pages or applications this way.</p>
-
- <p>If you’re a scientist or researcher, these figures might be fine, but it might be overkill for business analytics.</p>
-
- <p>To find the biggest culprit in data generation: take a look at our <code class="highlighter-rouge">Apache Flagon Page Usage Dashboard</code> to see.</p>
-
- <p><img src="/images/mouseOverBench1.png" width="750" height="500" /></p>
-
- <p>Mouseovers accounted for a lot of the data we just produced–its written frequently to index.</p>
- </li>
- <li>
- <p><strong>Next, scale back UserALE.js mouseover handling and see how this changes data generation rate</strong>.</p>
-
- <p>Using the UserALE.js HTML5 <code class="highlighter-rouge">settings</code> in our script tag, you can “downsample” certain event handler that generate a lot of documents.</p>
-
- <p>Here’s what our script tag looks like now:</p>
- <div class="highlighter-rouge"><div class="highlight"><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 #increased the delay between collection of frequent events (e.g., mouseovers).
- data-tool="Apache UserALE.js Example"
- ></script>
-</code></pre></div> </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"><div class="highlight"><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> </div>
- <p><strong>That is +1518 documents and +295K bytes (.30 MB)</strong></p>
-
- <p>But, it’s 500 fewer than our first benchmark and ~40% less growth in the store.</p>
-
- <p>At <strong>~576 MB per working month</strong> we’ve cut data generation considerably by modifying one parameter in the script tag.</p>
-
- <p>The proportion of mouseover events is down by ~50%, and 25% fewer documents overall:</p>
-
- <p><img src="/images/mouseOverBench2.png" width="750" height="500" /></p>
- </li>
- <li>
- <p><strong>Still too much data? Below are some other ways to curb the growth of your <code class="highlighter-rouge">userale</code> index</strong>.</p>
-
- <ul>
- <li>Modify <a href="https://github.com/apache/incubator-flagon-useralejs/tree/master/src">UserALE.js source</a> to cut down on event handlers (<code class="highlighter-rouge">attachHandlers.js</code>).</li>
- <li>Drop interval logging 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>).</li>
- <li>Reduce the amount of metadata you collect 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>).</li>
- <li>Use different UserALE.js script builds for different pages within your site/app to serve different logging needs.</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>
-
-<p>In our benchmarking guide, we primarily used Elastic’s <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-stats.html"><code class="highlighter-rouge">Stats</code> API</a>.</p>
-
-<p>You can <strong>use other <a href="https://www.datadoghq.com/blog/collect-elasticsearch-metrics/#index-stats-api">Elastic APIs</a></strong> for different views of what’s going on inside your Apache Flagon stack.</p>
-
-<p>For more streamlined views into your indices, try the <code class="highlighter-rouge">CAT</code> API. Try this call in your browser:</p>
-
-<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>http://localhost:9200/_cat/indices?format=json&bytes=b&pretty
-
-Output is very simple and index sizes stack on top of one another
-```shell
-[
- {
- "health" : "green",
- "status" : "open",
- "index" : ".kibana_1",
- "uuid" : "FnI_6AQYQEWp2mIxSlM8HQ",
- "pri" : "1",
- "rep" : "0",
- "docs.count" : "184",
- "docs.deleted" : "13",
- "store.size" : "366457",
- "pri.store.size" : "366457"
- },
- {
- "health" : "yellow",
- "status" : "open",
- "index" : "metricbeat-6.6.2-2019.04.22",
- "uuid" : "pDYNmzsxTFu9Z0Tc1_GdLw",
- "pri" : "5",
- "rep" : "1",
- "docs.count" : "4687",
- "docs.deleted" : "0",
- "store.size" : "6309920",
- "pri.store.size" : "6309920"
- },
- {
- "health" : "green",
- "status" : "open",
- "index" : "userale",
- "uuid" : "0h0Wxe2cSwqMALs4QCJ8Tw",
- "pri" : "1",
- "rep" : "0",
- "docs.count" : "14018",
- "docs.deleted" : "0",
- "store.size" : "2235963",
- "pri.store.size" : "2235963"
- },
- {
- "health" : "yellow",
- "status" : "open",
- "index" : "metricbeat-6.6.2-2019.04.27",
- "uuid" : "wTyUBXvNRMOwpR4lDF9BNA",
- "pri" : "5",
- "rep" : "1",
- "docs.count" : "107124",
- "docs.deleted" : "0",
- "store.size" : "63263644",
- "pri.store.size" : "63263644"
- }
-]
-```
-</code></pre></div></div>
-
-<p><strong>Use Flagon’s pre-configured metricbeat service</strong> to run with Flagon.</p>
-
-<p>You can use this utility to see how your Apache Flagon stack is utilizing disk and compute resources.</p>
-
-<p>See a sample view of Metricbeat stats below:</p>
-
-<p><img src="/images/metricBeat.png" width="750" height="500" /></p>
-
-<h3 id="wonky-things-that-can-and-will-happen-as-you-benchmark">Wonky Things that Can and Will Happen as You Benchmark</h3>
-
-<p>You just finished a benchmarking session after modifying UserALE.js to produce less data.</p>
-
-<p>What you find is that your new store size is either dramatically bigger than your last benchmark or smaller (which should be impossible).</p>
-
-<p>What happened is a thing called <a href="https://www.elastic.co/guide/en/elasticsearch/guide/current/merge-process.html">merging</a>.</p>
-
-<p>As data is collected it’s gathered into segments within an index. Each segment is an element of your index and takes up storage.</p>
-
-<p>As Elastic (Lucene) indexes, it merges these segments into larger segments to reduce the overall number of segments to minimize storage.</p>
-
-<p>This means that a call to Elastic’s <code class="highlighter-rouge">STATS</code> API can result in a view into the store size at different stages in the merging process.</p>
-
-<p>If your store size looks smaller than your last benchmark. You should re-run it then wait.</p>
-
-<p>If your store size looks way to big, then wait. After a minute, call the <code class="highlighter-rouge">STATS</code> API again, and you’ll likely see a more sensible store size.</p>
-
-<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.</p>
-
-<p>We combine easily deployed and modified capabilities with the power of Elastic’s APIs and visualization capabilities.</p>
-
-<p>Again, Flagon’s single-node container is not a scaling solution.</p>
-
-<p>It’s a building block benchmarking tool to help you build and manage scale and cost.</p>
-
-<p>Subscribe to our <a href="mailto: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 © 2023 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
deleted file mode 100644
index 9e3c89e..0000000
--- a/content/docs/stout/index.html
+++ /dev/null
@@ -1,353 +0,0 @@
-<!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>About Stout</title>
- <meta name="description" content="This project is not currently maintained and will be refactored. If you are interested in STOUT, join the discussion on our dev list.">
-
- <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.apache.org/docs/stout/">
- <link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
-
-
-</head>
-
-
- <body>
-
- <div class="site-header">
- <div id="main-menu" class="ui inverted padded fixed top borderless menu">
- <a class="site-title" href="/">
- <h3 class="ui inverted header item">Apache Flagon</h3>
- </a>
-
- <div class="right menu">
- <div class="ui dropdown item">
- Products
- <div class="menu">
- <a class="item" href="/stack">Stack</a>
- <a class="item" href="/userale">UserALE</a>
- <a class="item" href="/distill">Distill</a>
- <a class="item" href="/tap">Tap</a>
- <a class="item" href="/stout">Stout</a>
- </div>
- </div>
- <div class="ui dropdown item">
- <a href="/docs">Docs</a>
- <div class="menu">
- <a class="item" href="/docs/stack">Stack</a>
- <a class="item" href="/docs/userale">UserALE</a>
- <a class="item" href="/docs/useralejs">UserALE.js</a>
- <a class="item" href="/docs/useralepy">UserALE.py</a>
- <a class="item" href="/docs/distill">Distill</a>
- <a class="item" href="/docs/tap">Tap</a>
- <a class="item" href="/docs/stout">Stout</a>
- </div>
- </div>
- <a class="item" href="/releases">Releases</a>
- <a class="item" href="/community">Community</a>
- </div>
- </div>
-</div>
-
-
- <div class="main-wrapper">
- <div class="docs-wrapper">
- <div class="docs-sidebar">
-
-
-
-
-
-
-
-
-
-<!-- <div class="ui inverted list">
- <a class="item" href="/docs">About the Docs</a>
-</div> -->
-<div id="docs-nav" class="ui inverted accordion">
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Apache Flagon
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/">About the Docs</a>
-
- <a class="item" href="/docs/contributing/">Contributing</a>
-
- </div>
- </div>
-
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Stack
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/stack/">Getting Started</a>
-
- <a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- UserALE
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/userale/">About UserALE</a>
-
- </div>
- </div>
-
-
- <div class="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/">UserALE.js Build and Test</a>
-
- <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
-
- <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
-
- <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
-
- <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- UserALE.py
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/useralepy/">Installation</a>
-
- <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
-
- <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
-
- <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Distill
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/distill/">Installation</a>
-
- <a class="item" href="/docs/distill/start.html">Getting Started</a>
-
- <a class="item" href="/docs/distill/api.html">API Documentation</a>
-
- <a class="item" href="/docs/distill/analytics.html">Apache Distill Analytics</a>
-
- <a class="item" href="/docs/distill/http.html">Apache Distill HTTP Client</a>
-
- <a class="item" href="/docs/distill/models.html">Apache Distill Models</a>
-
- <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a>
-
- <a class="item" href="/docs/distill/changelog.html">Changelog</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Tap
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/tap/">Getting Started</a>
-
- </div>
- </div>
-
-
- <div class="active title">
-
- <i class="dropdown icon"></i>
- Stout
- </div>
-
- <div class="active 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">About Stout</h2>
- <h4 id="this-project-is-not-currently-maintained-and-will-be-refactored-if-you-are-interested-in-stout-join-the-discussion-on-our-dev-list">This project is not currently maintained and will be refactored. If you are interested in STOUT, join the discussion on our <a href="mailto:dev-subscribe@flagon.incubator.apache.org">dev list</a>.</h4>
-
-<p>The Subject Tracker for Online User Testing (STOUT) is a content management system for formal human performance experimentation. STOUT presents tools and operational tasks to each participant. In doing so, it collects:</p>
-
-<ul>
- <li>an intake questionnaire to assess the user’s background and experience as an analyst</li>
- <li>operational task performance and confidence in responses i.e. did they get the right answer? How sure are they?</li>
- <li>subjective feedback (did they like how the tool worked?)</li>
- <li>screen captures</li>
- <li>physiological response, which help infer operator workload (how hard did they work?).</li>
-</ul>
-
-<p>The STOUT system provides human-subjects testing experiment administrators with a flexible tool for managing and tracking user progress through a series of online tasks. The STOUT system was designed to help collect information about the utility of online applications.</p>
-
-<h3 id="who-is-stout-for">Who is STOUT for?</h3>
-
-<p>This package is for developers. A framework has been built but many features and additions can still be added.</p>
-
-<p>This package is also for experiment administrators. This system can be used immediately to conduct new evaluations of online applications.</p>
-
-<h3 id="for-more-information">For more information</h3>
-
-<p>STOUT was built using Django 1.6. For more advanced developer information or instructions on how to setup your own system, consult the documentation for Django <a href="https://www.djangoproject.com/">here</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 © 2023 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/start.html b/content/docs/stout/start.html
deleted file mode 100644
index 543f6f2..0000000
--- a/content/docs/stout/start.html
+++ /dev/null
@@ -1,425 +0,0 @@
-<!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="This project is not currently maintained and will be refactored. If you are interested in STOUT, join the discussion on our dev list.">
-
- <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.apache.org/docs/stout/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">
- Products
- <div class="menu">
- <a class="item" href="/stack">Stack</a>
- <a class="item" href="/userale">UserALE</a>
- <a class="item" href="/distill">Distill</a>
- <a class="item" href="/tap">Tap</a>
- <a class="item" href="/stout">Stout</a>
- </div>
- </div>
- <div class="ui dropdown item">
- <a href="/docs">Docs</a>
- <div class="menu">
- <a class="item" href="/docs/stack">Stack</a>
- <a class="item" href="/docs/userale">UserALE</a>
- <a class="item" href="/docs/useralejs">UserALE.js</a>
- <a class="item" href="/docs/useralepy">UserALE.py</a>
- <a class="item" href="/docs/distill">Distill</a>
- <a class="item" href="/docs/tap">Tap</a>
- <a class="item" href="/docs/stout">Stout</a>
- </div>
- </div>
- <a class="item" href="/releases">Releases</a>
- <a class="item" href="/community">Community</a>
- </div>
- </div>
-</div>
-
-
- <div class="main-wrapper">
- <div class="docs-wrapper">
- <div class="docs-sidebar">
-
-
-
-
-
-
-
-
-
-<!-- <div class="ui inverted list">
- <a class="item" href="/docs">About the Docs</a>
-</div> -->
-<div id="docs-nav" class="ui inverted accordion">
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Apache Flagon
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/">About the Docs</a>
-
- <a class="item" href="/docs/contributing/">Contributing</a>
-
- </div>
- </div>
-
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Stack
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/stack/">Getting Started</a>
-
- <a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- UserALE
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/userale/">About UserALE</a>
-
- </div>
- </div>
-
-
- <div class="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/">UserALE.js Build and Test</a>
-
- <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
-
- <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
-
- <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
-
- <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- UserALE.py
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/useralepy/">Installation</a>
-
- <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
-
- <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
-
- <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Distill
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/distill/">Installation</a>
-
- <a class="item" href="/docs/distill/start.html">Getting Started</a>
-
- <a class="item" href="/docs/distill/api.html">API Documentation</a>
-
- <a class="item" href="/docs/distill/analytics.html">Apache Distill Analytics</a>
-
- <a class="item" href="/docs/distill/http.html">Apache Distill HTTP Client</a>
-
- <a class="item" href="/docs/distill/models.html">Apache Distill Models</a>
-
- <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a>
-
- <a class="item" href="/docs/distill/changelog.html">Changelog</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Tap
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/tap/">Getting Started</a>
-
- </div>
- </div>
-
-
- <div class="active title">
-
- <i class="dropdown icon"></i>
- Stout
- </div>
-
- <div class="active 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>
- <h4 id="this-project-is-not-currently-maintained-and-will-be-refactored-if-you-are-interested-in-stout-join-the-discussion-on-our-dev-list">This project is not currently maintained and will be refactored. If you are interested in STOUT, join the discussion on our <a href="mailto:dev-subscribe@flagon.incubator.apache.org">dev list</a>.</h4>
-
-<h3 id="getting-going">Getting Going…</h3>
-<p>If you already have your own system and just want to work with the source code, then skip to the next section. Otherwise read on…</p>
-
-<p>The simplest way to get started, rather than build your own system from the ground up, is to download both <a href="https://www.virtualbox.org">VirtualBox</a> and <a href="https://www.vagrantup.com">Vagrant</a>. Once you have both of those working, you can clone this repository to begin.</p>
-
-<h4 id="getting-this-working-on-vagrant-virtualbox">Getting this working on Vagrant (VirtualBox)</h4>
-
-<p>Get a base centos box (this may take awhile)</p>
-
-<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code> vagrant box add centos_6.5 https://github.com/2creatives/vagrant-centos/
- releases/download/v6.5.3/centos65-x86_64-20140116.box
-</code></pre></div></div>
-
-<p>Start it</p>
-
-<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code> vagrant up virtualbox
-</code></pre></div></div>
-
-<h4 id="getting-this-working-on-vagrant-openstack">Getting this working on Vagrant (OpenStack)</h4>
-
-<p>Get a base centos box (this may take awhile)</p>
-
-<p>You need 2 files:</p>
-
-<ol>
- <li>
- <p>The first is the <code class="highlighter-rouge">.pem</code> (or <code class="highlighter-rouge">.cer</code>) file which is the KeyPair file you can download from the OpenStack dashboard.</p>
- </li>
- <li>
- <p>The second is a shell script which contains all the environment variables referenced in the Vagrantfile. This is located under API Access under the Security Settings. Once you download this file run <code class="highlighter-rouge">source $file.sh</code>, and this will ask you for you OpenStack password and load all the required varaibles under your current environment.</p>
- </li>
-</ol>
-
-<p>Adjust the Vagrantfile to use the appropriate <code class="highlighter-rouge">.pem</code> file and the appropriate KeyPair name associated with that pem file. Once that is complete you can run:</p>
-
-<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code> vagrant up openstack <span class="nt">--provider</span><span class="o">=</span>openstack
-</code></pre></div></div>
-
-<hr />
-<h3 id="if-you-already-have-your-own-system">If you already have your own system…</h3>
-
-<p>Once this package is cloned, create the database</p>
-
-<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code> python manage.py syncdb
-</code></pre></div></div>
-
-<p>This will also create a superuser.</p>
-
-<h4 id="during-development-if-you-want-to-drop-to-the-database-and-start-over-run-the-following">During development, if you want to drop to the database and start over run the following:</h4>
-
-<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code> python manage.py sqlclear op_tasks | python manage.py dbshell
- python manage.py syncdb
- python manage.py populate_db
-</code></pre></div></div>
-
-<p>This will keep your super user and drop just the app database which is a lot nicer than deleting the whole database and starting over</p>
-
-<p>This process is also under the <code class="highlighter-rouge">reset_optask</code> command</p>
-
-<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code> python manage.py reset_optask
-</code></pre></div></div>
-
-<hr />
-<h3 id="now-that-stout-is-running">Now that STOUT is running…</h3>
-<p>The following instructions assume you’re using Vagrant. If you’re using another system, you might need to alter them slightly (e.g. different IP addresses, etc.) to get the same results.</p>
-
-<h4 id="test-operation">Test operation</h4>
-<p>Open a browser and point it to <a href="http://localhost:8080">localhost:8080</a>. You should see the welcome page for the XDATA Online Experiment. The system comes with a one prepopulated example task. Register a new user and test it out.</p>
-
-<h4 id="access-admin-page">Access admin page</h4>
-<p>The Admin page allows direct access to the STOUT database. From this page you can manage users, tasks, and products directly. Before you can access the admin page, you need to create a superuser. If you’re using Vagrant you can ssh into that system using</p>
-
-<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code> vagrant ssh virtualbox
-</code></pre></div></div>
-
-<p>Navigate to the source directory and add a superuser</p>
-
-<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nb">cd</span> /var/www/op_tasks/db/
- <span class="nb">sudo </span>python manage.py createsuperuser
-</code></pre></div></div>
-
-<p>Now point your browser to the admin page at <a href="http://localhost:8080/admin">localhost:8080/admin</a> to begin browsing the STOUT database.</p>
-
-<h4 id="add-subjects">Add subjects</h4>
-<p>From the admin page, you can pre-register users through the Participants link.</p>
-<h4 id="add-tasks">Add tasks</h4>
-<p>You can also add new tasks for users to complete through the Op tasks link. First however you must add a dataset for the task to reference. That can be done through the Datasets link.</p>
-<h4 id="add-products">Add products</h4>
-<p>New products can be added through the product link. Products are tools available online. Copy and past the address for the tool into the URL field and then fill in the remaining information.</p>
-<h4 id="assign-task-sequences">Assign task sequences</h4>
-<p>Normally, a user is assigned a random order of tasks from all those that are available. If you’d prefer to assign a sequence of tasks though that can be managed through the TaskListItem link.</p>
-
-<p><strong>Note:</strong> If you assign multiple tasks to a single user, only mark the first task as <strong><em>Ot active</em></strong> and leave all checkboxes for the remaining tasks empty</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 © 2023 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/system/index.html b/content/docs/system/index.html
deleted file mode 100644
index 88b8c60..0000000
--- a/content/docs/system/index.html
+++ /dev/null
@@ -1,361 +0,0 @@
-<!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 SensSoft system provides a simple, ready-to-go deployment. The deployment is containerized with Docker. It includes the UserALE backend, Distill, ...">
-
- <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://senssoft.incubator.apache.org/docs/system/">
- <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" 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 SensSoft</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="/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/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/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 SensSoft
- </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>
- System
- </div>
-
- <div class="active content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/system/">Getting Started</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/troubleshooting.html">Troubleshooting</a>
-
- <a class="item" href="/docs/useralejs/testing.html">Build and Test</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 SensSoft system provides a simple, ready-to-go deployment. The deployment is containerized with Docker. It includes the UserALE backend, Distill, and Tap. It requires <a href="https://docs.docker.com/compose/install/">Docker Compose</a> to be installed and working.</p>
-
-<h3 id="configure-tap">Configure Tap</h3>
-
-<p>Tap, as a Django project, requires a secret.py file to run. Before you begin, create and add the file to /docker/tap/</p>
-
-<div class="language-python highlighter-rouge"><pre class="highlight"><code> <span class="s">"""
- Secret Django settings for tap project.
- """</span>
-
- <span class="c"># SECURITY WARNING: keep the secret key used in production secret!</span>
- <span class="n">MY_SECRET_KEY</span> <span class="o">=</span> <span class="s">'<yoursecretkey>'</span>
- <span class="n">MY_DB_NAME</span> <span class="o">=</span> <span class="s">'tapdb'</span>
- <span class="n">MY_DB_USER</span> <span class="o">=</span> <span class="s">'tapuser'</span>
- <span class="n">MY_DB_PASSWORD</span> <span class="o">=</span> <span class="s">'<dbpassword>'</span>
- <span class="n">MY_DB_HOST</span> <span class="o">=</span> <span class="s">'db'</span>
-
- <span class="n">MY_EMAIL_PASSWORD</span> <span class="o">=</span><span class="s">''</span>
- <span class="n">ADMIN_EMAILS</span> <span class="o">=</span> <span class="p">()</span>
-</code></pre>
-</div>
-
-<h3 id="install-and-run-with-docker-compose">Install and Run with Docker Compose</h3>
-
-<p>To build and start the system:</p>
-
-<div class="language-shell highlighter-rouge"><pre class="highlight"><code> docker-compose build
- docker-compose up
-</code></pre>
-</div>
-
-<p>Tap will be running at localhost:8000.</p>
-
-<p>To shut down the system:</p>
-
-<div class="language-shell highlighter-rouge"><pre class="highlight"><code> docker-compose down
-</code></pre>
-</div>
-
- </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="/system">System</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/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/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=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>
- </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 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">
- 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>
-</div>
-
-
- </body>
-
-</html>
diff --git a/content/docs/tap/index.html b/content/docs/tap/index.html
deleted file mode 100644
index f1d3d6a..0000000
--- a/content/docs/tap/index.html
+++ /dev/null
@@ -1,335 +0,0 @@
-<!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="This project is not currently maintained and will be refactored. If you are interested in TAP, join the discussion on our dev list.">
-
- <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.apache.org/docs/tap/">
- <link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
-
-
-</head>
-
-
- <body>
-
- <div class="site-header">
- <div id="main-menu" class="ui inverted padded fixed top borderless menu">
- <a class="site-title" href="/">
- <h3 class="ui inverted header item">Apache Flagon</h3>
- </a>
-
- <div class="right menu">
- <div class="ui dropdown item">
- Products
- <div class="menu">
- <a class="item" href="/stack">Stack</a>
- <a class="item" href="/userale">UserALE</a>
- <a class="item" href="/distill">Distill</a>
- <a class="item" href="/tap">Tap</a>
- <a class="item" href="/stout">Stout</a>
- </div>
- </div>
- <div class="ui dropdown item">
- <a href="/docs">Docs</a>
- <div class="menu">
- <a class="item" href="/docs/stack">Stack</a>
- <a class="item" href="/docs/userale">UserALE</a>
- <a class="item" href="/docs/useralejs">UserALE.js</a>
- <a class="item" href="/docs/useralepy">UserALE.py</a>
- <a class="item" href="/docs/distill">Distill</a>
- <a class="item" href="/docs/tap">Tap</a>
- <a class="item" href="/docs/stout">Stout</a>
- </div>
- </div>
- <a class="item" href="/releases">Releases</a>
- <a class="item" href="/community">Community</a>
- </div>
- </div>
-</div>
-
-
- <div class="main-wrapper">
- <div class="docs-wrapper">
- <div class="docs-sidebar">
-
-
-
-
-
-
-
-
-
-<!-- <div class="ui inverted list">
- <a class="item" href="/docs">About the Docs</a>
-</div> -->
-<div id="docs-nav" class="ui inverted accordion">
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Apache Flagon
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/">About the Docs</a>
-
- <a class="item" href="/docs/contributing/">Contributing</a>
-
- </div>
- </div>
-
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Stack
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/stack/">Getting Started</a>
-
- <a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- UserALE
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/userale/">About UserALE</a>
-
- </div>
- </div>
-
-
- <div class="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/">UserALE.js Build and Test</a>
-
- <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
-
- <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
-
- <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
-
- <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- UserALE.py
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/useralepy/">Installation</a>
-
- <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
-
- <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
-
- <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Distill
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/distill/">Installation</a>
-
- <a class="item" href="/docs/distill/start.html">Getting Started</a>
-
- <a class="item" href="/docs/distill/api.html">API Documentation</a>
-
- <a class="item" href="/docs/distill/analytics.html">Apache Distill Analytics</a>
-
- <a class="item" href="/docs/distill/http.html">Apache Distill HTTP Client</a>
-
- <a class="item" href="/docs/distill/models.html">Apache Distill Models</a>
-
- <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a>
-
- <a class="item" href="/docs/distill/changelog.html">Changelog</a>
-
- </div>
- </div>
-
-
- <div class="active title">
-
- <i class="dropdown icon"></i>
- Tap
- </div>
-
- <div class="active 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>
- <h4 id="this-project-is-not-currently-maintained-and-will-be-refactored-if-you-are-interested-in-tap-join-the-discussion-on-our-dev-list">This project is not currently maintained and will be refactored. If you are interested in TAP, join the discussion on our <a href="mailto:dev-subscribe@flagon.incubator.apache.org">dev list</a>.</h4>
-
-<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/stack">try out the full Flagon system</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 © 2023 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/userale/index.html b/content/docs/userale/index.html
deleted file mode 100644
index 9526a3d..0000000
--- a/content/docs/userale/index.html
+++ /dev/null
@@ -1,343 +0,0 @@
-<!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>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 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>
- <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.apache.org/docs/userale/">
- <link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
-
-
-</head>
-
-
- <body>
-
- <div class="site-header">
- <div id="main-menu" class="ui inverted padded fixed top borderless menu">
- <a class="site-title" href="/">
- <h3 class="ui inverted header item">Apache Flagon</h3>
- </a>
-
- <div class="right menu">
- <div class="ui dropdown item">
- Products
- <div class="menu">
- <a class="item" href="/stack">Stack</a>
- <a class="item" href="/userale">UserALE</a>
- <a class="item" href="/distill">Distill</a>
- <a class="item" href="/tap">Tap</a>
- <a class="item" href="/stout">Stout</a>
- </div>
- </div>
- <div class="ui dropdown item">
- <a href="/docs">Docs</a>
- <div class="menu">
- <a class="item" href="/docs/stack">Stack</a>
- <a class="item" href="/docs/userale">UserALE</a>
- <a class="item" href="/docs/useralejs">UserALE.js</a>
- <a class="item" href="/docs/useralepy">UserALE.py</a>
- <a class="item" href="/docs/distill">Distill</a>
- <a class="item" href="/docs/tap">Tap</a>
- <a class="item" href="/docs/stout">Stout</a>
- </div>
- </div>
- <a class="item" href="/releases">Releases</a>
- <a class="item" href="/community">Community</a>
- </div>
- </div>
-</div>
-
-
- <div class="main-wrapper">
- <div class="docs-wrapper">
- <div class="docs-sidebar">
-
-
-
-
-
-
-
-
-
-<!-- <div class="ui inverted list">
- <a class="item" href="/docs">About the Docs</a>
-</div> -->
-<div id="docs-nav" class="ui inverted accordion">
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Apache Flagon
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/">About the Docs</a>
-
- <a class="item" href="/docs/contributing/">Contributing</a>
-
- </div>
- </div>
-
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Stack
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/stack/">Getting Started</a>
-
- <a class="item" href="/docs/stack/scaling/">Scaling Considerations</a>
-
- </div>
- </div>
-
-
- <div class="active title">
-
- <i class="dropdown icon"></i>
- UserALE
- </div>
-
- <div class="active 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/">UserALE.js Build and Test</a>
-
- <a class="item" href="/docs/useralejs/API/">The UserALE.js API</a>
-
- <a class="item" href="/docs/useralejs/modifying/">Modifying UserALE.js Source Code</a>
-
- <a class="item" href="/docs/useralejs/dataschema/">UserALE.js' Data Schema</a>
-
- <a class="item" href="/docs/useralejs/troubleshooting/">Troubleshooting</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- UserALE.py
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/useralepy/">Installation</a>
-
- <a class="item" href="/docs/useralepy/start.html">Getting Started</a>
-
- <a class="item" href="/docs/useralepy/api.html">API Documentation</a>
-
- <a class="item" href="/docs/useralepy/changelog.html">Changelog</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Distill
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/distill/">Installation</a>
-
- <a class="item" href="/docs/distill/start.html">Getting Started</a>
-
- <a class="item" href="/docs/distill/api.html">API Documentation</a>
-
- <a class="item" href="/docs/distill/analytics.html">Apache Distill Analytics</a>
-
- <a class="item" href="/docs/distill/http.html">Apache Distill HTTP Client</a>
-
- <a class="item" href="/docs/distill/models.html">Apache Distill Models</a>
-
- <a class="item" href="/docs/distill/utilities.html">Apache Distill Utilities</a>
-
- <a class="item" href="/docs/distill/changelog.html">Changelog</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Tap
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/tap/">Getting Started</a>
-
- </div>
- </div>
-
-
- <div class="title">
-
- <i class="dropdown icon"></i>
- Stout
- </div>
-
- <div class="content">
-
- <div class="ui inverted bulleted list docs-list">
-
- <a class="item" href="/docs/stout/">About Stout</a>
-
- <a class="item" href="/docs/stout/start.html">Getting Started</a>
-
- </div>
- </div>
-</div>
-
- </div>
- <div class="docs-content">
- <h2 class="ui header">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/stack">try out the full Flagon stack</a>.</p>
-
-<h3 id="about-userale">About UserALE</h3>
-
-<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>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>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>UserALE is for Software Developers, HCI/UX researchers, and project managers who develop user facing software tools.</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 © 2023 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/API.html b/content/docs/useralejs/API.html
deleted file mode 100644
index 0de35a7..0000000
--- a/content/docs/useralejs/API.html
+++ /dev/null
@@ -1,468 +0,0 @@
-<!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/API/index.html b/content/docs/useralejs/API/index.html
index 225a274..56333e4 100644
--- a/content/docs/useralejs/API/index.html
+++ b/content/docs/useralejs/API/index.html
@@ -16,7 +16,7 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://flagon.apache.org/docs/useralejs/API/">
+ <link rel="canonical" href="https://flagon.apache.org/docs/useralejs/API/">
<link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
@@ -35,23 +35,15 @@
<div class="ui dropdown item">
Products
<div class="menu">
- <a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
<a class="item" href="/distill">Distill</a>
- <a class="item" href="/tap">Tap</a>
- <a class="item" href="/stout">Stout</a>
</div>
</div>
<div class="ui dropdown item">
<a href="/docs">Docs</a>
<div class="menu">
- <a class="item" href="/docs/stack">Stack</a>
- <a class="item" href="/docs/userale">UserALE</a>
<a class="item" href="/docs/useralejs">UserALE.js</a>
- <a class="item" href="/docs/useralepy">UserALE.py</a>
<a class="item" href="/docs/distill">Distill</a>
- <a class="item" href="/docs/tap">Tap</a>
- <a class="item" href="/docs/stout">Stout</a>
</div>
</div>
<a class="item" href="/releases">Releases</a>
@@ -68,11 +60,6 @@
-
-
-
-
-
<!-- <div class="ui inverted list">
<a class="item" href="/docs">About the Docs</a>
</div> -->
@@ -95,41 +82,6 @@
</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">
@@ -157,28 +109,6 @@
</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>
@@ -191,56 +121,9 @@
<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>
@@ -249,16 +132,13 @@
<p><a href="https://github.com/apache/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/flagon-useralejs/tree/master/build">builds</a> page-by-page to suite your needs.</p>
-<p>The API exposes a number of functions, including: <code class="highlighter-rouge">options</code>, <code class="highlighter-rouge">setLogFilter</code>, & <code class="highlighter-rouge">setLogMapper</code>. With these two powerful functions, you have a lot of
-latitude in customizing and curating your logs.</p>
-
<h1 id="api-usage">API Usage</h1>
<p>To invoke the API, simply add additional javascript code blocks under your UserALE.js script tag.</p>
<p>Don’t forget to add UserALE.js to your project!</p>
-<p>It can be deployed as either script-tag, NPM module, or via CDN! For in-depth example, see our <a href="/docs/useralejs">Getting Started Guide</a>) or source <a href="https://github.com/apache/flagon-useralejs#usage">README.md</a>.</p>
+<p>It can be deployed as either script-tag, NPM module, or via CDN! For in-depth example, see our <a href="/docs/useralejs">Getting Started Guide</a> or source <a href="https://github.com/apache/flagon-useralejs#usage">README.md</a>.</p>
<p>Also, check out our<a href="https://github.com/apache/flagon-useralejs/tree/master/example">example test utility</a> so that you can experiment with logs in your terminal!</p>
@@ -269,143 +149,72 @@ latitude in customizing and curating your logs.</p>
<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-2.3.0.min.js"</span> <span class="na">data-url=</span><span class="s">"http://yourLoggingUrl"</span><span class="nt">></script></span>
+ <span class="nt"><script </span><span class="na">src=</span><span class="s">"/path/to/userale-2.4.0.min.js"</span> <span class="na">data-url=</span><span class="s">"http://yourLoggingUrl"</span><span class="nt">></script></span>
</code></pre></div></div>
-<h2 id="options-examples"><code class="highlighter-rouge">options</code> Examples</h2>
+<h2 id="options"><code class="language-plaintext highlighter-rouge">options()</code></h2>
-<p><code class="highlighter-rouge">options</code> allows you to modify UserALE.js script tag parameters. This can be particularly useful if need to pass additional data about users from your page into the logging parameters, like username and sessionID. You can build variables constructors that pass data from form data or browser storage to UserALE’s paramters.</p>
+<p><code class="language-plaintext highlighter-rouge">options</code> allows you to modify UserALE.js script tag parameters. This can be particularly useful if need to pass additional data about users from your page into the logging parameters, like username and sessionID. You can build variables constructors that pass data from form data or browser storage to UserALE’s paramters.</p>
-<div class="language-html highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="c"><!--
-Try out the options API to pass dynamic page data into your UserALE.js params page by page.
---></span>
-<span class="nt"><script </span><span class="na">type=</span><span class="s">"text/javascript"</span><span class="nt">></span>
- <span class="kd">const</span> <span class="nx">changeMe</span> <span class="o">=</span> <span class="s2">"me"</span><span class="p">;</span>
+<div class="language-html highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nt"><script </span><span class="na">type=</span><span class="s">"text/javascript"</span><span class="nt">></span>
+ <span class="kd">const</span> <span class="nx">changeMe</span> <span class="o">=</span> <span class="dl">"</span><span class="s2">me</span><span class="dl">"</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">options</span><span class="p">({</span>
- <span class="s2">"userId"</span><span class="p">:</span> <span class="nx">changeMe</span><span class="p">,</span>
- <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"2.3.0"</span><span class="p">,</span>
- <span class="s2">"sessionID"</span><span class="p">:</span> <span class="s2">"4"</span>
+ <span class="dl">"</span><span class="s2">userId</span><span class="dl">"</span><span class="p">:</span> <span class="nx">changeMe</span><span class="p">,</span>
+ <span class="dl">"</span><span class="s2">version</span><span class="dl">"</span><span class="p">:</span> <span class="dl">"</span><span class="s2">2.4.0</span><span class="dl">"</span><span class="p">,</span>
+ <span class="dl">"</span><span class="s2">sessionID</span><span class="dl">"</span><span class="p">:</span> <span class="dl">"</span><span class="s2">4</span><span class="dl">"</span>
<span class="p">})</span>
<span class="nt"></script></span>
</code></pre></div></div>
-<h2 id="setlogfilter-examples"><code class="highlighter-rouge">setLogFilter</code> Examples</h2>
-
-<p><code class="highlighter-rouge">setLogFilter</code> allows you to eliminate log data you don’t need or want from your log stream:</p>
-
-<div class="language-html highlighter-rouge"><div class="highlight"><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></div>
-
-<p>Here is one UserALE.js filter to rule them all!</p>
-
-<div class="language-html highlighter-rouge"><div class="highlight"><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></div>
-
-<p>You can also use the <code class="highlighter-rouge">setLogFilter</code> function to do other cool stuff. Below is an example for how to further modify the
-rate at which UserALE.js collects data, but dropping every other log (odd-even) in the logging queue.</p>
-
-<div class="language-html highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nt"><script </span><span class="na">type=</span><span class="s">"text/javascript"</span><span class="nt">></span>
- <span class="kd">var</span> <span class="nx">logCounter</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>
- <span class="nb">window</span><span class="p">.</span><span class="nx">userale</span><span class="p">.</span><span class="nx">filter</span><span class="p">(</span><span class="kd">function</span> <span class="p">(</span><span class="nx">log</span><span class="p">)</span> <span class="p">{</span>
- <span class="k">return</span> <span class="p">(</span><span class="nx">logCounter</span><span class="o">++</span> <span class="o">%</span> <span class="mi">2</span><span class="p">);</span>
- <span class="p">});</span>
- <span class="nt"></script></span>
-</code></pre></div></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"><div class="highlight"><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></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"><div class="highlight"><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>
+<h2 id="addcallbacks"><code class="language-plaintext highlighter-rouge">addCallbacks()</code></h2>
+
+<p><code class="language-plaintext highlighter-rouge">addCallbacks</code> allows you to modify UserALE.js logs via callback functions. Callback functions are passed the log to be modifyed, and the corresponding event if one exists. The value returned from the calback is used as the new log, except when a falsey value is returned. In the case of a falsey value, the log is dropped. Callbacks are executed in the order they are submitted. Pass multiple callbacks with an object of functions. [...]
+
+<div class="language-html highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nt"><script </span><span class="na">type=</span><span class="s">"text/javascript"</span><span class="nt">></span>
+ <span class="nb">window</span><span class="p">.</span><span class="nx">userale</span><span class="p">.</span><span class="nx">addCallbacks</span><span class="p">({</span>
+ <span class="nx">filter</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">type_array</span> <span class="o">=</span> <span class="p">[</span>
+ <span class="dl">"</span><span class="s2">mouseup</span><span class="dl">"</span><span class="p">,</span>
+ <span class="dl">"</span><span class="s2">mouseover</span><span class="dl">"</span><span class="p">,</span>
+ <span class="dl">"</span><span class="s2">mousedown</span><span class="dl">"</span><span class="p">,</span>
+ <span class="dl">"</span><span class="s2">keydown</span><span class="dl">"</span><span class="p">,</span>
+ <span class="dl">"</span><span class="s2">dblclick</span><span class="dl">"</span><span class="p">,</span>
+ <span class="dl">"</span><span class="s2">blur</span><span class="dl">"</span><span class="p">,</span>
+ <span class="dl">"</span><span class="s2">focus</span><span class="dl">"</span><span class="p">,</span>
+ <span class="dl">"</span><span class="s2">input</span><span class="dl">"</span><span class="p">,</span>
+ <span class="dl">"</span><span class="s2">wheel</span><span class="dl">"</span><span class="p">,</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="dl">"</span><span class="s2">interval</span><span class="dl">"</span><span class="p">];</span>
+ <span class="k">if</span> <span class="p">(</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="nx">logType_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">logType [...]
+ <span class="k">return</span> <span class="kc">false</span><span class="p">;</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="nx">addCustomFields</span><span class="p">(</span><span class="nx">log</span><span class="p">,</span> <span class="nx">event</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="dl">"</span><span class="s2">button#test_button</span><span class="dl">"</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="dl">"</span><span class="s2">Click me!</span><span class="dl">"</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="p">});</span>
+<span class="nt"></script></span>
+</code></pre></div></div>
- <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>
+<h2 id="removecallbacks"><code class="language-plaintext highlighter-rouge">removeCallbacks()</code></h2>
- <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>
+<p><code class="language-plaintext highlighter-rouge">removeCallbacks</code> removes a list of callback function that was added by addCallbacks() by name. The following example will remove the filter from the addCallbacks() example</p>
+<div class="language-html highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nt"><script </span><span class="na">type=</span><span class="s">"text/javascript"</span><span class="nt">></span>
+ <span class="nb">window</span><span class="p">.</span><span class="nx">userale</span><span class="p">.</span><span class="nx">removeCallbacks</span><span class="p">([</span><span class="dl">"</span><span class="s2">filter</span><span class="dl">"</span><span class="p">]);</span>
+<span class="nt"></script></span>
</code></pre></div></div>
<p>Test these examples out in our UserALE.js <a href="https://github.com/apache/flagon-useralejs/blob/master/example/index.html">example page</a> test utility!</p>
<p>See more <a href="">UserALE.js API Examples</a></p>
-<h3 id="benefits-of-the-useralejs-api">Benefits of the UserALE.js API</h3>
-<ul>
- <li>No need to dig into our source code</li>
- <li>Version control is easy and no need to sweat merges–just download the latest <a href="/releases">release</a>,
- or update via <a href="https://www.npmjs.com/package/flagon-userale">npm</a>.</li>
- <li>Manage logs page-by-page, ideal for large or complex sites</li>
- <li>Use basic or best-practice JS styles and methods to build your own filters, no need to learn weird custom syntax.</li>
-</ul>
-
<h2 id="contributing">Contributing</h2>
<p>Contributions are welcome! Simply <a href="https://github.com/apache/flagon-useralejs/issues">submit an issue</a> for problems
@@ -423,23 +232,15 @@ incorporate it into UserALE.js. We also love Pull Requests!</p>
<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">
@@ -447,9 +248,6 @@ incorporate it into UserALE.js. We also love Pull Requests!</p>
<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">
@@ -460,17 +258,15 @@ incorporate it into UserALE.js. We also love Pull Requests!</p>
<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>
+ <a class="item" href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy</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 © 2023 The Apache Software Foundation, Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.<br>
+ Copyright © 2024 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>
@@ -478,9 +274,6 @@ incorporate it into UserALE.js. We also love Pull Requests!</p>
<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>
diff --git a/content/docs/useralejs/build.html b/content/docs/useralejs/build.html
deleted file mode 100644
index 71f528d..0000000
--- a/content/docs/useralejs/build.html
+++ /dev/null
@@ -1,441 +0,0 @@
-<!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/useralejs/build/index.html b/content/docs/useralejs/build/index.html
index 89b0239..a794179 100644
--- a/content/docs/useralejs/build/index.html
+++ b/content/docs/useralejs/build/index.html
@@ -7,7 +7,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>UserALE.js Build and Test</title>
- <meta name="description" content="To build Apache UserALE.js, you will need to clone our repo and install NPM and Node.js.">
+ <meta name="description" content="To build Apache UserALE.js, you will need to clone our repo and install NPM and Node.js and Go.">
<link rel="stylesheet" type="text/css" href="/semantic/dist/semantic.min.css">
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.1.1/jquery.min.js"></script>
@@ -16,7 +16,7 @@
<script src="/js/main.js"></script>
<link rel="stylesheet" href="/assets/main.css">
- <link rel="canonical" href="http://flagon.apache.org/docs/useralejs/build/">
+ <link rel="canonical" href="https://flagon.apache.org/docs/useralejs/build/">
<link rel="alternate" type="application/rss+xml" title="Apache Flagon" href="/feed.xml">
@@ -35,23 +35,15 @@
<div class="ui dropdown item">
Products
<div class="menu">
- <a class="item" href="/stack">Stack</a>
<a class="item" href="/userale">UserALE</a>
<a class="item" href="/distill">Distill</a>
- <a class="item" href="/tap">Tap</a>
- <a class="item" href="/stout">Stout</a>
</div>
</div>
<div class="ui dropdown item">
<a href="/docs">Docs</a>
<div class="menu">
- <a class="item" href="/docs/stack">Stack</a>
- <a class="item" href="/docs/userale">UserALE</a>
<a class="item" href="/docs/useralejs">UserALE.js</a>
- <a class="item" href="/docs/useralepy">UserALE.py</a>
<a class="item" href="/docs/distill">Distill</a>
- <a class="item" href="/docs/tap">Tap</a>
- <a class="item" href="/docs/stout">Stout</a>
</div>
</div>
<a class="item" href="/releases">Releases</a>
@@ -68,11 +60,6 @@
-
-
-
-
-
<!-- <div class="ui inverted list">
<a class="item" href="/docs">About the Docs</a>
</div> -->
@@ -95,41 +82,6 @@
</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">
@@ -157,28 +109,6 @@
</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>
@@ -191,65 +121,18 @@
<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>
- <p>To build <a href="https://github.com/apache/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>To build <a href="https://github.com/apache/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> and <a href="https://go.dev/doc/install">Go</a>.</p>
<p>UserALE.js utilizes NPM for package and dependency management. Execute the following to install dependencies.</p>
-<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>#install required packages
+<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>#install required packages
npm install
#review major dependencies
@@ -258,22 +141,21 @@ npm ls --depth=0
<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>
+<p>UserALE.js uses Rollup to manage build tasking. These tasks are executed through our build script; use the following to execute:</p>
-<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>#Build UserALE.js
+<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>#Build UserALE.js
npm run build
</code></pre></div></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>UserALE.js uses Jest and Playwright to execute tests, which are integrated into our build pipeline. See <code class="language-plaintext highlighter-rouge">package.json</code> for full script options.</p>
<p>To run tests:</p>
-<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>#Run UserALE.js unit tests
-npm run test
+<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>npm run test
</code></pre></div></div>
<p>… you’ll see something like:</p>
-<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>...
+<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>...
attachHandlers
✓ attaches all the event handlers without duplicates
✓ debounces bufferedEvents (505ms)
@@ -348,15 +230,14 @@ npm run test
45 passing (954ms)
1 pending
</code></pre></div></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>Followed by e2e tests via playwright that runs in a headed browser. Note that interacting with the headed browser may contaminate test results. Unfortanutely, the browser plugin requires playwright to run with a headed browser at this time. Any failing tests will also be logged in the terminal. If there are failing tests, please consider <a href="https://github.com/apache/flagon-useralejs/issues">opening an issue in Github</a>.</p>
<p>Further instructions can be found in our <a href="https://github.com/apache/flagon-useralejs/blob/master/README.md">README</a></p>
<h2 id="contributing">Contributing</h2>
-<p>Contributions are welcome! Simply <a href="https://github.com/apache/flagon-useralejs/issues">submit an issue</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. We also love Pull Requests!</p>
+<p>Contributions are welcome! See the <a href="https://github.com/apache/flagon-useralejs/blob/master/CONTRIBUTING.md">contribution guide</a> for more information.</p>
</div>
</div>
@@ -369,23 +250,15 @@ incorporate it into UserALE.js. We also love Pull Requests!</p>
<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">
@@ -393,9 +266,6 @@ incorporate it into UserALE.js. We also love Pull Requests!</p>
<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">
@@ -406,17 +276,15 @@ incorporate it into UserALE.js. We also love Pull Requests!</p>
<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>
+ <a class="item" href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy</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 © 2023 The Apache Software Foundation, Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.<br>
+ Copyright © 2024 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>
@@ -424,9 +292,6 @@ incorporate it into UserALE.js. We also love Pull Requests!</p>
<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>
diff --git a/content/docs/useralejs/contributing.html b/content/docs/useralejs/contributing.html
deleted file mode 100644
index b652880..0000000
--- a/content/docs/useralejs/contributing.html
+++ /dev/null
@@ -1,331 +0,0 @@
-<!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>Contributing</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://localhost:4000/docs/useralejs/contributing.html">
- <link rel="alternate" type="application/rss+xml" title="Apache SensSoft" 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 SensSoft</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="/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/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/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>
... 25800 lines suppressed ...