Skip to content
Permalink
Browse files
pulling v2.0.2 site updates to live site
  • Loading branch information
poorejc committed Sep 5, 2019
2 parents ae46af7 + d9cddf0 commit a6ccb7b3eca0e8a0e3f51b310d2284caf0a8c136
Showing 46 changed files with 1,237 additions and 146 deletions.
@@ -248,6 +248,8 @@ <h3 class="ui inverted header item">Apache Flagon</h3>
<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"><pre class="highlight"><code> <span class="nv">$ </span>git clone https://gitbox.apache.org/repos/asf/incubator-flagon-distill.git
@@ -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 @@ <h3 class="ui inverted header item">Apache Flagon</h3>
</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:dev-subscribe@flagon.incubator.apache.org">dev list</a>.</h4>

<h3 id="usage">Usage</h3>

<p>Using curl:</p>

@@ -273,7 +273,7 @@ <h3 id="building-and-deploying-useralejs">Building and Deploying UserALE.js</h3>
<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">&lt;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">&gt;&lt;/script&gt;</span>
<span class="nt">&lt;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">&gt;&lt;/script&gt;</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 @@ <h3 id="building-and-using-the-elastic-backend">Building and Using the Elastic B

<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 @@ <h3 id="building-and-using-the-elastic-backend">Building and Using the Elastic B

<p>Finally, <strong>navigate to localhost:5601 (Kibaba), set an index pattern, and load our visualizations and dashboards</strong> to see your logs. Find simple instructions in our <a href="https://github.com/apache/incubator-flagon/tree/master/docker">README</a>.</p>

<p>Subscribe to our <a href="dev-subscribe@flagon.incubator.apache.org">dev list</a> and join the conversation!</p>
<p>Subscribe to our <a href="mailto:dev-subscribe@flagon.incubator.apache.org">dev list</a> and join the conversation!</p>

</div>
</div>
@@ -621,7 +621,7 @@ <h3 id="summary">Summary</h3>

<p>It’s a building block benchmarking tool to help you build and manage scale and cost.</p>

<p>Subscribe to our <a href="dev-subscribe@flagon.incubator.apache.org">dev list</a> and join the conversation!</p>
<p>Subscribe to our <a href="mailto:dev-subscribe@flagon.incubator.apache.org">dev list</a> and join the conversation!</p>


</div>
@@ -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 @@ <h3 class="ui inverted header item">Apache Flagon</h3>
</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: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>
@@ -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 @@ <h3 class="ui inverted header item">Apache Flagon</h3>
</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: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>
@@ -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 @@ <h3 class="ui inverted header item">Apache Flagon</h3>
</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: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>

@@ -249,21 +249,39 @@ <h2 class="ui header">The UserALE.js API</h2>
<p><a href="https://github.com/apache/incubator-flagon-useralejs">Apache UserALE.js</a> features a robust API that allows you
customize official Apache Flagon UserALE.js <a href="https://github.com/apache/incubator-flagon-useralejs/tree/master/build">builds</a> page-by-page to suite your needs.</p>

<p>The API exposes two functions: <code class="highlighter-rouge">setLogFilter</code> &amp; <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>, &amp; <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">&lt;head&gt;</span>
<span class="nt">&lt;title&gt;</span>UserAleJS - Example Page<span class="nt">&lt;/title&gt;</span>
<span class="c">&lt;!--
Add the UserALE.js script tag to the top of your doc
--&gt;</span>
<span class="nt">&lt;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">&gt;&lt;/script&gt;</span>
<span class="nt">&lt;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">&gt;&lt;/script&gt;</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">&lt;!--
Try out the options API to pass dynamic page data into your UserALE.js params page by page.
--&gt;</span>
<span class="nt">&lt;script </span><span class="na">type=</span><span class="s">"text/javascript"</span><span class="nt">&gt;</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">&lt;/script&gt;</span>
</code></pre>
</div>

@@ -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.incubator.apache.org//</id><title type="html">Apache Flagon</title><subtitle>The homepage for Apache Flagon</subtitle></feed>
<?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.incubator.apache.org//</id><title type="html">Apache Flagon</title><subtitle>The homepage for Apache Flagon</subtitle></feed>

0 comments on commit a6ccb7b

Please sign in to comment.