diff --git a/LICENSE b/LICENSE index 8b209c53681..b243d2c68b5 100644 --- a/LICENSE +++ b/LICENSE @@ -242,7 +242,8 @@ The following components are provided under the MIT-style license. See project l The text of each license is also included at licenses/LICENSE-[project]-[version].txt. (MIT Style) jekyll-table-of-contents (https://github.com/ghiculescu/jekyll-table-of-contents) - https://github.com/ghiculescu/jekyll-table-of-contents/blob/master/LICENSE.txt - + (MIT Style) lunr.js (https://github.com/olivernn/lunr.js) - https://github.com/olivernn/lunr.js/blob/v0.7.1/LICENSE + ======================================================================== Apache licenses ======================================================================== diff --git a/docs/_includes/themes/zeppelin/_navigation.html b/docs/_includes/themes/zeppelin/_navigation.html index e809b09676d..a396d562c34 100644 --- a/docs/_includes/themes/zeppelin/_navigation.html +++ b/docs/_includes/themes/zeppelin/_navigation.html @@ -114,7 +114,14 @@ + - + diff --git a/docs/_includes/themes/zeppelin/default.html b/docs/_includes/themes/zeppelin/default.html index cd07602ec90..8d84124bb1e 100644 --- a/docs/_includes/themes/zeppelin/default.html +++ b/docs/_includes/themes/zeppelin/default.html @@ -2,7 +2,7 @@ - {{ page.title }} + Apache Zeppelin {{ site.ZEPPELIN_VERSION }} Documentation: {{ page.title }} {% if page.description %}{% endif %} @@ -34,6 +34,8 @@ + + diff --git a/docs/assets/themes/zeppelin/css/style.css b/docs/assets/themes/zeppelin/css/style.css index 1a6f3da976a..7fa1b8ab74f 100644 --- a/docs/assets/themes/zeppelin/css/style.css +++ b/docs/assets/themes/zeppelin/css/style.css @@ -569,6 +569,30 @@ a.anchorjs-link:hover { text-decoration: none; } margin-left: -18px; } +/* Search Page */ +#search p { + font-size: 30px; + font-weight: bold; + color: black; +} + +#search_results p { + font-size: 13px; + font-weight: 400; +} + +#search_results a { + vertical-align: super; + font-size: 16px; + text-decoration: underline; +} + +#search_results .link { + font-size: 13px; + color: #008000; + padding-bottom: 3px; +} + /* Custom, iPhone Retina */ @media only screen and (max-width: 480px) { .jumbotron h1 { diff --git a/docs/assets/themes/zeppelin/js/lunr.min.js b/docs/assets/themes/zeppelin/js/lunr.min.js new file mode 100644 index 00000000000..b0198dff91f --- /dev/null +++ b/docs/assets/themes/zeppelin/js/lunr.min.js @@ -0,0 +1,7 @@ +/** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 0.7.0 + * Copyright (C) 2016 Oliver Nightingale + * MIT Licensed + * @license + */ +!function(){var t=function(e){var n=new t.Index;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),e&&e.call(n,n),n};t.version="0.7.0",t.utils={},t.utils.warn=function(t){return function(e){t.console&&console.warn&&console.warn(e)}}(this),t.utils.asString=function(t){return void 0===t||null===t?"":t.toString()},t.EventEmitter=function(){this.events={}},t.EventEmitter.prototype.addListener=function(){var t=Array.prototype.slice.call(arguments),e=t.pop(),n=t;if("function"!=typeof e)throw new TypeError("last argument must be a function");n.forEach(function(t){this.hasHandler(t)||(this.events[t]=[]),this.events[t].push(e)},this)},t.EventEmitter.prototype.removeListener=function(t,e){if(this.hasHandler(t)){var n=this.events[t].indexOf(e);this.events[t].splice(n,1),this.events[t].length||delete this.events[t]}},t.EventEmitter.prototype.emit=function(t){if(this.hasHandler(t)){var e=Array.prototype.slice.call(arguments,1);this.events[t].forEach(function(t){t.apply(void 0,e)})}},t.EventEmitter.prototype.hasHandler=function(t){return t in this.events},t.tokenizer=function(e){return arguments.length&&null!=e&&void 0!=e?Array.isArray(e)?e.map(function(e){return t.utils.asString(e).toLowerCase()}):e.toString().trim().toLowerCase().split(t.tokenizer.seperator):[]},t.tokenizer.seperator=/[\s\-]+/,t.tokenizer.load=function(t){var e=this.registeredFunctions[t];if(!e)throw new Error("Cannot load un-registered function: "+t);return e},t.tokenizer.label="default",t.tokenizer.registeredFunctions={"default":t.tokenizer},t.tokenizer.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing tokenizer: "+n),e.label=n,this.registeredFunctions[n]=e},t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions={},t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(e){var i=t.Pipeline.registeredFunctions[e];if(!i)throw new Error("Cannot load un-registered function: "+e);n.add(i)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(e){t.Pipeline.warnIfFunctionNotRegistered(e),this._stack.push(e)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._stack.indexOf(e);if(-1==i)throw new Error("Cannot find existingFn");i+=1,this._stack.splice(i,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._stack.indexOf(e);if(-1==i)throw new Error("Cannot find existingFn");this._stack.splice(i,0,n)},t.Pipeline.prototype.remove=function(t){var e=this._stack.indexOf(t);-1!=e&&this._stack.splice(e,1)},t.Pipeline.prototype.run=function(t){for(var e=[],n=t.length,i=this._stack.length,r=0;n>r;r++){for(var o=t[r],s=0;i>s&&(o=this._stack[s](o,r,t),void 0!==o&&""!==o);s++);void 0!==o&&""!==o&&e.push(o)}return e},t.Pipeline.prototype.reset=function(){this._stack=[]},t.Pipeline.prototype.toJSON=function(){return this._stack.map(function(e){return t.Pipeline.warnIfFunctionNotRegistered(e),e.label})},t.Vector=function(){this._magnitude=null,this.list=void 0,this.length=0},t.Vector.Node=function(t,e,n){this.idx=t,this.val=e,this.next=n},t.Vector.prototype.insert=function(e,n){this._magnitude=void 0;var i=this.list;if(!i)return this.list=new t.Vector.Node(e,n,i),this.length++;if(en.idx?n=n.next:(i+=e.val*n.val,e=e.next,n=n.next);return i},t.Vector.prototype.similarity=function(t){return this.dot(t)/(this.magnitude()*t.magnitude())},t.SortedSet=function(){this.length=0,this.elements=[]},t.SortedSet.load=function(t){var e=new this;return e.elements=t,e.length=t.length,e},t.SortedSet.prototype.add=function(){var t,e;for(t=0;t1;){if(o===t)return r;t>o&&(e=r),o>t&&(n=r),i=n-e,r=e+Math.floor(i/2),o=this.elements[r]}return o===t?r:-1},t.SortedSet.prototype.locationFor=function(t){for(var e=0,n=this.elements.length,i=n-e,r=e+Math.floor(i/2),o=this.elements[r];i>1;)t>o&&(e=r),o>t&&(n=r),i=n-e,r=e+Math.floor(i/2),o=this.elements[r];return o>t?r:t>o?r+1:void 0},t.SortedSet.prototype.intersect=function(e){for(var n=new t.SortedSet,i=0,r=0,o=this.length,s=e.length,a=this.elements,h=e.elements;;){if(i>o-1||r>s-1)break;a[i]!==h[r]?a[i]h[r]&&r++:(n.add(a[i]),i++,r++)}return n},t.SortedSet.prototype.clone=function(){var e=new t.SortedSet;return e.elements=this.toArray(),e.length=e.elements.length,e},t.SortedSet.prototype.union=function(t){var e,n,i;this.length>=t.length?(e=this,n=t):(e=t,n=this),i=e.clone();for(var r=0,o=n.toArray();rp;p++)c[p]===a&&d++;h+=d/f*l.boost}}this.tokenStore.add(a,{ref:o,tf:h})}n&&this.eventEmitter.emit("add",e,this)},t.Index.prototype.remove=function(t,e){var n=t[this._ref],e=void 0===e?!0:e;if(this.documentStore.has(n)){var i=this.documentStore.get(n);this.documentStore.remove(n),i.forEach(function(t){this.tokenStore.remove(t,n)},this),e&&this.eventEmitter.emit("remove",t,this)}},t.Index.prototype.update=function(t,e){var e=void 0===e?!0:e;this.remove(t,!1),this.add(t,!1),e&&this.eventEmitter.emit("update",t,this)},t.Index.prototype.idf=function(t){var e="@"+t;if(Object.prototype.hasOwnProperty.call(this._idfCache,e))return this._idfCache[e];var n=this.tokenStore.count(t),i=1;return n>0&&(i=1+Math.log(this.documentStore.length/n)),this._idfCache[e]=i},t.Index.prototype.search=function(e){var n=this.pipeline.run(this.tokenizerFn(e)),i=new t.Vector,r=[],o=this._fields.reduce(function(t,e){return t+e.boost},0),s=n.some(function(t){return this.tokenStore.has(t)},this);if(!s)return[];n.forEach(function(e,n,s){var a=1/s.length*this._fields.length*o,h=this,u=this.tokenStore.expand(e).reduce(function(n,r){var o=h.corpusTokens.indexOf(r),s=h.idf(r),u=1,l=new t.SortedSet;if(r!==e){var c=Math.max(3,r.length-e.length);u=1/Math.log(c)}o>-1&&i.insert(o,a*s*u);for(var f=h.tokenStore.get(r),d=Object.keys(f),p=d.length,v=0;p>v;v++)l.add(f[d[v]].ref);return n.union(l)},new t.SortedSet);r.push(u)},this);var a=r.reduce(function(t,e){return t.intersect(e)});return a.map(function(t){return{ref:t,score:i.similarity(this.documentVector(t))}},this).sort(function(t,e){return e.score-t.score})},t.Index.prototype.documentVector=function(e){for(var n=this.documentStore.get(e),i=n.length,r=new t.Vector,o=0;i>o;o++){var s=n.elements[o],a=this.tokenStore.get(s)[e].tf,h=this.idf(s);r.insert(this.corpusTokens.indexOf(s),a*h)}return r},t.Index.prototype.toJSON=function(){return{version:t.version,fields:this._fields,ref:this._ref,tokenizer:this.tokenizerFn.label,documentStore:this.documentStore.toJSON(),tokenStore:this.tokenStore.toJSON(),corpusTokens:this.corpusTokens.toJSON(),pipeline:this.pipeline.toJSON()}},t.Index.prototype.use=function(t){var e=Array.prototype.slice.call(arguments,1);e.unshift(this),t.apply(this,e)},t.Store=function(){this.store={},this.length=0},t.Store.load=function(e){var n=new this;return n.length=e.length,n.store=Object.keys(e.store).reduce(function(n,i){return n[i]=t.SortedSet.load(e.store[i]),n},{}),n},t.Store.prototype.set=function(t,e){this.has(t)||this.length++,this.store[t]=e},t.Store.prototype.get=function(t){return this.store[t]},t.Store.prototype.has=function(t){return t in this.store},t.Store.prototype.remove=function(t){this.has(t)&&(delete this.store[t],this.length--)},t.Store.prototype.toJSON=function(){return{store:this.store,length:this.length}},t.stemmer=function(){var t={ational:"ate",tional:"tion",enci:"ence",anci:"ance",izer:"ize",bli:"ble",alli:"al",entli:"ent",eli:"e",ousli:"ous",ization:"ize",ation:"ate",ator:"ate",alism:"al",iveness:"ive",fulness:"ful",ousness:"ous",aliti:"al",iviti:"ive",biliti:"ble",logi:"log"},e={icate:"ic",ative:"",alize:"al",iciti:"ic",ical:"ic",ful:"",ness:""},n="[^aeiou]",i="[aeiouy]",r=n+"[^aeiouy]*",o=i+"[aeiou]*",s="^("+r+")?"+o+r,a="^("+r+")?"+o+r+"("+o+")?$",h="^("+r+")?"+o+r+o+r,u="^("+r+")?"+i,l=new RegExp(s),c=new RegExp(h),f=new RegExp(a),d=new RegExp(u),p=/^(.+?)(ss|i)es$/,v=/^(.+?)([^s])s$/,g=/^(.+?)eed$/,m=/^(.+?)(ed|ing)$/,y=/.$/,S=/(at|bl|iz)$/,w=new RegExp("([^aeiouylsz])\\1$"),k=new RegExp("^"+r+i+"[^aeiouwxy]$"),x=/^(.+?[^aeiou])y$/,b=/^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/,E=/^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/,F=/^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/,_=/^(.+?)(s|t)(ion)$/,z=/^(.+?)e$/,O=/ll$/,P=new RegExp("^"+r+i+"[^aeiouwxy]$"),T=function(n){var i,r,o,s,a,h,u;if(n.length<3)return n;if(o=n.substr(0,1),"y"==o&&(n=o.toUpperCase()+n.substr(1)),s=p,a=v,s.test(n)?n=n.replace(s,"$1$2"):a.test(n)&&(n=n.replace(a,"$1$2")),s=g,a=m,s.test(n)){var T=s.exec(n);s=l,s.test(T[1])&&(s=y,n=n.replace(s,""))}else if(a.test(n)){var T=a.exec(n);i=T[1],a=d,a.test(i)&&(n=i,a=S,h=w,u=k,a.test(n)?n+="e":h.test(n)?(s=y,n=n.replace(s,"")):u.test(n)&&(n+="e"))}if(s=x,s.test(n)){var T=s.exec(n);i=T[1],n=i+"i"}if(s=b,s.test(n)){var T=s.exec(n);i=T[1],r=T[2],s=l,s.test(i)&&(n=i+t[r])}if(s=E,s.test(n)){var T=s.exec(n);i=T[1],r=T[2],s=l,s.test(i)&&(n=i+e[r])}if(s=F,a=_,s.test(n)){var T=s.exec(n);i=T[1],s=c,s.test(i)&&(n=i)}else if(a.test(n)){var T=a.exec(n);i=T[1]+T[2],a=c,a.test(i)&&(n=i)}if(s=z,s.test(n)){var T=s.exec(n);i=T[1],s=c,a=f,h=P,(s.test(i)||a.test(i)&&!h.test(i))&&(n=i)}return s=O,a=c,s.test(n)&&a.test(n)&&(s=y,n=n.replace(s,"")),"y"==o&&(n=o.toLowerCase()+n.substr(1)),n};return T}(),t.Pipeline.registerFunction(t.stemmer,"stemmer"),t.generateStopWordFilter=function(t){var e=t.reduce(function(t,e){return t[e]=e,t},{});return function(t){return t&&e[t]!==t?t:void 0}},t.stopWordFilter=t.generateStopWordFilter(["a","able","about","across","after","all","almost","also","am","among","an","and","any","are","as","at","be","because","been","but","by","can","cannot","could","dear","did","do","does","either","else","ever","every","for","from","get","got","had","has","have","he","her","hers","him","his","how","however","i","if","in","into","is","it","its","just","least","let","like","likely","may","me","might","most","must","my","neither","no","nor","not","of","off","often","on","only","or","other","our","own","rather","said","say","says","she","should","since","so","some","than","that","the","their","them","then","there","these","they","this","tis","to","too","twas","us","wants","was","we","were","what","when","where","which","while","who","whom","why","will","with","would","yet","you","your"]),t.Pipeline.registerFunction(t.stopWordFilter,"stopWordFilter"),t.trimmer=function(t){return t.replace(/^\W+/,"").replace(/\W+$/,"")},t.Pipeline.registerFunction(t.trimmer,"trimmer"),t.TokenStore=function(){this.root={docs:{}},this.length=0},t.TokenStore.load=function(t){var e=new this;return e.root=t.root,e.length=t.length,e},t.TokenStore.prototype.add=function(t,e,n){var n=n||this.root,i=t.charAt(0),r=t.slice(1);return i in n||(n[i]={docs:{}}),0===r.length?(n[i].docs[e.ref]=e,void(this.length+=1)):this.add(r,e,n[i])},t.TokenStore.prototype.has=function(t){if(!t)return!1;for(var e=this.root,n=0;nFound '+results.length+' result(s)

'); + + results.forEach(function(result) { + var item = loaded_data[result.ref]; + var appendString = ''+item.title+'
'+'https://zeppelin.apache.org/docs/'+zeppelin_version+item.url+'

'+item.excerpt+'


'; + + $search_results.append(appendString); + }); + } else { + $search_results.html('

Your search did not match any documents.
Make sure that all words are spelled correctly or try more general keywords.

'); + } + }); + } +}); diff --git a/docs/development/howtocontribute.md b/docs/development/howtocontribute.md index 2d3842a2257..cd0ca3f6f0a 100644 --- a/docs/development/howtocontribute.md +++ b/docs/development/howtocontribute.md @@ -1,9 +1,23 @@ --- layout: page -title: "How to contribute" -description: "How to contribute" +title: "Contributing to Apache Zeppelin (Code)" +description: "How can you contribute to Apache Zeppelin project? This document covers from setting up your develop environment to making a pull request on Github." group: development --- + +{% include JB/setup %} # Contributing to Apache Zeppelin ( Code ) diff --git a/docs/development/howtocontributewebsite.md b/docs/development/howtocontributewebsite.md index 0db15551585..2ee299b40aa 100644 --- a/docs/development/howtocontributewebsite.md +++ b/docs/development/howtocontributewebsite.md @@ -1,9 +1,23 @@ --- layout: page -title: "How to contribute (website)" -description: "How to contribute (website)" +title: "Contributing to Apache Zeppelin (Website)" +description: "How can you contribute to Apache Zeppelin project website? This document covers from building Zeppelin documentation site to making a pull request on Github." group: development --- + +{% include JB/setup %} # Contributing to Apache Zeppelin ( Website ) diff --git a/docs/development/writingzeppelinapplication.md b/docs/development/writingzeppelinapplication.md index c00aabe563f..e99bbcbe52d 100644 --- a/docs/development/writingzeppelinapplication.md +++ b/docs/development/writingzeppelinapplication.md @@ -1,7 +1,7 @@ --- layout: page -title: "Writing Zeppelin Application" -description: "" +title: "Writing a new Application(Experimental)" +description: "Apache Zeppelin Application is a package that runs on Interpreter process and displays it's output inside of the notebook. Make your own Application in Apache Zeppelin is quite easy." group: development --- {% include JB/setup %} -# Vagrant Virtual Machine for Apache Zeppelin +# Apache Zeppelin on Vagrant Virtual Machine
## Overview -Apache Zeppelin distribution includes a scripts directory +Apache Zeppelin distribution includes a script directory `scripts/vagrant/zeppelin-dev` -This script creates a virtual machine that launches a repeatable, known set of core dependencies required for developing Zeppelin. It can also be used to run an existing Zeppelin build if you don't plan to build from source. +This script creates a virtual machine that launches a repeatable, known set of core dependencies required for developing Zeppelin. It can also be used to run an existing Zeppelin build if you don't plan to build from source. For PySpark users, this script includes several helpful [Python Libraries](#python-extras). For SparkR users, this script includes several helpful [R Libraries](#r-extras). diff --git a/docs/install/yarn_install.md b/docs/install/yarn_install.md index 466007d2daa..e2427546a66 100644 --- a/docs/install/yarn_install.md +++ b/docs/install/yarn_install.md @@ -1,7 +1,7 @@ --- layout: page title: "Install Zeppelin to connect with existing YARN cluster" -description: "" +description: "This page describes how to pre-configure a bare metal node, configure Apache Zeppelin and connect it to existing YARN cluster running Hortonworks flavour of Hadoop." group: install --- {% include JB/setup %} # Alluxio Interpreter for Apache Zeppelin diff --git a/docs/interpreter/bigquery.md b/docs/interpreter/bigquery.md index 1e92aa98757..7ebe2e2fda8 100644 --- a/docs/interpreter/bigquery.md +++ b/docs/interpreter/bigquery.md @@ -1,9 +1,23 @@ --- layout: page -title: "BigQuery Interpreter" -description: "" +title: "BigQuery Interpreter for Apache Zeppelin" +description: "BigQuery is a highly scalable no-ops data warehouse in the Google Cloud Platform." group: interpreter --- + +{% include JB/setup %} # BigQuery Interpreter for Apache Zeppelin diff --git a/docs/interpreter/cassandra.md b/docs/interpreter/cassandra.md index 89b4ea5806f..5d8929bd588 100644 --- a/docs/interpreter/cassandra.md +++ b/docs/interpreter/cassandra.md @@ -1,9 +1,22 @@ --- layout: page -title: "Cassandra Interpreter" -description: "Cassandra Interpreter" +title: "Cassandra CQL Interpreter for Apache Zeppelin" +description: "Apache Cassandra database is the right choice when you need scalability and high availability without compromising performance." group: interpreter --- + {% include JB/setup %} # Cassandra CQL Interpreter for Apache Zeppelin diff --git a/docs/interpreter/elasticsearch.md b/docs/interpreter/elasticsearch.md index 7c6e2cec4de..0e59cae5051 100644 --- a/docs/interpreter/elasticsearch.md +++ b/docs/interpreter/elasticsearch.md @@ -1,9 +1,22 @@ --- layout: page -title: "Elasticsearch Interpreter" -description: "" +title: "Elasticsearch Interpreter for Apache Zeppelin" +description: "Elasticsearch is a highly scalable open-source full-text search and analytics engine." group: interpreter --- + {% include JB/setup %} # Elasticsearch Interpreter for Apache Zeppelin diff --git a/docs/interpreter/flink.md b/docs/interpreter/flink.md index 95ed6410958..3d065465dbd 100644 --- a/docs/interpreter/flink.md +++ b/docs/interpreter/flink.md @@ -1,9 +1,22 @@ --- layout: page -title: "Flink Interpreter" -description: "" +title: "Flink Interpreter for Apache Zeppelin" +description: "Apache Flink is an open source platform for distributed stream and batch data processing." group: interpreter --- + {% include JB/setup %} # Flink interpreter for Apache Zeppelin diff --git a/docs/interpreter/geode.md b/docs/interpreter/geode.md index 24abf2ea561..f833f9d8911 100644 --- a/docs/interpreter/geode.md +++ b/docs/interpreter/geode.md @@ -1,9 +1,22 @@ --- layout: page -title: "Geode OQL Interpreter" -description: "" +title: "Geode/Gemfire OQL Interpreter for Apache Zeppelin" +description: "Apache Geode (incubating) provides a database-like consistency model, reliable transaction processing and a shared-nothing architecture to maintain very low latency performance with high concurrency processing." group: interpreter --- + {% include JB/setup %} # Geode/Gemfire OQL Interpreter for Apache Zeppelin diff --git a/docs/interpreter/hbase.md b/docs/interpreter/hbase.md index 4598f2fe4be..12e05174359 100644 --- a/docs/interpreter/hbase.md +++ b/docs/interpreter/hbase.md @@ -1,9 +1,22 @@ --- layout: page -title: "HBase Shell Interpreter" -description: "" +title: "HBase Shell Interpreter for Apache Zeppelin" +description: "HBase Shell is a JRuby IRB client for Apache HBase. This interpreter provides all capabilities of Apache HBase shell within Apache Zeppelin." group: interpreter --- + {% include JB/setup %} # HBase Shell Interpreter for Apache Zeppelin diff --git a/docs/interpreter/hdfs.md b/docs/interpreter/hdfs.md index 7369ba0feaa..d7b7bf885d8 100644 --- a/docs/interpreter/hdfs.md +++ b/docs/interpreter/hdfs.md @@ -1,9 +1,22 @@ --- layout: page -title: "HDFS File System Interpreter" -description: "" +title: "HDFS File System Interpreter for Apache Zeppelin" +description: "Hadoop File System is a distributed, fault tolerant file system part of the hadoop project and is often used as storage for distributed processing engines like Hadoop MapReduce and Apache Spark or underlying file systems like Alluxio." group: interpreter --- + {% include JB/setup %} # HDFS File System Interpreter for Apache Zeppelin diff --git a/docs/interpreter/hive.md b/docs/interpreter/hive.md index 037055b2654..feeb7a3f536 100644 --- a/docs/interpreter/hive.md +++ b/docs/interpreter/hive.md @@ -1,9 +1,22 @@ --- layout: page -title: "Hive Interpreter" -description: "" +title: "Hive Interpreter for Apache Zeppelin" +description: "Apache Hive data warehouse software facilitates querying and managing large datasets residing in distributed storage. Hive provides a mechanism to project structure onto this data and query the data using a SQL-like language called HiveQL. At the same time this language also allows traditional map/reduce programmers to plug in their custom mappers and reducers when it is inconvenient or inefficient to express this logic in HiveQL." group: interpreter --- + {% include JB/setup %} # Hive Interpreter for Apache Zeppelin diff --git a/docs/interpreter/ignite.md b/docs/interpreter/ignite.md index d157d3121f2..a085dc1aef2 100644 --- a/docs/interpreter/ignite.md +++ b/docs/interpreter/ignite.md @@ -1,9 +1,22 @@ --- layout: page -title: "Ignite Interpreter" -description: "Ignite user guide" +title: "Ignite Interpreter for Apache Zeppelin" +description: "Apache Ignite in-memory Data Fabric is a high-performance, integrated and distributed in-memory platform for computing and transacting on large-scale data sets in real-time, orders of magnitude faster than possible with traditional disk-based or flash technologies." group: interpreter --- + {% include JB/setup %} # Ignite Interpreter for Apache Zeppelin diff --git a/docs/interpreter/jdbc.md b/docs/interpreter/jdbc.md index f7b60a2b0ba..72963c092b3 100644 --- a/docs/interpreter/jdbc.md +++ b/docs/interpreter/jdbc.md @@ -1,13 +1,25 @@ --- layout: page -title: "Generic JDBC Interpreter" -description: "JDBC user guide" +title: "Generic JDBC Interpreter for Apache Zeppelin" +description: "Generic JDBC Interpreter lets you create a JDBC connection to any data source. You can use Postgres, MySql, MariaDB, Redshift, Apache Hive, Apache Phoenix, Apache Drill and Apache Tajo using JDBC interpreter." group: interpreter --- + {% include JB/setup %} - -# Generic JDBC Interpreter for Apache Zeppelin +# Generic JDBC Interpreter for Apache Zeppelin
diff --git a/docs/interpreter/lens.md b/docs/interpreter/lens.md index 20b2c0ccb9d..b929220339a 100644 --- a/docs/interpreter/lens.md +++ b/docs/interpreter/lens.md @@ -1,9 +1,22 @@ --- layout: page -title: "Lens Interpreter" -description: "Lens user guide" +title: "Lens Interpreter for Apache Zeppelin" +description: "Apache Lens provides an Unified Analytics interface. Lens aims to cut the Data Analytics silos by providing a single view of data across multiple tiered data stores and optimal execution environment for the analytical query. It seamlessly integrates Hadoop with traditional data warehouses to appear like one." group: interpreter --- + {% include JB/setup %} # Lens Interpreter for Apache Zeppelin diff --git a/docs/interpreter/livy.md b/docs/interpreter/livy.md index 2f47364aae8..e303d8c9738 100644 --- a/docs/interpreter/livy.md +++ b/docs/interpreter/livy.md @@ -1,9 +1,22 @@ --- layout: page -title: "Livy Interpreter" -description: "" +title: "Livy Interpreter for Apache Zeppelin" +description: "Livy is an open source REST interface for interacting with Spark from anywhere. It supports executing snippets of code or programs in a Spark context that runs locally or in YARN." group: interpreter --- + {% include JB/setup %} # Livy Interpreter for Apache Zeppelin diff --git a/docs/interpreter/markdown.md b/docs/interpreter/markdown.md index 42ab86b18c5..84e1395a495 100644 --- a/docs/interpreter/markdown.md +++ b/docs/interpreter/markdown.md @@ -1,9 +1,22 @@ --- layout: page -title: "Markdown Interpreter" -description: "Markdown Interpreter" +title: "Markdown Interpreter for Apache Zeppelin" +description: "Markdown is a plain text formatting syntax designed so that it can be converted to HTML. Apache Zeppelin uses markdown4j." group: interpreter --- + {% include JB/setup %} # Markdown Interpreter for Apache Zeppelin @@ -12,7 +25,7 @@ group: interpreter ## Overview [Markdown](http://daringfireball.net/projects/markdown/) is a plain text formatting syntax designed so that it can be converted to HTML. -Zeppelin uses markdown4j. For more examples and extension support, please checkout [here](https://code.google.com/p/markdown4j/). +Apache Zeppelin uses markdown4j. For more examples and extension support, please checkout [here](https://code.google.com/p/markdown4j/). In Zeppelin notebook, you can use ` %md ` in the beginning of a paragraph to invoke the Markdown interpreter and generate static html from Markdown plain text. In Zeppelin, Markdown interpreter is enabled by default. diff --git a/docs/interpreter/postgresql.md b/docs/interpreter/postgresql.md index a83731bc6cc..20ef43b6c31 100644 --- a/docs/interpreter/postgresql.md +++ b/docs/interpreter/postgresql.md @@ -1,9 +1,22 @@ --- layout: page -title: "PostgreSQL and HAWQ Interpreter" -description: "" +title: "PostgreSQL, Apache HAWQ (incubating) Interpreter for Apache Zeppelin" +description: "Apache Zeppelin supports PostgreSQL, Apache HAWQ(incubating) and Greenplum SQL data processing engines." group: interpreter --- + {% include JB/setup %} # PostgreSQL, Apache HAWQ (incubating) Interpreter for Apache Zeppelin diff --git a/docs/interpreter/python.md b/docs/interpreter/python.md index 107358413a0..dc10a75c44c 100644 --- a/docs/interpreter/python.md +++ b/docs/interpreter/python.md @@ -1,9 +1,22 @@ --- layout: page -title: "Python Interpreter" -description: "Python Interpreter" +title: "Python 2 & 3 Interpreter for Apache Zeppelin" +description: "Python is a programming language that lets you work quickly and integrate systems more effectively." group: interpreter --- + {% include JB/setup %} # Python 2 & 3 Interpreter for Apache Zeppelin diff --git a/docs/interpreter/r.md b/docs/interpreter/r.md index e4f4a9fd1e4..2b224917ceb 100644 --- a/docs/interpreter/r.md +++ b/docs/interpreter/r.md @@ -1,9 +1,22 @@ --- layout: page -title: "R Interpreter" -description: "" +title: "R Interpreter for Apache Zeppelin" +description: "R is a free software environment for statistical computing and graphics." group: interpreter --- + {% include JB/setup %} # R Interpreter for Apache Zeppelin diff --git a/docs/interpreter/scalding.md b/docs/interpreter/scalding.md index d2e86e742d9..22027f22dee 100644 --- a/docs/interpreter/scalding.md +++ b/docs/interpreter/scalding.md @@ -1,9 +1,22 @@ --- layout: page -title: "Scalding Interpreter" -description: "" +title: "Scalding Interpreter for Apache Zeppelin" +description: "Scalding is an open source Scala library for writing MapReduce jobs." group: interpreter --- + {% include JB/setup %} # Scalding Interpreter for Apache Zeppelin diff --git a/docs/interpreter/shell.md b/docs/interpreter/shell.md index abcaf1c99d1..50a8ded6ccb 100644 --- a/docs/interpreter/shell.md +++ b/docs/interpreter/shell.md @@ -1,9 +1,22 @@ --- layout: page -title: "Shell Interpreter" -description: "Shell Interpreter" +title: "Shell interpreter for Apache Zeppelin" +description: "Shell interpreter uses Apache Commons Exec to execute external processes." group: interpreter --- + {% include JB/setup %} # Shell interpreter for Apache Zeppelin diff --git a/docs/interpreter/spark.md b/docs/interpreter/spark.md index 81f48443a93..72d502ed846 100644 --- a/docs/interpreter/spark.md +++ b/docs/interpreter/spark.md @@ -1,12 +1,24 @@ --- layout: page -title: "Spark Interpreter Group" -description: "" +title: "Apache Spark Interpreter for Apache Zeppelin" +description: "Apache Spark is a fast and general-purpose cluster computing system. It provides high-level APIs in Java, Scala, Python and R, and an optimized engine that supports general execution graphs." group: interpreter --- + {% include JB/setup %} - # Spark Interpreter for Apache Zeppelin
diff --git a/docs/manual/dependencymanagement.md b/docs/manual/dependencymanagement.md index acf6002e8f2..ad8e48371df 100644 --- a/docs/manual/dependencymanagement.md +++ b/docs/manual/dependencymanagement.md @@ -1,7 +1,7 @@ --- layout: page -title: "Dependency Management" -description: "" +title: "Dependency Management for Apache Spark Interpreter" +description: "Include external libraries to Apache Spark Interpreter by setting dependencies in interpreter menu." group: manual --- +{% include JB/setup %} + # Explore Apache Zeppelin UI
diff --git a/docs/quickstart/tutorial.md b/docs/quickstart/tutorial.md index 9333d1437c7..4947f3ce8a0 100644 --- a/docs/quickstart/tutorial.md +++ b/docs/quickstart/tutorial.md @@ -1,7 +1,7 @@ --- layout: page -title: "Tutorial" -description: "Tutorial is valid for Spark 1.3 and higher" +title: "Apache Zeppelin Tutorial" +description: "This tutorial page contains a short walk-through tutorial that uses Apache Spark backend. Please note that this tutorial is valid for Spark 1.3 and higher." group: quickstart --- +{% include JB/setup %} + # Zeppelin Tutorial
diff --git a/docs/rest-api/rest-configuration.md b/docs/rest-api/rest-configuration.md index 4323b6d0040..525ddaf9989 100644 --- a/docs/rest-api/rest-configuration.md +++ b/docs/rest-api/rest-configuration.md @@ -1,7 +1,7 @@ --- layout: page -title: "Configuration REST API" -description: "" +title: "Apache Zeppelin Configuration REST API" +description: "This page contains Apache Zeppelin Configuration REST API information." group: rest-api --- +{% include JB/setup %} + + diff --git a/docs/search_data.json b/docs/search_data.json new file mode 100644 index 00000000000..3df19e958d6 --- /dev/null +++ b/docs/search_data.json @@ -0,0 +1,17 @@ +--- +layout: null +--- +{ + {% for page in site.pages %}{% if page.title != nil %} + + "{{ page.url | slugify }}": { + "title": "{{ page.title | xml_escape }}", + "content" : "{{page.content | strip_html | strip_newlines | escape | remove: "\"}}", + "url": " {{ page.url | xml_escape }}", + "group": "{{ page.group }}", + "excerpt": {{ page.description | strip_html | truncatewords: 40 | jsonify }} + } + {% unless forloop.last %},{% endunless %} + {% endif %} + {% endfor %} +} diff --git a/docs/security/authentication.md b/docs/security/authentication.md index 7ce160aa2b5..60352277883 100644 --- a/docs/security/authentication.md +++ b/docs/security/authentication.md @@ -1,7 +1,7 @@ --- layout: page title: "Authentication for NGINX" -description: "Authentication for NGINX" +description: "There are multiple ways to enable authentication in Apache Zeppelin. This page describes HTTP basic auth using NGINX." group: security --- +{% include JB/setup %} + # Authentication for NGINX
-Authentication is company-specific. +There are multiple ways to enable authentication in Apache Zeppelin. This page describes HTTP basic auth using NGINX. One option is to use [Basic Access Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication). ## HTTP Basic Authentication using NGINX diff --git a/docs/security/datasource_authorization.md b/docs/security/datasource_authorization.md index 3f86b8ab00d..edf39fb26cf 100644 --- a/docs/security/datasource_authorization.md +++ b/docs/security/datasource_authorization.md @@ -1,7 +1,7 @@ --- layout: page -title: "Data Source Authorization" -description: "Data Source Authorization" +title: "Data Source Authorization in Apache Zeppelin" +description: "Apache Zeppelin supports protected data sources. In case of a MySql database, every users can set up their own credentials to access it." group: security --- +{% include JB/setup %} + # Data Source Authorization in Apache Zeppelin
diff --git a/docs/security/notebook_authorization.md b/docs/security/notebook_authorization.md index 87885676ef3..b6511516691 100644 --- a/docs/security/notebook_authorization.md +++ b/docs/security/notebook_authorization.md @@ -1,7 +1,7 @@ --- layout: page -title: "Notebook Authorization" -description: "Notebook Authorization" +title: "Notebook Authorization in Apache Zeppelin" +description: "This page will guide you how you can set the permission for Zeppelin notebooks. This document assumes that Apache Shiro authentication was set up." group: security --- +{% include JB/setup %} + # Zeppelin Notebook Authorization
diff --git a/docs/security/shiroauthentication.md b/docs/security/shiroauthentication.md index 2f3590a2332..65a116d5420 100644 --- a/docs/security/shiroauthentication.md +++ b/docs/security/shiroauthentication.md @@ -1,7 +1,7 @@ --- layout: page -title: "Shiro Security for Apache Zeppelin" -description: "" +title: "Apache Shiro Authentication for Apache Zeppelin" +description: "Apache Shiro is a powerful and easy-to-use Java security framework that performs authentication, authorization, cryptography, and session management. This document explains step by step how Shiro can be used for Zeppelin notebook authentication." group: security --- {% include JB/setup %} -# Shiro authentication for Apache Zeppelin +# Apache Shiro authentication for Apache Zeppelin
diff --git a/docs/storage/storage.md b/docs/storage/storage.md index 19ddd95af82..76012fff4b4 100644 --- a/docs/storage/storage.md +++ b/docs/storage/storage.md @@ -1,7 +1,7 @@ --- layout: page -title: "Storage" -description: "Notebook Storage option for Zeppelin" +title: "Notebook Storage for Apache Zeppelin" +description: Apache Zeppelin has a pluggable notebook storage mechanism controlled by zeppelin.notebook.storage configuration option with multiple implementations." group: storage --- +{% include JB/setup %} + # Notebook storage options for Apache Zeppelin
diff --git a/licenses/LICENSE-lunrjs-0.7.1 b/licenses/LICENSE-lunrjs-0.7.1 new file mode 100644 index 00000000000..e6e4e21b222 --- /dev/null +++ b/licenses/LICENSE-lunrjs-0.7.1 @@ -0,0 +1,19 @@ +Copyright (C) 2013 by Oliver Nightingale + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/pom.xml b/pom.xml index c0b1935b075..3e3523e4df7 100644 --- a/pom.xml +++ b/pom.xml @@ -465,6 +465,8 @@ docs/assets/themes/zeppelin/bootstrap/** docs/assets/themes/zeppelin/css/style.css + docs/assets/themes/zeppelin/js/docs.js + docs/assets/themes/zeppelin/js/search.js docs/_includes/themes/zeppelin/_jumbotron.html docs/_includes/themes/zeppelin/_navigation.html @@ -482,6 +484,7 @@ docs/Rakefile docs/rss.xml docs/sitemap.txt + docs/search_data.json **/dependency-reduced-pom.xml @@ -490,6 +493,9 @@ docs/assets/themes/zeppelin/js/toc.js + + docs/assets/themes/zeppelin/js/lunr.min.js + docs/assets/themes/zeppelin/css/syntax.css