Update link wiki and add gulp favicon

gulp/index.js

@@ -16,10 +16,10 @@
 
 'use strict';
 
-var gulp  = require('gulp');
-var fs    = require('fs');
-var path  = require('path');
-var tasks = fs.readdirSync('./gulp/tasks');
+const gulp  = require('gulp');
+const fs    = require('fs');
+const path  = require('path');
+const tasks = fs.readdirSync('./gulp/tasks');
 
 tasks.forEach((task) => {
   require(path.join(__dirname, 'tasks', task));

gulp/paths.js

@@ -23,8 +23,9 @@ module.exports = {
     js: './src/js/**/*.js',
     styl: './src/styl/**/*.styl',
     img: './src/images/**/*',
+    favicon: './src/images/favicon.png',
     files: {
-      copy: ['./src/humans.txt', './src/favicon.ico'],
+      copy: ['./src/humans.txt'],
       jade: './src/templates/index.jade',
       styl: './src/styl/main.styl'
     }

gulp/tasks/assets.js

@@ -17,9 +17,9 @@
 'use strict';
 
 // Necessary Plugins
-var gulp    = require('gulp');
-var plumber = require('gulp-plumber');
-var paths   = require('../paths');
+const gulp    = require('gulp');
+const plumber = require('gulp-plumber');
+const paths   = require('../paths');
 
 // Call Font Awesome
 gulp.task('fontAwesome', () => {

gulp/tasks/browser-sync.js

@@ -17,13 +17,13 @@
 'use strict';
 
 // Necessary Plugins
-var gulp        = require('gulp');
-var browserSync = require('browser-sync');
-var paths       = require('../paths');
+const gulp        = require('gulp');
+const browserSync = require('browser-sync');
+const paths       = require('../paths');
 
 // Serve files from /www/
 module.exports = gulp.task('browser-sync', () => {
-  var files = [
+  const files = [
     paths.browserSync.html,
     paths.browserSync.js,
     paths.browserSync.css,

gulp/tasks/copy-files.js

@@ -17,9 +17,9 @@
 'use strict';
 
 // Necessary Plugins
-var gulp    = require('gulp');
-var plumber = require('gulp-plumber');
-var paths   = require('../paths');
+const gulp    = require('gulp');
+const plumber = require('gulp-plumber');
+const paths   = require('../paths');
 
 // Call Copy files
 module.exports = gulp.task('copy-files', () => {

gulp/tasks/default.js

@@ -17,8 +17,8 @@
 'use strict';
 
 // Necessary Plugins
-var gulp = require('gulp');
+const gulp = require('gulp');
 
 // Default task
 module.exports = gulp.task('default', ['js', 'jade', 'stylus', 'imagemin',
-  'copy-files', 'assets-install', 'watch', 'browser-sync']);
+  'copy-files', 'assets-install', 'favicon-install', 'watch', 'browser-sync']);

gulp/tasks/favicon.js

@@ -0,0 +1,123 @@
+/**
+ *   Copyright 2016 OSBI Ltd
+ *
+ *   Licensed 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.
+ */
+
+'use strict';
+
+// Necessary Plugins
+const gulp        = require('gulp');
+const plumber     = require('gulp-plumber');
+const realFavicon = require ('gulp-real-favicon');
+const fs          = require('fs');
+const paths       = require('../paths');
+
+// Source: http://realfavicongenerator.net/
+
+// File where the favicon markups are stored
+const FAVICON_DATA_FILE = `${paths.build.img}/faviconData.json`;
+
+// Generate the icons. This task takes a few seconds to complete.
+// You should run it at least once to create the icons. Then,
+// you should run it whenever RealFaviconGenerator updates its
+// package (see the check-for-favicon-update task below).
+gulp.task('generate-favicon', (done) => {
+  realFavicon.generateFavicon({
+    masterPicture: paths.source.favicon,
+    dest: paths.build.img,
+    iconsPath: '/images/',
+    design: {
+      ios: {
+        pictureAspect: 'backgroundAndMargin',
+        backgroundColor: '#cc0000',
+        margin: '14%',
+        assets: {
+          ios6AndPriorIcons: false,
+          ios7AndLaterIcons: false,
+          precomposedIcons: false,
+          declareOnlyDefaultIcon: true
+        }
+      },
+      desktopBrowser: {},
+      windows: {
+        pictureAspect: 'whiteSilhouette',
+        backgroundColor: '#ae1817',
+        onConflict: 'override',
+        assets: {
+          windows80Ie10Tile: false,
+          windows10Ie11EdgeTiles: {
+            small: false,
+            medium: true,
+            big: false,
+            rectangle: false
+          }
+        }
+      },
+      androidChrome: {
+        pictureAspect: 'noChange',
+        themeColor: '#ffffff',
+        manifest: {
+          name: 'Saiku Community',
+          display: 'standalone',
+          orientation: 'notSet',
+          onConflict: 'override',
+          declared: true
+        },
+        assets: {
+          legacyIcon: false,
+          lowResolutionIcons: false
+        }
+      },
+      safariPinnedTab: {
+        pictureAspect: 'silhouette',
+        themeColor: '#ae1817'
+      }
+    },
+    settings: {
+      scalingAlgorithm: 'Mitchell',
+      errorOnImageTooSmall: false
+    },
+    markupFile: FAVICON_DATA_FILE
+  }, () => {
+    done();
+  });
+});
+
+// Inject the favicon markups in your HTML pages. You should run
+// this task whenever you modify a page. You can keep this task
+// as is or refactor your existing HTML pipeline.
+gulp.task('inject-favicon-markups', ['generate-favicon'], () => {
+  return gulp.src([`${paths.build.html}*.html`])
+    .pipe(realFavicon.injectFaviconMarkups(
+      JSON.parse(fs.readFileSync(FAVICON_DATA_FILE)).favicon.html_code)
+    )
+    .pipe(gulp.dest(paths.build.html));
+});
+
+// Check for updates on RealFaviconGenerator (think: Apple has just
+// released a new Touch icon along with the latest version of iOS).
+// Run this task from time to time. Ideally, make it part of your
+// continuous integration system.
+gulp.task('check-for-favicon-update', (done) => {
+  var currentVersion = JSON.parse(fs.readFileSync(FAVICON_DATA_FILE)).version;
+  realFavicon.checkForUpdates(currentVersion, (err) => {
+    if (err) {
+      throw err;
+    }
+  });
+});
+
+// Call Favicon Install
+module.exports = gulp.task('favicon-install',
+  ['generate-favicon', 'inject-favicon-markups']);

gulp/tasks/imagemin.js

@@ -17,11 +17,11 @@
 'use strict';
 
 // Necessary Plugins
-var gulp     = require('gulp');
-var plumber  = require('gulp-plumber');
-var cache    = require('gulp-cache');
-var imagemin = require('gulp-imagemin');
-var paths    = require('../paths');
+const gulp     = require('gulp');
+const plumber  = require('gulp-plumber');
+const cache    = require('gulp-cache');
+const imagemin = require('gulp-imagemin');
+const paths    = require('../paths');
 
 // Call Imagemin
 module.exports = gulp.task('imagemin', () => {

gulp/tasks/jade.js

@@ -17,11 +17,11 @@
 'use strict';
 
 // Necessary Plugins
-var gulp    = require('gulp');
-var plumber = require('gulp-plumber');
-var jade    = require('gulp-jade');
-var data    = require('../../src/data/data');
-var paths   = require('../paths');
+const gulp    = require('gulp');
+const plumber = require('gulp-plumber');
+const jade    = require('gulp-jade');
+const data    = require('../../src/data/data');
+const paths   = require('../paths');
 
 // Call Jade to compile templates
 module.exports = gulp.task('jade', () => {

gulp/tasks/js.js

@@ -17,10 +17,10 @@
 'use strict';
 
 // Necessary Plugins
-var gulp    = require('gulp');
-var plumber = require('gulp-plumber');
-var uglify  = require('gulp-uglify');
-var paths   = require('../paths');
+const gulp    = require('gulp');
+const plumber = require('gulp-plumber');
+const uglify  = require('gulp-uglify');
+const paths   = require('../paths');
 
 // Call Uglify and concat JS
 module.exports = gulp.task('js', () => {

gulp/tasks/stylus.js

@@ -17,19 +17,19 @@
 'use strict';
 
 // Necessary Plugins
-var gulp         = require('gulp');
-var plumber      = require('gulp-plumber');
-var stylus       = require('gulp-stylus');
-var postcss      = require('gulp-postcss');
-var autoprefixer = require('autoprefixer');
-var mqpacker     = require('css-mqpacker');
-var csswring     = require('csswring');
-var csscomb      = require('gulp-csscomb');
-var paths        = require('../paths');
+const gulp         = require('gulp');
+const plumber      = require('gulp-plumber');
+const stylus       = require('gulp-stylus');
+const postcss      = require('gulp-postcss');
+const autoprefixer = require('autoprefixer');
+const mqpacker     = require('css-mqpacker');
+const csswring     = require('csswring');
+const csscomb      = require('gulp-csscomb');
+const paths        = require('../paths');
 
 // Call Stylus
 module.exports = gulp.task('stylus', () => {
-  var processors = [
+  const processors = [
     autoprefixer({ browsers: ['last 3 versions'] }),
     mqpacker,
     csswring

gulp/tasks/watch.js

@@ -17,12 +17,12 @@
 'use strict';
 
 // Necessary Plugins
-var gulp  = require('gulp');
-var paths = require('../paths');
+const gulp  = require('gulp');
+const paths = require('../paths');
 
 // Call Watch
 module.exports = gulp.task('watch', () => {
-  gulp.watch(paths.source.templates, ['jade']);
+  gulp.watch(paths.source.templates, ['jade', 'favicon-install']);
   gulp.watch(paths.source.js, ['js']);
   gulp.watch(paths.source.styl, ['stylus']);
   gulp.watch(paths.source.img, ['imagemin']);

package.json

@@ -51,7 +51,7 @@
   },
   "devDependencies": {
     "autoprefixer": "^7.1.2",
-    "browser-sync": "^2.18.12",
+    "browser-sync": "^2.18.13",
     "css-mqpacker": "^6.0.1",
     "csswring": "^6.0.0",
     "gulp": "^3.9.1",
@@ -61,6 +61,7 @@
     "gulp-jade": "^1.1.0",
     "gulp-plumber": "^1.1.0",
     "gulp-postcss": "^7.0.0",
+    "gulp-real-favicon": "^0.2.2",
     "gulp-stylus": "^2.6.0",
     "gulp-uglify": "^3.0.0"
   },

src/data/data.js

@@ -77,7 +77,7 @@ module.exports = {
       title: 'Wiki',
       subtitle: 'wiki.meteorite.bi',
       icon: 'file-text-o',
-      url: 'http://wiki.meteorite.bi/',
+      url: 'http://saiku-documentation.readthedocs.io/en/latest/',
       id: null
     },
     {

src/templates/inc/head.jade

@@ -24,13 +24,6 @@ head
   meta(property="og:description" content="Saiku Analytics - The world's greatest open source OLAP browser.")
   meta(property="og:site_name" content="Saiku Community")
 
-  //- Favicon
-  link(rel="icon" href="images/favicon-16.png" sizes="16x16" type="image/png")
-  link(rel="icon" href="images/favicon-32.png" sizes="32x32" type="image/png")
-  link(rel="icon" href="images/favicon-48.png" sizes="48x48" type="image/png")
-  link(rel="icon" href="images/favicon-62.png" sizes="62x62" type="image/png")
-  link(rel="icon" href="images/favicon-192.png" sizes="192x192" type="image/png")
-
   //- Google Fonts
   link(rel="stylesheet" href="http://fonts.googleapis.com/css?family=Lato:300,400,700")