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:36 UTC
[2/7] incubator-senssoft-useralejs git commit: SENSSOFT-203:
Addressed Lewis MC feedback.
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",