Merge pull request #32 from ExpediaInceCommercePlatform/2.0

2.0 Release!

CHANGELOG.md

@@ -1,8 +1,36 @@
+# 2.0.0
+
+## Features
+
+ - UI Redesign!  New look and feel for the management side of Cyclotron
+
+ - JSON Widget: New Widget which displays pretty-printed JSON data
+
+ - Prometheus Data Source: New Data Source for connecting to Prometheus
+
+ - Search: Additional advanced search terms, e.g. createdby:<user>
+
+ - CacheEncryptedPassword: Add optional setting that stores the user's encrypted password in local memory after logging in, allowing Data Sources to authenticate using the credentials of the current user, rather than a hardcoded account (note: this is disabled by default)
+
+ - "Likes" replaced with "Stars"
+
+ - Numerous upgrades to the build pipeline, including Gulp 4.0, Karma 3.x, etc.
+
+## Bug Fixes
+
+ - Sessions: restore sessions correctly when deeplinking to the /help page
+
+ - Upgraded angular-ui-router to resolve issues where the entire site would reload on navigation changes
+
+## Breaking Changes
+
+ - Upgraded from Jade to Pug; renamed file extensions accordingly
+
 # 1.48.0
 
 ## Bug Fixes
 
-- Table Widget: fixed export to exclude internally-used columns
+ - Table Widget: fixed export to exclude internally-used columns
 
 # 1.47.0
 

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2013-2015 the original author or authors.
+Copyright (c) 2013-2018 the original author or authors.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -34,9 +34,9 @@ Dashboards are defined declaratively as a JSON document, which contains all the
 
 * Declarative definition of Dashboards, requiring no HTML or JavaScript (although it's optionally available)
 
-* Included Widgets: Annotation Chart, Chart, Header, HTML, iFrame, Image, Javascript, Number, QRCode, Stoplight, Table, Treemap, Youtube
+* Included Widgets: Annotation Chart, Chart, Header, HTML, iFrame, Image, Javascript, JSON, Number, QRCode, Stoplight, Table, Treemap, Youtube
 
-* Included Data Sources: CyclotronData, Elasticsearch, Graphite, InfluxDB, Javascript, JSON, Splunk
+* Included Data Sources: CyclotronData, Elasticsearch, Graphite, InfluxDB, Javascript, JSON, Prometheus, Splunk
 
 * Built-in data loading, filtering, and sorting
 

cyclotron-site/README.md

@@ -18,7 +18,7 @@ The installation instructions recommend installing Gulp globally using npm.  It
 
 The longer command is the only disadvantage of this approach.  There are also a few scripts that can be executed via npm:
 
-    npm --run-script build  # Builds website
+    npm run-script build  # Builds website
     npm start               # Starts developement server
     npm test                # Runs unit tests  
 

cyclotron-site/app/index.jade → cyclotron-site/app/index.pug

@@ -12,8 +12,8 @@ html(lang='en', ng-app='cyclotronApp', ng-strict-di='')
 
         link(rel='icon', type='image/png' href='/img/favicon16.png' sizes='16x16')
         link(rel='icon', type='image/png' href='/img/favicon32.png' sizes='32x32')
-        link(rel='stylesheet', href='/css/app.common.css')
         link(rel='stylesheet', href='/css/vendor.css')
+        link(rel='stylesheet', href='/css/app.common.css')
 
         <!--[if gte IE 9]><!-->   
         //- Application Scripts
@@ -27,7 +27,6 @@ html(lang='en', ng-app='cyclotronApp', ng-strict-di='')
         <!--[if gte IE 9]><!-->
         section#appcontents(ui-view)
         <!--<![endif]-->
-
 
         <!--[if lte IE 8]>
         script(src='/js/ie8.js')

cyclotron-site/app/partials/analytics.jade → cyclotron-site/app/partials/analytics.pug

@@ -34,22 +34,22 @@
                 ng-pluralize(count='statistics.revisions.avgRevisionCount', when='{"one": "Revision", "other": "Revisions"}')
                 |  per Dashboard
 
-        h2 Likes
-        dl(title='Total number of likes for all active Dashboards (currently)')
+        h2 Stars
+        dl(title='Total number of stars for all active Dashboards (currently)')
             dt {{ statistics.likes.count | numeraljs:'0,0' }} 
-            dd current Likes
-        dl(title='Total number of times Dashboards have been liked (or re-liked)')
+            dd current Stars
+        dl(title='Total number of times Dashboards have been starred (or re-starred)')
             dt {{ statistics.likeEvents.count | numeraljs:'0,0' }} 
-            dd all-time Likes (including repeats)
-        dl(title='Total number of Dashboard Likes within the past day')
+            dd all-time Stars (including repeats)
+        dl(title='Total number of Dashboard Stars within the past day')
             dt {{ statistics.likeEvents.occurredPastDayCount | numeraljs:'0,0' }} 
-            dd Likes in the past day
-        dl(title='Total number of Dashboard Likes within the last 30 days')
+            dd Stars in the past day
+        dl(title='Total number of Dashboard Stars within the last 30 days')
             dt {{ statistics.likeEvents.occurredPastThirtyDayCount | numeraljs:'0,0' }} 
-            dd Likes in the last 30 days
-        dl(title='Total number of times a Dashboard was unliked')
+            dd Stars in the last 30 days
+        dl(title='Total number of times a Dashboard was unstarred')
             dt {{ statistics.unlikeEvents.count | numeraljs:'0,0' }} 
-            dd Unlikes
+            dd Unstars
 
         h2 Visits
         dl(title='Total number of times any Dashboard was visited')
@@ -125,7 +125,7 @@
                     span.more(ng-click='toggleLimit("topDashboardsLimit")', ng-show='topDashboardsLimit == largeLimit')
                         i.fa.fa-minus-square-o
                         |  less
-                    h2 Most Visited Dashboards (All-Time)
+                    h2 Most Visited Dashboards
                     table.table(ts-wrapper)
                         thead
                             tr

cyclotron-site/app/partials/dashboard.jade → cyclotron-site/app/partials/dashboard.pug

@@ -10,8 +10,8 @@
         i.fa.fa-pause(ng-click='pause()', ng-show='!paused', title='Pause Dashboard page rotation')
         i.fa.fa-play(ng-click='play()', ng-show='paused', ng-class='{ disabled: !canMoveForward() }', title='Start Dashboard page rotation')
         a.fa.fa-download(ng-href='{{ exportUrl }}', target='_blank', title='Export the Dashboard')
-        i.fa.fa-thumbs-o-up(requires-auth, ng-if='!isLiked', ng-click='toggleLike()', title='Like this Dashboard')
-        i.fa.fa-thumbs-up(requires-auth, ng-if='isLiked', ng-click='toggleLike()', title='Unlike this Dashboard')    
+        i.fa.fa-star-o(requires-auth, ng-if='!isLiked', ng-click='toggleLike()', title='Star this Dashboard')
+        i.fa.fa-star(requires-auth, ng-if='isLiked', ng-click='toggleLike()', title='Unstar this Dashboard')    
         i.fa.fa-chevron-right(ng-click='moveForward()', ng-class='{ disabled: !canMoveForward() }', title='Go to the next page')
 
     .dashboard-pages

cyclotron-site/app/partials/dashboardSidebar.jade → cyclotron-site/app/partials/dashboardSidebar.pug

@@ -17,8 +17,8 @@
                     a(ng-href='{{ exportUrl }}', title='Export this Dashboard', target='_blank')
                         i.fa.fa-download
                 td(requires-auth)
-                    i.fa.fa-thumbs-o-up(ng-if='!isLiked', ng-click='toggleLike()', title='Like this Dashboard')
-                    i.fa.fa-thumbs-up(ng-if='isLiked', ng-click='toggleLike()', title='Unlike this Dashboard')    
+                    i.fa.fa-star-o(ng-if='!isLiked', ng-click='toggleLike()', title='Star this Dashboard')
+                    i.fa.fa-star(ng-if='isLiked', ng-click='toggleLike()', title='Unstar this Dashboard')    
 
     .sidebar-accordion
 

cyclotron-site/app/partials/editor/guiEditor.jade → cyclotron-site/app/partials/editor/guiEditor.pug

@@ -38,18 +38,18 @@
                 title='{{ editor.dashboardWrapper.visits }} total visits, {{ editor.dashboardWrapper.pageViews }} total page views')
                 i(class='fa {{ getVisitCategory().icon }}')
                 span  {{ getVisitCategory().text }} 
-                    ng-pluralize(count='getVisitCategory().text', when='{"one": "visit", "other": "visits"}')
+                    ng-pluralize(count='getVisitCategory().number', when='{"one": "visit", "other": "visits"}')
 
-            h2.text-muted.likes-control(requires-auth, 
+            h2.text-muted.stars-control(requires-auth, 
                 ng-hide='editor.isNew || !isLatestRevision() || !editor.likeCount', 
-                title='{{ editor.likeCount }} likes')
-                i.fa.fa-thumbs-up
+                title='{{ editor.likeCount }} stars')
+                i.fa.fa-star
                 span  {{ editor.likeCount }} 
-                    ng-pluralize(count='editor.likeCount', when='{1: "like", "other": "likes"}')
+                    ng-pluralize(count='editor.likeCount', when='{1: "star", "other": "stars"}')
 
             h4.small.text-muted(ng-if='editor.dashboard.description')
                 i.fa.fa-quote-left
-                |  {{ editor.dashboard.description }}
+                | {{ editor.dashboard.description }}
                 i.fa.fa-quote-right
 
             h4.small.text-danger(ng-if='editor.dashboardWrapper.deleted')

cyclotron-site/app/partials/header.jade → cyclotron-site/app/partials/header.pug

@@ -1,9 +1,9 @@
 .row.cyclotron-header
     h1(ui-sref='home' ui-sref-opts='{reload: true}')
-        img.logo(src='/img/favicon64.png', alt='Logo')
+        img.logo(src='/img/logo.svg', alt='Logo')
         | Cyclotron
     .links
-        a.home(ui-sref='home', title='Return to Home')
+        //-a.home(ui-sref='home', title='Return to Home')
             i.fa.fa-home
         a.new(ng-href='/edit/', target='_self', title='Create a new Dashboard')
             i.fa.fa-file-o

cyclotron-site/app/partials/help/about.jade → cyclotron-site/app/partials/help/about.pug

@@ -37,8 +37,8 @@ ul
 h4 Features
 ul
     li Declarative definition of Dashboards, requiring no HTML or JavaScript (although it's optionally available)
-    li Included Widgets: Annotation Chart, Chart, Header, HTML, iFrame, Image, Javascript, Number, QRCode, Stoplight, Treemap, Youtube
-    li Included Data Sources: CyclotronData, Elasticsearch, Graphite, InfluxDB, JavaScript, JSON, Splunk
+    li Included Widgets: Annotation Chart, Chart, Header, HTML, iFrame, Image, Javascript, JSON, Number, QRCode, Stoplight, Treemap, Youtube
+    li Included Data Sources: CyclotronData, Elasticsearch, Graphite, InfluxDB, JavaScript, JSON, Prometheus, Splunk
     li Built-in data loading, filtering, and sorting
     li LDAP/Active Directory Integration
     li Permissions for viewing and editing Dashboards

cyclotron-site/app/partials/help/analytics.jade → cyclotron-site/app/partials/help/analytics.pug

@@ -15,14 +15,16 @@ ul
 
 h4 Configuration
 
-p The Cyclotron website needs the following configuration property enabled in the configService.js:
+p The Cyclotron website needs the following configuration property enabled in 
+    span.code  configService.js:
 
 pre.code.
     analytics: {
       enable: true
     },
 
-p And the Cyclotron service needs the following configuration set in the config/config.js:
+p And the Cyclotron service needs the following configuration set in 
+    span.code  config/config.js:
 
 pre.code.
     /* Configuration for Analytics */

cyclotron-site/app/partials/help/collapseMenu.jade → cyclotron-site/app/partials/help/collapseMenu.pug

@@ -1,10 +1,12 @@
 ul.nav.nav-pills.nav-stacked
     li(ng-repeat='section in items | filter:filter', ng-class='{active: section.selected == true}') 
-        a(ng-click='selectSection(section)') {{ section.name }}
+        a(ng-click='selectSection(section)') 
+            i.fa.fa-angle-right.text-muted(ng-show="section.selected != true")
+            i.fa.fa-angle-down.text-muted(ng-show="section.selected == true")
+            |  {{ section.name }}
 
         ul.nav.nav-pills.nav-stacked.indent(ng-if='section.expanded == true || isFiltered')
             li(ng-repeat='child in section.children | filter:filter', ng-class='{active: child.selected == true}') 
                 a(ng-click='selectChild(child, section)')
-                    i.fa.fa-angle-right.text-muted
-                    |  {{ child.name }}
+                    | {{ child.name }}
 

cyclotron-site/app/partials/help/datasources/prometheus.pug

@@ -0,0 +1,28 @@
+h3 Prometheus Data Source
+
+p The Prometheus Data Source connects to any Prometheus server and uses the built-in API to extract raw values.
+    | It can output one or more targets, which can use the full list of 
+    a(href='http://graphite.readthedocs.org/en/latest/functions.html', target='_blank') Graphite functions
+    | .
+
+P Please note that it may be necessary to set the optional 
+    em proxy 
+    | property in the Data Source in order to access web sites or services in other domains.  
+    | This property lists other Cyclotron servers which may have the required connectivity. 
+    | By default, this Data Source uses the current Cyclotron environment to proxy the request.
+
+p Examples of the Graphite Data Source are available on the 
+    a(href='/example-datasource-graphite') example-datasource-graphite
+    |  dashboard
+
+property-table(properties='config.dashboard.properties.dataSources.options.graphite.properties')
+
+h4 Pre-Processor
+
+p The Graphite Data Source supports an optional pre-processor function that will be called before
+    | the Data Source executes.  For more details, see the main Data Sources page.
+
+h4 Post-Processor
+
+p The Graphite Data Source supports an optional post-processor function that will be called after
+    | data is loaded.  For more details, see the main Data Sources page.