This is an automated email from the ASF dual-hosted git repository. poorejc pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/incubator-flagon.git
commit d9cddf09e0924d09734ab2edc3c1759b8169cf53 Author: poorejc <[email protected]> AuthorDate: Thu Sep 5 11:37:02 2019 -0400 v2.0.2 updates to content --- content/docs/distill/index.html | 2 ++ content/docs/distill/start.html | 6 ++++-- content/docs/stack/index.html | 8 ++++---- content/docs/stack/scaling/index.html | 2 +- content/docs/stout/index.html | 6 ++++-- content/docs/stout/start.html | 6 ++++-- content/docs/tap/index.html | 6 ++++-- content/docs/useralejs/API/index.html | 24 +++++++++++++++++++++--- content/feed.xml | 2 +- content/releases/index.html | 34 +++++++++++++++++----------------- 10 files changed, 62 insertions(+), 34 deletions(-) diff --git a/content/docs/distill/index.html b/content/docs/distill/index.html index 7268156..0e0ce91 100644 --- a/content/docs/distill/index.html +++ b/content/docs/distill/index.html @@ -248,6 +248,8 @@ <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:[email protected]";>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"><pre class="highlight"><code> <span class="nv">$ </span>git clone https://gitbox.apache.org/repos/asf/incubator-flagon-distill.git diff --git a/content/docs/distill/start.html b/content/docs/distill/start.html index a546d67..31d39e1 100644 --- a/content/docs/distill/start.html +++ b/content/docs/distill/start.html @@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1"> <title>Getting Started</title> - <meta name="description" content="Usage"> + <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> @@ -246,7 +246,9 @@ </div> <div class="docs-content"> <h2 class="ui header">Getting Started</h2> - <h3 id="usage">Usage</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:[email protected]";>dev list</a>.</h4> + +<h3 id="usage">Usage</h3> <p>Using curl:</p> diff --git a/content/docs/stack/index.html b/content/docs/stack/index.html index c8c1f89..4ee0d6f 100644 --- a/content/docs/stack/index.html +++ b/content/docs/stack/index.html @@ -273,7 +273,7 @@ <p><strong>Option 1: Include Apache UserALE.js in your project:</strong></p> <div class="language-markdown highlighter-rouge"><pre class="highlight"><code> #include userale in your project via script tag - <span class="nt"><script </span><span class="na">src=</span><span class="s">"/path/to/userale-1.0.0.min.js"</span> <span class="na">data-url=</span><span class="s">"http://yourLoggingUrl";</span><span class="nt">></script></span> + <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> <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> @@ -289,8 +289,8 @@ <p>Then, <strong>start up a virtual machine</strong>.</p> <div class="language-shell highlighter-rouge"><pre class="highlight"><code><span class="c"># start virtual machine and requisite network </span> -<span class="gp">$ </span>docker-machine create --virtualbox-memory 3072 --virtualbox-cpu-count 2 senssoft -<span class="gp">$ </span>docker-machine ssh senssoft sudo sysctl -w vm.max_map_count<span class="o">=</span>262144 +<span class="gp">$ </span>docker-machine create --virtualbox-memory 3072 --virtualbox-cpu-count 2 flagon +<span class="gp">$ </span>docker-machine ssh flagon sudo sysctl -w vm.max_map_count<span class="o">=</span>262144 <span class="gp">$ </span>docker network create esnet </code></pre> </div> @@ -308,7 +308,7 @@ <p>Finally, <strong>navigate to localhost:5601 (Kibaba), set an index pattern, and load our visualizations and dashboards</strong> to see your logs. Find simple instructions in our <a href="https://github.com/apache/incubator-flagon/tree/master/docker";>README</a>.</p> -<p>Subscribe to our <a href="[email protected]">dev list</a> and join the conversation!</p> +<p>Subscribe to our <a href="mailto:[email protected]";>dev list</a> and join the conversation!</p> </div> </div> diff --git a/content/docs/stack/scaling/index.html b/content/docs/stack/scaling/index.html index 5b9f576..211bb67 100644 --- a/content/docs/stack/scaling/index.html +++ b/content/docs/stack/scaling/index.html @@ -621,7 +621,7 @@ Output is very simple and index sizes stack on top of one another <p>It’s a building block benchmarking tool to help you build and manage scale and cost.</p> -<p>Subscribe to our <a href="[email protected]">dev list</a> and join the conversation!</p> +<p>Subscribe to our <a href="mailto:[email protected]";>dev list</a> and join the conversation!</p> </div> diff --git a/content/docs/stout/index.html b/content/docs/stout/index.html index b12ebe4..c808bec 100644 --- a/content/docs/stout/index.html +++ b/content/docs/stout/index.html @@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1"> <title>About Stout</title> - <meta name="description" content="The Subject Tracker for Online User Testing (STOUT) is a content management system for formal human performance experimentation. STOUT presents tools and ope..."> + <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> @@ -246,7 +246,9 @@ </div> <div class="docs-content"> <h2 class="ui header">About Stout</h2> - <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> + <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:[email protected]";>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> diff --git a/content/docs/stout/start.html b/content/docs/stout/start.html index ad8b1b3..258778f 100644 --- a/content/docs/stout/start.html +++ b/content/docs/stout/start.html @@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1"> <title>Getting Started</title> - <meta name="description" content="Getting Going… 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…"> + <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> @@ -246,7 +246,9 @@ </div> <div class="docs-content"> <h2 class="ui header">Getting Started</h2> - <h3 id="getting-going">Getting Going…</h3> + <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:[email protected]";>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> diff --git a/content/docs/tap/index.html b/content/docs/tap/index.html index 37dfa06..919c3e3 100644 --- a/content/docs/tap/index.html +++ b/content/docs/tap/index.html @@ -7,7 +7,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1"> <title>Getting Started</title> - <meta name="description" content="Tap is an experimental sandbox for Apache Flagon, highlighting customer visual analytics to highlight insights derived from Apache UserAle.js. It consists of..."> + <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> @@ -246,7 +246,9 @@ </div> <div class="docs-content"> <h2 class="ui header">Getting Started</h2> - <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> + <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:[email protected]";>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> diff --git a/content/docs/useralejs/API/index.html b/content/docs/useralejs/API/index.html index 96f1f9a..581f0e6 100644 --- a/content/docs/useralejs/API/index.html +++ b/content/docs/useralejs/API/index.html @@ -249,21 +249,39 @@ <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 +<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 the UserALE.js script tag:</p> +<p>Don’t forget to add the UserALE.js script tag! For an in depth example, see our <a href="/docs/useralejs">Getting Started Guide</a>) and our <a href="https://github.com/apache/incubator-flagon-useralejs/tree/master/example";>example test utility</a>.</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> + <span class="nt"><script </span><span class="na">src=</span><span class="s">"/path/to/userale-2.0.0.min.js"</span> <span class="na">data-url=</span><span class="s">"http://yourLoggingUrl";</span><span class="nt">></script></span> +</code></pre> +</div> + +<h2 id="options-examples"><code class="highlighter-rouge">options</code> Examples</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> + +<div class="language-html highlighter-rouge"><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="kr">const</span> <span class="nx">changeMe</span> <span class="o">=</span> <span class="s2">"me"</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">"4.0.2"</span><span class="p">,</span> + <span class="s2">"sessionID"</span><span class="p">:</span> <span class="s2">"4"</span> + <span class="p">})</span> +<span class="nt"></script></span> </code></pre> </div> diff --git a/content/feed.xml b/content/feed.xml index cd23c51..be23a01 100644 --- a/content/feed.xml +++ b/content/feed.xml @@ -1 +1 @@ -<?xml version="1.0" encoding="utf-8"?><?xml-stylesheet type="text/xml" href="http://flagon.incubator.apache.org/feed.xslt.xml";?><feed xmlns="http://www.w3.org/2005/Atom";><generator uri="http://jekyllrb.com"; version="3.3.1">Jekyll</generator><link href="http://flagon.incubator.apache.org/feed.xml"; rel="self" type="application/atom+xml" /><link href="http://flagon.incubator.apache.org/"; rel="alternate" type="text/html" /><updated>2019-07-13T04:04:30+00:00</updated><id>http://flagon.incubat [...] +<?xml version="1.0" encoding="utf-8"?><?xml-stylesheet type="text/xml" href="http://flagon.incubator.apache.org/feed.xslt.xml";?><feed xmlns="http://www.w3.org/2005/Atom";><generator uri="http://jekyllrb.com"; version="3.3.1">Jekyll</generator><link href="http://flagon.incubator.apache.org/feed.xml"; rel="self" type="application/atom+xml" /><link href="http://flagon.incubator.apache.org/"; rel="alternate" type="text/html" /><updated>2019-09-05T15:21:13+00:00</updated><id>http://flagon.incubat [...] diff --git a/content/releases/index.html b/content/releases/index.html index 123e115..e3c8361 100644 --- a/content/releases/index.html +++ b/content/releases/index.html @@ -99,28 +99,28 @@ The link in the 'Download Artifact' column below should display a default mirror </thead> <tbody> <tr> - <td>Apache Flagon UserALE.js 2.0.0 (binary tar.gz)</td> - <td><a href="http://www.apache.org/dyn/closer.lua/incubator/flagon/apache-flagon-useralejs-incubating-2.0.0/apache-flagon-useralejs-incubating-2.0.0-bin.tar.gz";>apache-flagon-useralejs-incubating-2.0.0-bin.tar.gz</a></td> - <td><a href="https://dist.apache.org/repos/dist/release/incubator/flagon/apache-flagon-useralejs-incubating-2.0.0/apache-flagon-useralejs-incubating-2.0.0-bin.tar.gz.asc";>apache-flagon-useralejs-incubating-2.0.0-bin.tar.gz.asc</a> </td> - <td><a href="https://dist.apache.org/repos/dist/release/incubator/flagon/apache-flagon-useralejs-incubating-2.0.0/apache-flagon-useralejs-incubating-2.0.0-bin.tar.gz.sha512";>apache-flagon-useralejs-incubating-2.0.0-bin.tar.gz.sha512</a> </td> + <td>Apache Flagon UserALE.js 2.0.2 (binary tar.gz)</td> + <td><a href="http://www.apache.org/dyn/closer.lua/incubator/flagon/apache-flagon-useralejs-incubating-2.0.2/apache-flagon-useralejs-incubating-2.0.2-bin.tar.gz";>apache-flagon-useralejs-incubating-2.0.2-bin.tar.gz</a></td> + <td><a href="https://dist.apache.org/repos/dist/release/incubator/flagon/apache-flagon-useralejs-incubating-2.0.2/apache-flagon-useralejs-incubating-2.0.2-bin.tar.gz.asc";>apache-flagon-useralejs-incubating-2.0.2-bin.tar.gz.asc</a> </td> + <td><a href="https://dist.apache.org/repos/dist/release/incubator/flagon/apache-flagon-useralejs-incubating-2.0.2/apache-flagon-useralejs-incubating-2.0.2-bin.tar.gz.sha512";>apache-flagon-useralejs-incubating-2.0.2-bin.tar.gz.sha512</a> </td> </tr> <tr> - <td>Apache Flagon UserALE.js 2.0.0 (binary zip)</td> - <td><a href="http://www.apache.org/dyn/closer.lua/incubator/flagon/apache-flagon-useralejs-incubating-2.0.0/apache-flagon-useralejs-incubating-2.0.0-bin.zip";>apache-flagon-useralejs-incubating-2.0.0-bin.zip</a></td> - <td><a href="https://dist.apache.org/repos/dist/release/incubator/flagon/apache-flagon-useralejs-incubating-2.0.0/apache-flagon-useralejs-incubating-2.0.0-bin.zip.asc";>apache-flagon-useralejs-incubating-2.0.0-bin.zip.asc</a></td> - <td><a href="https://dist.apache.org/repos/dist/release/incubator/flagon/apache-flagon-useralejs-incubating-2.0.0/apache-flagon-useralejs-incubating-2.0.0-bin.zip.sha512";>apache-flagon-useralejs-incubating-2.0.0-bin.zip.sha512</a></td> + <td>Apache Flagon UserALE.js 2.0.2 (binary zip)</td> + <td><a href="http://www.apache.org/dyn/closer.lua/incubator/flagon/apache-flagon-useralejs-incubating-2.0.2/apache-flagon-useralejs-incubating-2.0.2-bin.zip";>apache-flagon-useralejs-incubating-2.0.2-bin.zip</a></td> + <td><a href="https://dist.apache.org/repos/dist/release/incubator/flagon/apache-flagon-useralejs-incubating-2.0.2/apache-flagon-useralejs-incubating-2.0.2-bin.zip.asc";>apache-flagon-useralejs-incubating-2.0.2-bin.zip.asc</a></td> + <td><a href="https://dist.apache.org/repos/dist/release/incubator/flagon/apache-flagon-useralejs-incubating-2.0.2/apache-flagon-useralejs-incubating-2.0.2-bin.zip.sha512";>apache-flagon-useralejs-incubating-2.0.2-bin.zip.sha512</a></td> </tr> <tr> - <td>Apache Flagon UserALE.js 2.0.0 (source tar.gz)</td> - <td><a href="http://www.apache.org/dyn/closer.lua/incubator/flagon/apache-flagon-useralejs-incubating-2.0.0/apache-flagon-useralejs-incubating-2.0.0-src.tar.gz";>apache-flagon-useralejs-incubating-2.0.0-src.tar.gz</a></td> - <td><a href="https://dist.apache.org/repos/dist/release/incubator/flagon/apache-flagon-useralejs-incubating-2.0.0/apache-flagon-useralejs-incubating-2.0.0-src.tar.gz.asc";>apache-flagon-useralejs-incubating-2.0.0-src.tar.gz.asc</a> </td> - <td><a href="https://dist.apache.org/repos/dist/release/incubator/flagon/apache-flagon-useralejs-incubating-2.0.0/apache-flagon-useralejs-incubating-2.0.0-src.tar.gz.sha512";>apache-flagon-useralejs-incubating-2.0.0-src.tar.gz.sha512</a> </td> + <td>Apache Flagon UserALE.js 2.0.2 (source tar.gz)</td> + <td><a href="http://www.apache.org/dyn/closer.lua/incubator/flagon/apache-flagon-useralejs-incubating-2.0.2/apache-flagon-useralejs-incubating-2.0.2-src.tar.gz";>apache-flagon-useralejs-incubating-2.0.2-src.tar.gz</a></td> + <td><a href="https://dist.apache.org/repos/dist/release/incubator/flagon/apache-flagon-useralejs-incubating-2.0.2/apache-flagon-useralejs-incubating-2.0.2-src.tar.gz.asc";>apache-flagon-useralejs-incubating-2.0.2-src.tar.gz.asc</a> </td> + <td><a href="https://dist.apache.org/repos/dist/release/incubator/flagon/apache-flagon-useralejs-incubating-2.0.2/apache-flagon-useralejs-incubating-2.0.2-src.tar.gz.sha512";>apache-flagon-useralejs-incubating-2.0.2-src.tar.gz.sha512</a> </td> </tr> <tr> - <td>Apache Flagon UserALE.js 2.0.0 (source zip)</td> - <td><a href="http://www.apache.org/dyn/closer.lua/incubator/flagon/apache-flagon-useralejs-incubating-2.0.0/apache-flagon-useralejs-incubating-2.0.0-src.zip";>apache-flagon-useralejs-incubating-2.0.0-src.zip</a></td> - <td><a href="https://dist.apache.org/repos/dist/release/incubator/flagon/apache-flagon-useralejs-incubating-2.0.0/apache-flagon-useralejs-incubating-2.0.0-src.zip.asc";>apache-flagon-useralejs-incubating-2.0.0-src.zip.asc</a></td> - <td><a href="https://dist.apache.org/repos/dist/release/incubator/flagon/apache-flagon-useralejs-incubating-2.0.0/apache-flagon-useralejs-incubating-2.0.0-src.zip.sha512";>apache-flagon-useralejs-incubating-2.0.0-src.zip.sha512</a></td> + <td>Apache Flagon UserALE.js 2.0.2 (source zip)</td> + <td><a href="http://www.apache.org/dyn/closer.lua/incubator/flagon/apache-flagon-useralejs-incubating-2.0.2/apache-flagon-useralejs-incubating-2.0.2-src.zip";>apache-flagon-useralejs-incubating-2.0.2-src.zip</a></td> + <td><a href="https://dist.apache.org/repos/dist/release/incubator/flagon/apache-flagon-useralejs-incubating-2.0.2/apache-flagon-useralejs-incubating-2.0.2-src.zip.asc";>apache-flagon-useralejs-incubating-2.0.2-src.zip.asc</a></td> + <td><a href="https://dist.apache.org/repos/dist/release/incubator/flagon/apache-flagon-useralejs-incubating-2.0.2/apache-flagon-useralejs-incubating-2.0.2-src.zip.sha512";>apache-flagon-useralejs-incubating-2.0.2-src.zip.sha512</a></td> </tr> </tbody> </table> @@ -152,7 +152,7 @@ The link in the 'Download Artifact' column below should display a default mirror </p> <p> - The files in the most recent release are signed by Lewis John McGibbney (CODE SIGNING KEY) [email protected] 48BAEBF6 + The files in the most recent release are signed by Joshua C. Poore (3FCADF6E): [email protected] </p> <h2>SHA512 Signatures</h2>
