Skip to content
Permalink
Browse files
Updated ApacheSenssoft site pages
  • Loading branch information
msb3399 committed May 25, 2017
1 parent df5e92b commit f4abbc9b0885f253d8b69c5a7d88239461ef489e
Show file tree
Hide file tree
Showing 21 changed files with 85 additions and 34 deletions.
@@ -0,0 +1,12 @@
CHANGELOG
---------

### 1.0.1 (2017-05-25)
- Updated contributing guide
- Fixed broken links
- Added Dockerfile to show how to build site
- Added README and CHANGELOG
- Updated UserALE.pyqt5 name to UserALE.py

### 1.0.0 (2017-01-12)
- Initial commit.
@@ -0,0 +1,26 @@
FROM starefossen/ruby-node
MAINTAINER Michelle Beard <msbeard@apache.org>

# Cache bundle
COPY Gemfile* /tmp/
WORKDIR /tmp
RUN bundle install

ENV app /app

# Install npm modules
COPY package.json /tmp/
WORKDIR /tmp
RUN npm install -g

# Add src code
RUN mkdir $app
WORKDIR $app
ADD . $app

# Jekyll buld
RUN jekyll build

WORKDIR $app/_site

EXPOSE 8000
@@ -0,0 +1,12 @@
How to Build Site
-----------------

1. Download and Install [``Docker``](http://docker.com)
2. Build site
```
docker build -t apache-site .
```
3. Deploy site on localhost:8000
```
docker run -p 8000:8000 -it apache-site python -m SimpleHTTPServer
```
@@ -1,6 +1,7 @@
---
title: Contributing
component: senssoft
permalink: /docs/contributing/
---

First, thank you for contributing to Apache SensSoft!
@@ -13,13 +14,13 @@ To report a bug or other issue, simply create an issue in JIRA, as described in

#### 1. Create an issue in JIRA

All changes to Apache Distill must have a corresponding issue in [JIRA](https://issues.apache.org/jira/browse/SENSSOFT) 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.
All changes to Apache SensSoft must have a corresponding issue in [JIRA](https://issues.apache.org/jira/browse/SENSSOFT) 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.

#### 2. Make and test your changes locally

The Apache SensSoft source code is maintained in [several git repositories](https://git-wip-us.apache.org/repos/asf?s=senssoft) hosted by Apache. These repositories are mirrored and more easily available [on GitHub](https://github.com/apache?q=senssoft). 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:
```shell
git commit -m "#SENSSOFT-123: #High-level message describing the changes."
git commit -m "#SENSSOFT-123: High-level message describing the changes."
```
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.

@@ -182,7 +182,7 @@ $ curl -XGET https://localhost:8090/status/xdata_v3
"status": "open"
}
```
w
> **Parameters:**
- app_id – Application name
@@ -5,4 +5,4 @@ permalink: /docs/
priority: 0
---

The Apache SensSoft docs are organized by product. Each product's documentation includes information like quick start guides, tutorials, full API descriptions, and contributing guides.
The Apache SensSoft docs are organized by product. Each product's documentation includes information like quick start guides, tutorials, full API descriptions, and contribution guides.
@@ -9,13 +9,13 @@ priority: 0

### About UserALE

The User Analytic Logging Engine (User ALE) is part of Apache SensSoft. User ALE is for Software Developers, HCI/UX researchers, and project managers who develop user facing software tools—applications that are used for manipulating, analyzing, or visualizing data or other systems.
The User Analytic Logging Engine (UserALE) is part of Apache SensSoft. 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.

User ALE provides an API for instrumenting software tools, turning them into a human usability sensors. With every user interaction User ALE will transmit specially structured messages (JSON) from software tools to an activity logging server (Elastic). These messages not only report user activities and their timing, but provide sufficient context to understand how those activities are related to the functional organization of the software tool. This allows for greater utility in understanding how users are interacting with software tool features, and seeds more rigorous modeling and analytic approaches to understand not just what users do in software tools, but how they perform tasks with them.
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 ([Elasticsearch™](http://elastic.co)). These messages not only report user activities and their timing, but provide sufficient context to understand how those activities are related to the functional organization of the software tool. This allows for greater utility in understanding how users are interacting with software tool features, and seeds more rigorous modeling and analytic approaches to understand not just what users do in software tools, but how they perform tasks with them.

User ALE provides data provides insight into software tool usage frequency, users' cognitive/behavioral strategy in using tools to complete tasks, their workflows, as well as their integrative use of software tool features.
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.


### Who is UserALE for?

The User Analytic Logging Engine (User ALE) is for Software Developers, HCI/UX researchers, and project managers who develop user facing software tools.
UserALE is for Software Developers, HCI/UX researchers, and project managers who develop user facing software tools.
@@ -11,18 +11,18 @@ Apache UserALE.js is the UserALE client for DOM and JavaScript-based application

### Include UserALE.js in your project

To include UserAle.js in your project with default configuration, simply include the script tag below:
To include UserALE.js in your project with default configuration, simply include the script tag below:

```html
<script src="<yourUseraleSource>"></script>
<script src="<userale-0.1.0.js>"></script>
```

### Configure UserALE.js

HTML5 Data Parameters are used to configure UserALE.js. For example, to set the logging URL:

```html
<script src="userale.js" data-url="http://yourLoggingUrl"></script>
<script src="userale-0.1.0.js" data-url="http://server:port"></script>
```

The complete list of configurable options is:
@@ -1,12 +1,12 @@
---
title: Contributing
title: Build and Test
component: useralejs
priority: 11
---

### Building UserALE.js

To modify and build your own version of UserAle.js, first clone the repo, install dependencies, and make any desired changes. Then build and minify into the build/ folder:
To modify and build your own version of ``UserALE.js``, first clone the repo, install all dependencies, and make any desired changes. Then build and minify into the build/ folder:

```shell
git clone https://github.com/apache/incubator-senssoft-useralejs.git
@@ -20,7 +20,7 @@ We maintain code quality through linting and our test suite. To run, or run and

```shell
npm test
npm run test:watch
npm run example:watch
```

See package.json for full script options.
See ``package.json`` for full script options.
@@ -5,6 +5,6 @@ component: useralejs

### Enable Cross-Origin Resource Sharing (CORS)

The logs generated by UserAle is sent to a logging url which is configured in the script tag. Your client may send out failure logs because of a CORS (cross-origin resource sharing) issue. You will need to configure your backend server to enable CORS.
The logs generated by UserALE is sent to a logging server which is configured in the script tag. Your client may send out failure logs because of a CORS (cross-origin resource sharing) issue. You will need to configure your backend server to enable CORS.

For more information and examples on how to enable CORS on your server, please visit [enable-cors.org](http://enable-cors.org/index.html).
@@ -1,6 +1,6 @@
---
title: API Documentation
component: useralepyqt
component: useralepy
priority: 11
---

@@ -1,6 +1,6 @@
---
title: Changelog
component: useralepyqt
component: useralepy
priority: 99
---

@@ -1,7 +1,7 @@
---
title: Installation
component: useralepyqt
permalink: /docs/useralepyqt/
component: useralepy
permalink: /docs/useralepy/
priority: 0
---

@@ -1,6 +1,6 @@
---
title: Getting Started
component: useralepyqt
component: useralepy
priority: 1
---

@@ -2,7 +2,7 @@
{% assign system = site.docs | where:"component", "system" | sort: "priority" %}
{% assign userale = site.docs | where:"component", "userale" | sort: "priority" %}
{% assign useralejs = site.docs | where:"component", "useralejs" | sort: "priority" %}
{% assign useralepyqt = site.docs | where:"component", "useralepyqt" | sort: "priority" %}
{% assign useralepy = site.docs | where:"component", "useralepy" | sort: "priority" %}
{% assign distill = site.docs | where:"component", "distill" | sort: "priority" %}
{% assign tap = site.docs | where:"component", "tap" | sort: "priority" %}
{% assign stout = site.docs | where:"component", "stout" | sort: "priority" %}
@@ -92,21 +92,21 @@
</div>
</div>

{% if page.component == 'useralepyqt' %}
{% if page.component == 'useralepy' %}
<div class="active title">
{% else %}
<div class="title">
{% endif %}
<i class="dropdown icon"></i>
UserALE.pyqt
UserALE.py
</div>
{% if page.component == 'useralepyqt' %}
{% if page.component == 'useralepy' %}
<div class="active content">
{% else %}
<div class="content">
{% endif %}
<div class="ui inverted bulleted list docs-list">
{% for doc in useralepyqt %}
{% for doc in useralepy %}
<a class="item" href="{{ doc.url }}">{{ doc.title }}</a>
{% endfor %}
</div>
@@ -17,7 +17,7 @@ <h4 class="ui inverted header">Docs</h4>
<a class="item" href="{{ '/docs/system' | prepend: site.baseurl }}">System</a>
<a class="item" href="{{ '/docs/userale' | prepend: site.baseurl }}">UserALE</a>
<a class="item" href="{{ '/docs/useralejs' | prepend: site.baseurl }}">UserAle.js</a>
<a class="item" href="{{ '/docs/useralepyqt' | prepend: site.baseurl }}">UserAle.pyqt</a>
<a class="item" href="{{ '/docs/useralepy' | prepend: site.baseurl }}">UserAle.py</a>
<a class="item" href="{{ '/docs/distill' | prepend: site.baseurl }}">Distill</a>
<a class="item" href="{{ '/docs/tap' | prepend: site.baseurl }}">Tap</a>
<a class="item" href="{{ '/docs/stout' | prepend: site.baseurl }}">Stout</a>
@@ -21,7 +21,7 @@ <h3 class="ui inverted header item">Apache SensSoft</h3>
<a class="item" href="{{ '/docs/system' | prepend: site.baseurl }}">System</a>
<a class="item" href="{{ '/docs/userale'| prepend: site.baseurl }}">UserALE</a>
<a class="item" href="{{ '/docs/useralejs'| prepend: site.baseurl }}">UserALE.js</a>
<a class="item" href="{{ '/docs/useralepyqt'| prepend: site.baseurl }}">UserALE.pyqt</a>
<a class="item" href="{{ '/docs/useralepy'| prepend: site.baseurl }}">UserALE.py</a>
<a class="item" href="{{ '/docs/distill'| prepend: site.baseurl }}">Distill</a>
<a class="item" href="{{ '/docs/tap'| prepend: site.baseurl }}">Tap</a>
<a class="item" href="{{ '/docs/stout'| prepend: site.baseurl }}">Stout</a>
@@ -6,7 +6,7 @@

<div class="ui vertical segment">
<p>
The Apache SensSoft team happily welcomes contributors and supporters of our work. Contributions, bug reports, and suggestions are welcome for the core products, website, documentation, and everything else! See our <a href="{{ '/docs/system/contributing' | prepend: site.baseurl }}">docs</a> for more information on submitting effective contributions and bug reports.
The Apache SensSoft team happily welcomes contributors and supporters of our work. Contributions, bug reports, and suggestions are welcome for the core products, website, documentation, and everything else! See our <a href="{{ '/docs/contributing' | prepend: site.baseurl }}">docs</a> for more information on submitting effective contributions and bug reports.
</p>
</div>

@@ -63,7 +63,7 @@ <h3 class="ui header">
<div class="content">Issues and Bugs</div>
</h3>
<p>
Visit our <a href="https://issues.apache.org/jira/browse/SENSSOFT">Jira Issue Tracker</a> for full information on current developments, bugs, etc.
Visit our <a href="https://issues.apache.org/jira/browse/SENSSOFT">JIRA Issue Tracker</a> for full information on current developments, bugs, etc.
</p>
<h3 class="ui header">
<i class="sticky note icon"></i>
@@ -22,7 +22,7 @@
icon: lock
color: red
title: Control access to your data (coming soon)
description: Control permissions for how your organization can access user data by setting permissions at the instutitional level down to access to data collected from specific applications.
description: Control permissions for how your organization can access user data by setting permissions at the institutional level down to access to data collected from specific applications.

contentCount: 1
---
@@ -97,7 +97,7 @@ <h2 class="ui header">Instrument Software. &nbsp; Understand Humans.</h2>
<div class="ui text container">
<h2 class="ui inverted header">About the Project</h2>
<p>
Apache SensSoft is a user activity logging and analytics system that enables developers to instrument and extract design and user insights from their applications. It was originally developed at Draper for DARPA's XDATA program as a means of evaluating and improving tools for big data analysis and exploration. Commercially available as Draper's Software as a Sensor™, Apache SensSoft aims to provide a more complete and customizable user analytics platform.
Apache SensSoft is a user activity logging and analytics system that enables developers to instrument and extract design and user insights from their applications. It was originally developed at <a href="draper.com">Draper</a> for DARPA's XDATA program as a means of evaluating and improving tools for big data analysis and exploration. Commercially available as Draper's Software as a Sensor™, Apache SensSoft aims to provide a more complete and customizable user analytics platform.
</p>
</div>
</div>
@@ -1,14 +1,14 @@
{
"name": "apache-senssoft-website",
"version": "1.0.0",
"version": "1.0.1",
"description": "Website for Apache SensSoft",
"main": "",
"scripts": {
"test": ""
},
"repository": {
"type": "git",
"url": ""
"url": "git://git.apache.org/incubator-senssoft.git"
},
"keywords": [
"Apache",

0 comments on commit f4abbc9

Please sign in to comment.