You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@senssoft.apache.org by rf...@apache.org on 2017/09/08 00:13:35 UTC
[1/7] incubator-senssoft-useralejs git commit: Converted format from
umd to iffe. Added additional dependencies. NOTICE file added.
Repository: incubator-senssoft-useralejs
Updated Branches:
refs/heads/SENSSOFT-192 961091d34 -> 546f248ad
Converted format from umd to iffe. Added additional dependencies. NOTICE file added.
Project: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/commit/8a2262f5
Tree: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/tree/8a2262f5
Diff: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/diff/8a2262f5
Branch: refs/heads/SENSSOFT-192
Commit: 8a2262f5e55d624acb49c70a69424f48a2d9daab
Parents: c8ad449
Author: msbeard <ms...@apache.org>
Authored: Mon Jul 24 15:31:09 2017 -0400
Committer: msbeard <ms...@apache.org>
Committed: Mon Jul 24 15:31:09 2017 -0400
----------------------------------------------------------------------
NOTICE | 5 +++++
gulpfile.js | 6 +++---
package.json | 6 +++++-
3 files changed, 13 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/blob/8a2262f5/NOTICE
----------------------------------------------------------------------
diff --git a/NOTICE b/NOTICE
new file mode 100644
index 0000000..2bd67d3
--- /dev/null
+++ b/NOTICE
@@ -0,0 +1,5 @@
+Apache SensSoft UserALE.js
+Copyright 2016 The Apache Software Foundation
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).
http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/blob/8a2262f5/gulpfile.js
----------------------------------------------------------------------
diff --git a/gulpfile.js b/gulpfile.js
index a01e9d4..0bfb454 100644
--- a/gulpfile.js
+++ b/gulpfile.js
@@ -23,7 +23,7 @@ var json = require('rollup-plugin-json');
var uglify = require('gulp-uglify');
var rename = require('gulp-rename');
var mocha = require('gulp-mocha');
-var babel = require('babel-register')
+var babel = require('babel-register');
var version = require('./package.json').version;
var userale = 'userale-' + version;
@@ -43,7 +43,7 @@ gulp.task('rollup', function() {
})
.then(function(bundle) {
return bundle.write({
- format : 'umd',
+ format : 'iife',
moduleName : 'userale',
dest : 'build/' + userale + '.js'
});
@@ -57,7 +57,7 @@ gulp.task('build', ['rollup'], function() {
.on('error', gutil.log)
.pipe(rename({ suffix : '.min' }))
.pipe(gulp.dest('build'))
- .pipe(rename('userale-test.min.js'))
+ .pipe(rename(userale + '.min.js'))
.pipe(gulp.dest('build'));
});
http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/blob/8a2262f5/package.json
----------------------------------------------------------------------
diff --git a/package.json b/package.json
index 7875ca1..3660189 100644
--- a/package.json
+++ b/package.json
@@ -15,7 +15,7 @@
"url": "git://git.apache.org/incubator-senssoft-useralejs.git"
},
"keywords": [
- "UserAle",
+ "UserALE",
"Logging"
],
"author": "Apache SensSoft",
@@ -29,6 +29,10 @@
"url": "https://issues.apache.org/jira/browse/senssoft"
},
"homepage": "http://senssoft.incubator.apache.org",
+ "engines": {
+ "node": "~8.2.1",
+ "npm": "~5.3.0"
+ },
"devDependencies": {
"babel-preset-es2015": "^6.13.2",
"babel-register": "^6.11.6",
[6/7] incubator-senssoft-useralejs git commit: Added references to
the extension, added additional detail about the project.
Posted by rf...@apache.org.
Added references to the extension, added additional detail about the project.
Project: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/commit/ae2f6729
Tree: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/tree/ae2f6729
Diff: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/diff/ae2f6729
Branch: refs/heads/SENSSOFT-192
Commit: ae2f67292f0ba1d14aa281beec7663f16b3240d3
Parents: 93e7561
Author: Rob Foley <rg...@users.noreply.github.com>
Authored: Thu Sep 7 20:12:29 2017 -0400
Committer: Rob Foley <rg...@users.noreply.github.com>
Committed: Thu Sep 7 20:12:29 2017 -0400
----------------------------------------------------------------------
README.md | 11 ++++++++---
1 file changed, 8 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/blob/ae2f6729/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 56f109b..a1761dd 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,8 @@
The official JavaScript client for UserAle.
+UserALE.js is a client side instrumentation library written in JavaScript. It is designed to be an easy-to-use, lightweight, and dependency-free way to quickly gather logs from your web applications.
+
Additional documentation can be found at http://senssoft.incubator.apache.org/userale/
## Build
@@ -17,13 +19,14 @@ npm run build
## Use and Configure
-To include UserALE.js in your project:
+To start logging with UserALE.js, you can either include our script in the web application to be logged, or use our WebExtension to gather logs across any page a user visits.
+
+To instrument a specific project, simply include this script tag on the page:
```
<script src="/path/to/userale-1.0.0.min.js"></script>
```
-
-HTML5 Data Parameters are used to configure UserALE.js. For example, to set the logging URL:
+UserALE.js is designed to be easily configured to fit your use case. We use HTML data parameters to pass configuration options to the library. For example, to set the logging URL:
```
<script src="/path/to/userale-1.0.0.min.js" data-url="http://yourLoggingUrl"></script>
@@ -44,6 +47,8 @@ The complete list of configurable options is:
| data-user-from-params | Query param in the page URL to fetch userId from | null |
| data-tool | Name of tool being logged | null |
+If you're interested in using our WebExtension to log user activity across all pages they visit, check out our browser specific instructions [here](https://github.com/apache/incubator-senssoft-useralejs/blob/SENSSOFT-192/src/UserALEWebExtension/README.md).
+
## Next Up
Our top priority is to improve the testing system and to complete test coverage. After that is complete:
[2/7] incubator-senssoft-useralejs git commit: SENSSOFT-203:
Addressed Lewis MC feedback.
Posted by rf...@apache.org.
SENSSOFT-203: Addressed Lewis MC feedback.
Project: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/commit/ba3f81d4
Tree: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/tree/ba3f81d4
Diff: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/diff/ba3f81d4
Branch: refs/heads/SENSSOFT-192
Commit: ba3f81d4d60379ceebb666a7123125a82ba9f234
Parents: 8a2262f
Author: msbeard <ms...@apache.org>
Authored: Mon Aug 21 13:56:13 2017 -0400
Committer: msbeard <ms...@apache.org>
Committed: Mon Aug 21 13:56:13 2017 -0400
----------------------------------------------------------------------
CHANGELOG.md | 32 +++++++++++++++++++++++++++++++-
DISCLAIMER | 7 +++++++
NOTICE | 2 +-
README.md | 28 +++++++++++++++++-----------
package.json | 2 +-
5 files changed, 57 insertions(+), 14 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/blob/ba3f81d4/CHANGELOG.md
----------------------------------------------------------------------
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 71a3a42..7b7042d 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -3,5 +3,35 @@ Changelog
0.1.0 (2017-06-09)
------------------
+* Initial release of UserALE.js 0.1.0.
+* Release Notes - SensSoft - Version UserALE.js 0.1.0
+ * Sub-task
+ * [SENSSOFT-91] - Userale.js Jenkins Build
-Initial release of UserALE.js 0.1.0.
+ * Bug
+ * [SENSSOFT-79] - clientTime is not properly formmated
+ * [SENSSOFT-80] - Update data-url to http://localhost:8000
+ * [SENSSOFT-168] - UserALE script not reading from script data tags
+ * [SENSSOFT-187] - Fix npm build warnings for UserALE.js 0.1
+ * [SENSSOFT-188] - npm run test:watch breaks
+ * [SENSSOFT-214] - Added UserALE tag, but no logs generated
+
+ * Improvement
+ * [SENSSOFT-189] - UserALE.js Missing Src Code Documentation
+ * [SENSSOFT-213] - Update UserALE.js deployment Instructions
+
+ * Task
+ * [SENSSOFT-27] - [RELEASE PROC] NPM Package for UserALE.js
+ * [SENSSOFT-94] - [RELEASE PROC] Add Contributing Guide
+ * [SENSSOFT-180] - [RELEASE PROC] NPM Account Credentials
+ * [SENSSOFT-181] - [RELEASE PROC] Generate Functional Test Plan
+ * [SENSSOFT-182] - [RELEASE PROC] Release Guide for UserALE.js
+ * [SENSSOFT-186] - [RELEASE PROC] Sign UserALE Release
+ * [SENSSOFT-191] - Add CHANGELOG to UserALE.js
+ * [SENSSOFT-203] - Address UserALE.js feedback from lewismc
+
+ * Test
+ * [SENSSOFT-183] - [RELEASE PROC] Verify UserALE.js Unit Tests
+
+ * Wish
+ * [SENSSOFT-185] - [RELEASE PROC] Confirm that Jenkins Build Metrics are Posted
http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/blob/ba3f81d4/DISCLAIMER
----------------------------------------------------------------------
diff --git a/DISCLAIMER b/DISCLAIMER
new file mode 100644
index 0000000..fffac59
--- /dev/null
+++ b/DISCLAIMER
@@ -0,0 +1,7 @@
+Apache SensSoft is an effort undergoing incubation at The Apache Software Foundation (ASF),
+sponsored by the Apache Incubator project. 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 project has yet to be
+fully endorsed by the ASF.
http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/blob/ba3f81d4/NOTICE
----------------------------------------------------------------------
diff --git a/NOTICE b/NOTICE
index 2bd67d3..c72e4d5 100644
--- a/NOTICE
+++ b/NOTICE
@@ -1,5 +1,5 @@
Apache SensSoft UserALE.js
-Copyright 2016 The Apache Software Foundation
+Copyright 2017 The Apache Software Foundation
This product includes software developed at
The Apache Software Foundation (http://www.apache.org/).
http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/blob/ba3f81d4/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index b34a476..56f109b 100644
--- a/README.md
+++ b/README.md
@@ -5,20 +5,28 @@
The official JavaScript client for UserAle.
-Additional documentation can be found at http://draperlaboratory.github.io/useralejs/
+Additional documentation can be found at http://senssoft.incubator.apache.org/userale/
+
+## Build
+
+To build UserALE.js:
+
+```
+npm run build
+```
## Use and Configure
-To include Userale.js in your project:
+To include UserALE.js in your project:
```
-<script src="http://draperlaboratory.github.io/useralejs/userale.min.js"></script>
+<script src="/path/to/userale-1.0.0.min.js"></script>
```
-HTML5 Data Parameters are used to configure Userale.js. For example, to set the logging URL:
+HTML5 Data Parameters are used to configure UserALE.js. For example, to set the logging URL:
```
-<script src="userale.js" data-url="http://yourLoggingUrl"></script>
+<script src="/path/to/userale-1.0.0.min.js" data-url="http://yourLoggingUrl"></script>
```
The complete list of configurable options is:
@@ -26,7 +34,7 @@ The complete list of configurable options is:
| Param | Description | Default |
|---|---|---|
| data-url | Logging URL | http://localhost:8000 |
-| data-autostart | Should Userale.js start on page load | true |
+| data-autostart | Should UserALE.js start on page load | true |
| data-interval | Delay between transmit checks | 5000 (ms) |
| data-threshold | Minimum number of logs to send | 5 |
| data-user | User identifier | null |
@@ -42,14 +50,12 @@ Our top priority is to improve the testing system and to complete test coverage.
- Use web workers to remove load from main thread if available
- Update the example server to present a simple test app/interface
-- Release Userale.js through channels like NPM, Bower, etc.
+- Release UserALE.js through channels like NPM, Bower, etc.
## Contributing
-Contributions are welcome! Simply submit an issue report 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.
+Contributions are welcome! Simply submit an issue report 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.
## License
-Copyright 2016 The Charles Stark Draper Laboratory, Inc.
-
-Userale.js is released under the Apache v2.0 License. See the LICENSE file for more information.
+Copyright © 2017 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Software as a Sensor is a trademark of the Charles Stark Draper Laboratory, Inc.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/blob/ba3f81d4/package.json
----------------------------------------------------------------------
diff --git a/package.json b/package.json
index 3660189..0a9d1f4 100644
--- a/package.json
+++ b/package.json
@@ -1,7 +1,7 @@
{
"name": "useralejs",
"version": "0.1.0",
- "description": "Javascript Client for UserAle",
+ "description": "UserALE.js is the UserALE client for DOM and JavaScript-based applications. It automatically attaches event handlers to log every user interaction on a web page, including rich JS single-page apps.",
"main": "build/userale.js",
"scripts": {
"pretest": "gulp lint",
[4/7] incubator-senssoft-useralejs git commit: SENSSOFT-235: DOAP
file.
Posted by rf...@apache.org.
SENSSOFT-235: DOAP file.
Project: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/commit/d68bb04b
Tree: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/tree/d68bb04b
Diff: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/diff/d68bb04b
Branch: refs/heads/SENSSOFT-192
Commit: d68bb04b200a329b25937295f77b2cf7e8fba2ab
Parents: 690d8a3
Author: msbeard <ms...@apache.org>
Authored: Mon Aug 21 14:27:15 2017 -0400
Committer: msbeard <ms...@apache.org>
Committed: Mon Aug 21 14:27:15 2017 -0400
----------------------------------------------------------------------
doap-userale.js.rdf | 57 ++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 57 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/blob/d68bb04b/doap-userale.js.rdf
----------------------------------------------------------------------
diff --git a/doap-userale.js.rdf b/doap-userale.js.rdf
new file mode 100644
index 0000000..11460c2
--- /dev/null
+++ b/doap-userale.js.rdf
@@ -0,0 +1,57 @@
+<?xml version="1.0"?>
+<?xml-stylesheet type="text/xsl"?>
+<rdf:RDF xml:lang="en"
+ xmlns="http://usefulinc.com/ns/doap#"
+ xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+ xmlns:asfext="http://projects.apache.org/ns/asfext#"
+ xmlns:foaf="http://xmlns.com/foaf/0.1/">
+ <!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ -->
+ <Project rdf:about="http://senssoft.incubator.apache.org">
+ <created>2016-11-10</created>
+ <license rdf:resource="http://usefulinc.com/doap/licenses/asl20" />
+ <name>Apache SensSoft - UserALE.js</name>
+ <homepage rdf:resource="http://senssoft.incubator.apache.org" />
+ <asfext:pmc rdf:resource="http://senssoft.incubator.apache.org" />
+ <shortdesc>UserALE.js is the UserALE client for DOM and JavaScript-based applications.</shortdesc>
+ <description>UserALE.js is the UserALE client for DOM and JavaScript-based applications. It automatically attaches event handlers to log every user interaction on a web page, including rich JS single-page apps.</description>
+ <bug-database rdf:resource="https://issues.apache.org/jira/browse/SENSSOFT" />
+ <mailing-list rdf:resource="https://cwiki.apache.org/confluence/x/whTiAw" />
+ <download-page rdf:resource="https://cwiki.apache.org/confluence/x/whTiAw" />
+ <programming-language>Javascript</programming-language>
+ <category rdf:resource="https://projects.apache.org/projects.html?category#Library" />
+ <release>
+ <Version>
+ <name>0.1.0 release</name>
+ <created>2017-08-25</created>
+ <revision>0.1.0</revision>
+ </Version>
+ </release>
+ <repository>
+ <SVNRepository>
+ <location rdf:resource="https://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs.git"/>
+ <browse rdf:resource="https://github.com/apache/incubator-senssoft-useralejs"/>
+ </SVNRepository>
+ </repository>
+ <maintainer>
+ <foaf:Person>
+ <foaf:name>SensSoft Development Team</foaf:name>
+ <foaf:mbox rdf:resource="mailto:dev@senssoft.incubator.apache.org"/>
+ </foaf:Person>
+ </maintainer>
+ </Project>
+</rdf:RDF>
\ No newline at end of file
[3/7] incubator-senssoft-useralejs git commit: SENSSOFT-203: More
feedback.
Posted by rf...@apache.org.
SENSSOFT-203: More feedback.
Project: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/commit/690d8a37
Tree: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/tree/690d8a37
Diff: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/diff/690d8a37
Branch: refs/heads/SENSSOFT-192
Commit: 690d8a3798c1784612512a7c715222ae9b12a53e
Parents: ba3f81d
Author: msbeard <ms...@apache.org>
Authored: Mon Aug 21 14:09:55 2017 -0400
Committer: msbeard <ms...@apache.org>
Committed: Mon Aug 21 14:09:55 2017 -0400
----------------------------------------------------------------------
.gitignore | 1 +
CHANGELOG.md | 6 +++---
package.json | 2 +-
3 files changed, 5 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/blob/690d8a37/.gitignore
----------------------------------------------------------------------
diff --git a/.gitignore b/.gitignore
index 0408af4..8ed5199 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,4 @@
+.idea
/node_modules/*
/build/*
/logs/*
http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/blob/690d8a37/CHANGELOG.md
----------------------------------------------------------------------
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 7b7042d..ce9baad 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,10 +1,10 @@
Changelog
=========
-0.1.0 (2017-06-09)
-------------------
+UserALE.js - 0.1.0 (2017-08-25)
+-------------------------------
* Initial release of UserALE.js 0.1.0.
-* Release Notes - SensSoft - Version UserALE.js 0.1.0
+* Release Report - goo.gl/6gjWj1
* Sub-task
* [SENSSOFT-91] - Userale.js Jenkins Build
http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/blob/690d8a37/package.json
----------------------------------------------------------------------
diff --git a/package.json b/package.json
index 0a9d1f4..8da4605 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "useralejs",
- "version": "0.1.0",
+ "version": "1.0.0",
"description": "UserALE.js is the UserALE client for DOM and JavaScript-based applications. It automatically attaches event handlers to log every user interaction on a web page, including rich JS single-page apps.",
"main": "build/userale.js",
"scripts": {
[7/7] incubator-senssoft-useralejs git commit: Cleaned up some
grammar, added a gotchas section.
Posted by rf...@apache.org.
Cleaned up some grammar, added a gotchas section.
Project: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/commit/546f248a
Tree: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/tree/546f248a
Diff: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/diff/546f248a
Branch: refs/heads/SENSSOFT-192
Commit: 546f248ad5afb80687161ded4bb82402b4de218b
Parents: ae2f672
Author: Rob Foley <rg...@users.noreply.github.com>
Authored: Thu Sep 7 20:13:24 2017 -0400
Committer: Rob Foley <rg...@users.noreply.github.com>
Committed: Thu Sep 7 20:13:24 2017 -0400
----------------------------------------------------------------------
src/UserALEWebExtension/README.md | 14 ++++++++++++--
1 file changed, 12 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/blob/546f248a/src/UserALEWebExtension/README.md
----------------------------------------------------------------------
diff --git a/src/UserALEWebExtension/README.md b/src/UserALEWebExtension/README.md
index a3a272c..272f5b7 100644
--- a/src/UserALEWebExtension/README.md
+++ b/src/UserALEWebExtension/README.md
@@ -1,9 +1,11 @@
# UserALE Web Extension
-There are many different ways to create extensions for Chrome/Firefox. This project follows the Web Extension way.
+The UserALE.js Web Extension is designed to enable user activity logging across any page they visit, regardless of domain. To achieve this, we repackaged our UserALE.js library into a WebExtension compliant format to allow portability between browsers.
## Folder/file structure
+Here is a rundown of the UserALE Extension hierarchy.
+
* ../
* The parent directory should be the src for the core of UserALE
* README.md
@@ -58,4 +60,12 @@ You can set options for the web extension in your browser by opening the extensi
This version of the web extension has been modified to automatically reflect the correct version of the UserALE core script during the build process. You should not need to change anything for it to "just work".
-However, if something appears wrong, you can look at the 'src/UserAleWebExtension/globals.js' and 'src/UserAleWebExtension/manifest.json' to see how the UserALE client script is being set. Also look at the build steps related to the web extension in 'gulpfile.js' to see how the two previously mentioned files are modified to reflect the current version of the UserALE client script.
\ No newline at end of file
+However, if something appears wrong, you can look at the 'src/UserAleWebExtension/globals.js' and 'src/UserAleWebExtension/manifest.json' to see how the UserALE client script is being set. Also look at the build steps related to the web extension in 'gulpfile.js' to see how the two previously mentioned files are modified to reflect the current version of the UserALE client script.
+
+## Gotchas
+
+There is a known issue when attemping to gather logs from a page running on HTTPS. This occurs due to Mixed Active Content rules in the browser, since the current implementation of the Extension injects the script as HTTP. We are aware of the problem and are actively working towards a fix.
+
+In the meantime, the only workaround is to disable the related security option in the browser:
+* [Chrome](https://superuser.com/questions/487748/how-to-allow-chrome-browser-to-load-insecure-content)
+* [Firefox](https://support.mozilla.org/en-US/kb/mixed-content-blocking-firefox)
\ No newline at end of file
[5/7] incubator-senssoft-useralejs git commit: Merge branch 'master'
into SENSSOFT-192
Posted by rf...@apache.org.
Merge branch 'master' into SENSSOFT-192
Project: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/commit/93e75618
Tree: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/tree/93e75618
Diff: http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/diff/93e75618
Branch: refs/heads/SENSSOFT-192
Commit: 93e75618e7bd4b01d71c15b57e3b112b61103d0f
Parents: 961091d d68bb04
Author: Rob Foley <rg...@users.noreply.github.com>
Authored: Thu Sep 7 19:41:12 2017 -0400
Committer: Rob Foley <rg...@users.noreply.github.com>
Committed: Thu Sep 7 19:41:12 2017 -0400
----------------------------------------------------------------------
.gitignore | 1 +
CHANGELOG.md | 36 +++++++++++++++++++++++++++---
DISCLAIMER | 7 ++++++
NOTICE | 2 +-
README.md | 28 ++++++++++++++----------
doap-userale.js.rdf | 57 ++++++++++++++++++++++++++++++++++++++++++++++++
gulpfile.js | 1 -
package.json | 4 ++--
8 files changed, 118 insertions(+), 18 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/blob/93e75618/gulpfile.js
----------------------------------------------------------------------
diff --cc gulpfile.js
index ebe5dab,0bfb454..9d2b730
--- a/gulpfile.js
+++ b/gulpfile.js
@@@ -24,15 -24,9 +24,14 @@@ var uglify = require('gulp-uglify')
var rename = require('gulp-rename');
var mocha = require('gulp-mocha');
var babel = require('babel-register');
-
+var jsonModify = require('gulp-json-modify');
+var filter = require('gulp-filter');
+var uglifyHarmony = require('uglify-js-harmony');
+var minifier = require('gulp-uglify/minifier');
+var replace = require('gulp-replace');
-
var version = require('./package.json').version;
var userale = 'userale-' + version;
+var userAleWebExtDirName = 'UserAleWebExtension';
// Clean build directory
gulp.task('clean', function() {
http://git-wip-us.apache.org/repos/asf/incubator-senssoft-useralejs/blob/93e75618/package.json
----------------------------------------------------------------------