QT/superset2
1
0
Fork 0
mirror of https://github.com/apache/superset.git synced 2026-05-06 16:34:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added a tutorial

Browse Source
This commit is contained in:
Maxime Beauchemin
2016-04-02 23:11:13 -07:00
parent c7d8af8818
commit ecfd8c8ce1
7 changed files with 57 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
_sources/index.txt
View File

@@ -1,3 +1,5 @@
.. image:: _static/img/caravel.jpg
.. warning:: This project used to be name Panoramix and has been renamed
to Caravel in March 2016
@@ -8,17 +10,17 @@ Features
---------
- A rich set of data visualizations, integrated from some of the best
visualization libraries
visualization libraries
- Create and share simple dashboards
- An extensible, high-granularity security/permission model allowing
intricate rules on who can access individual features and the dataset
intricate rules on who can access individual features and the dataset
- Enterprise-ready authentication with integration with major authentication
providers (database, OpenID, LDAP, OAuth & REMOTE_USER through
Flask AppBuilder)
providers (database, OpenID, LDAP, OAuth & REMOTE_USER through
Flask AppBuilder)
- A simple semantic layer, allowing users to control how data sources are
displayed in the UI by defining which fields should show up in which
drop-down and which aggregation and function metrics are made available
to the user
displayed in the UI by defining which fields should show up in which
drop-down and which aggregation and function metrics are made available
to the user
- Integration with most RDBMS through SqlAlchemy
- Deep integration with Druid.io
@@ -29,7 +31,8 @@ Contents
:maxdepth: 2
installation
user_guide
tutorial
videos
Indices and tables

11
_static/docs.css
View File

@@ -6,6 +6,17 @@ div.navbar {
margin-bottom: 0px;
}
p {
margin-top: 5px;
margin-bottom: 15px;
}
#tutorial img {
border: 1px solid gray;
box-shadow: 5px 5px 5px #888888;
margin-bottom: 10px;
}
.carousel img {
max-height: 500px;
}

4
genindex.html
View File

@@ -68,7 +68,8 @@
role="menu"
aria-labelledby="dLabelGlobalToc"><ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation &amp; Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide.html">User Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="videos.html">Videos</a></li>
</ul>
</ul>
</li>
@@ -126,7 +127,6 @@
</p>
<p>
&copy; Copyright 2015, Maxime Beauchemin, Airbnb.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.6.<br/>
</p>
</div>

71
index.html
View File

@@ -68,7 +68,8 @@
role="menu"
aria-labelledby="dLabelGlobalToc"><ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation &amp; Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide.html">User Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="videos.html">Videos</a></li>
</ul>
</ul>
</li>
@@ -202,7 +203,8 @@
<div class="container mainbody">
<div class="admonition warning">
<img alt="_images/caravel.jpg" src="_images/caravel.jpg" />
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">This project used to be name Panoramix and has been renamed
to Caravel in March 2016</p>
@@ -211,40 +213,21 @@ to Caravel in March 2016</p>
<h1>Overview<a class="headerlink" href="#overview" title="Permalink to this headline"></a></h1>
<div class="section" id="features">
<h2>Features<a class="headerlink" href="#features" title="Permalink to this headline"></a></h2>
<ul>
<li><dl class="first docutils">
<dt>A rich set of data visualizations, integrated from some of the best</dt>
<dd><p class="first last">visualization libraries</p>
</dd>
</dl>
</li>
<li><p class="first">Create and share simple dashboards</p>
</li>
<li><dl class="first docutils">
<dt>An extensible, high-granularity security/permission model allowing</dt>
<dd><p class="first last">intricate rules on who can access individual features and the dataset</p>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>Enterprise-ready authentication with integration with major authentication</dt>
<dd><p class="first last">providers (database, OpenID, LDAP, OAuth &amp; REMOTE_USER through
Flask AppBuilder)</p>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>A simple semantic layer, allowing users to control how data sources are</dt>
<dd><p class="first last">displayed in the UI by defining which fields should show up in which
<ul class="simple">
<li>A rich set of data visualizations, integrated from some of the best
visualization libraries</li>
<li>Create and share simple dashboards</li>
<li>An extensible, high-granularity security/permission model allowing
intricate rules on who can access individual features and the dataset</li>
<li>Enterprise-ready authentication with integration with major authentication
providers (database, OpenID, LDAP, OAuth &amp; REMOTE_USER through
Flask AppBuilder)</li>
<li>A simple semantic layer, allowing users to control how data sources are
displayed in the UI by defining which fields should show up in which
drop-down and which aggregation and function metrics are made available
to the user</p>
</dd>
</dl>
</li>
<li><p class="first">Integration with most RDBMS through SqlAlchemy</p>
</li>
<li><p class="first">Deep integration with Druid.io</p>
</li>
to the user</li>
<li>Integration with most RDBMS through SqlAlchemy</li>
<li>Deep integration with Druid.io</li>
</ul>
</div>
<div class="section" id="contents">
@@ -260,14 +243,15 @@ to the user</p>
<li class="toctree-l2"><a class="reference internal" href="installation.html#druid">Druid</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="user_guide.html">User Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="user_guide.html#quick-intro">Quick Intro</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide.html#dashboard-creation">Dashboard Creation</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide.html#dashboard-filtering">Dashboard Filtering</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide.html#customize-css-and-dashboard-themes">Customize CSS and dashboard themes</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide.html#slice-annotations">Slice Annotations</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide.html#adding-a-table">Adding a Table</a></li>
<li class="toctree-l2"><a class="reference internal" href="user_guide.html#define-sql-expressions">Define SQL Expressions</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="videos.html">Videos</a><ul>
<li class="toctree-l2"><a class="reference internal" href="videos.html#quick-intro">Quick Intro</a></li>
<li class="toctree-l2"><a class="reference internal" href="videos.html#dashboard-creation">Dashboard Creation</a></li>
<li class="toctree-l2"><a class="reference internal" href="videos.html#dashboard-filtering">Dashboard Filtering</a></li>
<li class="toctree-l2"><a class="reference internal" href="videos.html#customize-css-and-dashboard-themes">Customize CSS and dashboard themes</a></li>
<li class="toctree-l2"><a class="reference internal" href="videos.html#slice-annotations">Slice Annotations</a></li>
<li class="toctree-l2"><a class="reference internal" href="videos.html#adding-a-table">Adding a Table</a></li>
<li class="toctree-l2"><a class="reference internal" href="videos.html#define-sql-expressions">Define SQL Expressions</a></li>
</ul>
</li>
</ul>
@@ -292,7 +276,6 @@ to the user</p>
</p>
<p>
&copy; Copyright 2015, Maxime Beauchemin, Airbnb.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.6.<br/>
</p>
</div>

6
installation.html
View File

@@ -31,7 +31,7 @@
<script type="text/javascript" src="_static/bootstrap-3.3.4/js/bootstrap.min.js"></script>
<script type="text/javascript" src="_static/bootstrap-sphinx.js"></script>
<link rel="top" title="caravel documentation" href="index.html" />
<link rel="next" title="User Guide" href="user_guide.html" />
<link rel="next" title="Tutorial" href="tutorial.html" />
<link rel="prev" title="Overview" href="index.html" />
<meta charset='utf-8'>
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
@@ -69,7 +69,8 @@
role="menu"
aria-labelledby="dLabelGlobalToc"><ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="">Installation &amp; Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide.html">User Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="videos.html">Videos</a></li>
</ul>
</ul>
</li>
@@ -273,7 +274,6 @@ into your global default defined in <code class="docutils literal"><span class="
</p>
<p>
&copy; Copyright 2015, Maxime Beauchemin, Airbnb.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.6.<br/>
</p>
</div>

4
search.html
View File

@@ -75,7 +75,8 @@
role="menu"
aria-labelledby="dLabelGlobalToc"><ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation &amp; Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="user_guide.html">User Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="videos.html">Videos</a></li>
</ul>
</ul>
</li>
@@ -148,7 +149,6 @@
</p>
<p>
&copy; Copyright 2015, Maxime Beauchemin, Airbnb.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.6.<br/>
</p>
</div>

2
searchindex.js
View File

@@ -1 +1 @@
Search.setIndex({envversion:46,filenames:["index","installation","user_guide"],objects:{},objnames:{},objtypes:{},terms:{"1thisismyscretkei":1,"64bit":1,"default":1,"function":0,"new":2,"short":2,"true":1,"while":1,abl:1,about:1,access:[0,2],account:1,action:1,admin:1,affect:2,after:1,aggreg:0,all:1,allow:[0,1],alreadi:2,also:1,alter:2,annot:0,app:1,appbuild:0,appli:2,applic:1,apt:1,aspect:2,attempt:1,authent:0,avail:[0,2],awar:1,back:1,backend:1,bat:1,been:0,best:0,brew:1,bring:1,browser:1,build:1,builder:1,cach:0,cache_config:1,can:[0,1,2],caravel:0,caravel_config:1,caravel_webserver_port:1,certain:2,cflag:1,chart:2,cluster:1,collect:2,come:[1,2],command:1,compli:1,config:1,configur:0,connect:1,constant:1,consult:1,control:0,copi:1,creat:[0,1,2],creation:0,credenti:1,cryptographi:1,csrf:1,csrf_enabl:1,css:0,current:1,custom:0,dashboard:[0,1],data:[0,1,2],databas:[0,1],dataset:[0,2],datasourc:1,debian:1,debug:1,deep:0,defin:[0,1],demonstr:2,depend:0,deriv:[1,2],dev:1,devel:1,develop:1,differ:2,dimens:2,directli:1,displai:0,document:1,done:1,down:0,drop:0,druid:0,dynam:2,easi:1,encount:1,encrypt:1,ensur:1,enter:1,enterpris:0,env:1,error:1,essenti:1,exist:2,explor:[1,2],expos:2,express:0,extens:0,fabmanag:1,fall:1,fedora:1,few:1,field:0,file:1,filesystem:1,filter:0,flag:1,flask:[0,1],follow:1,framework:1,from:[0,1,2],gcc:1,get:0,global:1,goe:1,granular:0,guid:0,here:1,high:[0,2],hit:1,hostnam:1,how:[0,1,2],http:1,immun:2,includ:1,index:0,individu:0,inform:1,init:1,initi:0,instal:0,integr:0,intric:0,intro:0,isn:1,item:1,kei:1,languag:2,layer:0,ldap:0,ldflag:1,level:[1,2],lib:1,libffi:1,librari:[0,1],libssl:1,load:1,load_exampl:1,local:1,localhost:1,login:1,made:0,mai:1,major:0,make:1,manag:1,march:0,markdown:2,memcach:1,memori:1,menu:1,metadata:1,metric:[0,2],mode:1,model:0,modul:[0,1],more:1,most:0,multipl:1,name:0,navig:[1,2],need:1,next:1,note:1,oauth:0,offici:1,onc:1,onli:1,openid:0,openssl:1,osx:1,other:2,own:2,page:0,panoramix:0,paramet:1,password:1,past:1,path:1,permiss:[0,1],pip:1,pkg:1,plai:1,pleas:1,point:1,popul:1,port:1,prefix:1,project:0,provid:[0,1],purpos:1,python:1,pythonpath:1,quick:0,rdbm:0,readi:0,redi:1,refresh:1,remote_us:0,renam:0,requir:1,rhel:1,rich:0,right:1,roadmap:1,role:1,row_limit:1,rule:0,run:1,runserv:1,search:0,searchpath:1,secret:1,secret_kei:1,secur:0,semant:[0,2],server:1,set:[0,1],share:0,should:[0,1],show:[0,1,2],sign:1,simpl:[0,1,2],simplecach:1,slice:[0,1],some:[0,1],soon:2,sourc:[0,1],specif:1,specifix:1,sql:0,sqlalchemi:[0,1],sqlalchemy_database_uri:1,sqlite:1,start:0,step:1,store:1,string:1,sudo:1,support:1,sure:1,templat:2,test:1,thei:1,them:[1,2],theme:0,thi:[0,1,2],through:[0,2],timeout:1,tmp:1,toggl:2,ubuntu:1,ultim:1,unfortun:1,upgrad:1,user:[0,1],vcvarsal:1,video:2,view:2,visual:0,walk:2,walkthrough:2,want:1,web:1,webserver_thread:1,where:1,whether:1,which:0,who:0,widget:2,window:1,won:1,work:2,wtf:1,x86_amd64:1,you:[1,2],your:[1,2],yum:1},titles:["Overview","Installation &amp; Configuration","User Guide"],titleterms:{annot:2,cach:1,caravel:1,configur:1,content:0,creation:2,css:2,custom:2,dashboard:2,defin:2,depend:1,druid:1,express:2,featur:0,filter:2,get:1,guid:2,indic:0,initi:1,instal:1,intro:2,overview:0,quick:2,slice:2,sql:2,start:1,tabl:[0,2],theme:2,user:2}})
Search.setIndex({envversion:46,filenames:["index","installation","tutorial","videos"],objects:{},objnames:{},objtypes:{},terms:{"1thisismyscretkei":1,"64bit":1,"default":1,"function":0,"new":[2,3],"short":3,"true":1,"while":1,abl:1,about:[1,2],access:[0,2,3],account:1,action:1,add:2,admin:1,affect:3,after:1,aggreg:[0,2],ago:2,all:1,allow:[0,1],alreadi:3,also:[1,2],alter:[2,3],ani:2,annot:0,app:1,appbuild:0,appli:3,applic:1,apt:1,arbitrari:2,around:2,aspect:3,attempt:1,authent:0,avail:[0,3],awar:1,back:[1,2],backend:1,bar:2,basic:2,bat:1,been:[0,2],best:0,brew:1,bring:1,browser:1,build:1,builder:1,button:2,cach:0,cache_config:1,can:[0,1,2,3],caravel:0,caravel_config:1,caravel_webserver_port:1,certain:3,cflag:1,chart:3,check:2,checkbox:2,click:2,cluster:1,collect:[2,3],column:2,come:[1,3],command:1,compli:1,config:1,configur:0,connect:[1,2],constant:1,construct:2,consult:1,control:0,copi:1,could:2,creat:[0,1,2,3],creation:0,credenti:1,cryptographi:1,csrf:1,csrf_enabl:1,css:[0,2],current:1,custom:0,cut:2,dashboard:[0,1,2],data:[0,1,2,3],databas:[0,1,2],dataset:[0,3],datasourc:1,date:2,debian:1,debug:1,deep:0,defin:[0,1],demonstr:3,depend:0,deriv:[1,3],dev:1,devel:1,develop:1,differ:[2,3],dimens:[2,3],directli:1,displai:0,document:[1,2],done:[1,2],down:0,drop:0,dropdown:2,druid:0,dynam:3,easi:1,easili:2,edit:2,editor:2,either:2,encount:1,encrypt:1,ensur:1,enter:[1,2],enterpris:0,entri:2,env:1,error:1,essenti:1,exist:3,explor:[1,2,3],expos:3,express:[0,2],extens:0,fabmanag:1,fall:1,fedora:1,fetch:2,few:[1,2],field:[0,2],figur:2,file:1,filesystem:1,fill:2,filter:[0,2],find:2,first:2,flag:1,flask:[0,1],follow:1,form:2,found:2,framework:1,from:[0,1,2,3],gcc:1,get:0,global:1,goe:1,granular:0,guess:2,hard:2,here:[1,2,3],high:[0,3],hit:[1,2],hostnam:1,how:[0,1,2,3],http:1,icon:2,immun:3,includ:1,index:0,individu:0,inform:[1,2],init:1,initi:0,instal:0,integr:0,interest:2,intric:0,intro:0,isn:1,item:1,just:2,kei:1,languag:[2,3],layer:0,ldap:0,ldflag:1,let:2,level:[1,3],lib:1,libffi:1,librari:[0,1],libssl:1,linear:2,list:2,load:1,load_exampl:1,local:1,localhost:1,login:1,made:0,mai:[1,2],major:0,make:[1,2],manag:1,march:0,markdown:3,memcach:1,memori:1,menu:[1,2],metadata:[1,2],metric:[0,2,3],modal:2,mode:1,model:0,modul:[0,1],moment:2,more:1,most:0,move:2,multipl:1,name:[0,2],natur:2,navig:[1,2,3],need:[1,2],next:[1,2],note:[1,2],now:2,oauth:0,offici:1,onc:[1,2],onli:1,openid:0,openssl:1,option:2,origin:2,osx:1,other:[2,3],out:2,own:3,page:0,panoramix:0,paramet:1,password:1,past:1,path:1,pen:2,permiss:[0,1],pick:2,pip:1,pkg:1,plai:1,pleas:1,plu:2,point:1,popul:1,popup:2,port:1,posit:2,prefix:1,project:0,provid:[0,1],purpos:1,python:1,pythonpath:1,queri:2,quick:0,rdbm:0,readi:0,redi:1,refer:2,refresh:1,rel:2,relev:2,remote_us:0,renam:[0,2],requir:1,resiz:2,rhel:1,rich:0,right:[1,2],roadmap:1,role:1,row_limit:1,rule:0,run:1,runserv:1,same:2,save:2,search:0,searchabl:2,searchpath:1,secret:1,secret_kei:1,secur:0,see:2,select:2,semant:[0,3],server:1,set:[0,1],share:0,should:[0,1,2],show:[0,1,2,3],shown:2,sign:[1,2],similar:2,simpl:[0,1,3],simplecach:1,simpli:2,size:2,slice:[0,1,2],some:[0,1,2],soon:3,sourc:[0,1,2],specif:1,specifix:1,sql:[0,2],sqlalchemi:[0,1,2],sqlalchemy_database_uri:1,sqlite:1,start:0,step:[1,2],store:1,string:1,style:2,sudo:1,support:1,sure:[1,2],tab:2,take:2,tell:2,templat:3,test:[1,2],textbox:2,thei:1,them:[1,2,3],theme:0,thi:[0,1,2,3],thing:2,through:[0,2,3],time:2,timeout:1,tini:2,tmp:1,toggl:3,top:2,tri:2,tutori:0,type:2,ubuntu:1,ultim:1,unfortun:1,until:2,upgrad:1,uri:2,user:[0,1],vcvarsal:1,video:0,view:[2,3],visual:0,walk:3,walkthrough:3,want:[1,2],web:1,webserver_thread:1,week:2,well:2,when:2,where:[1,2],whether:1,which:[0,2],who:0,widget:3,window:[1,2],won:1,work:[2,3],wtf:1,x86_amd64:1,year:2,yet:2,you:[1,2,3],your:[1,2,3],yum:1},titles:["Overview","Installation &amp; Configuration","Tutorial","Videos"],titleterms:{annot:3,cach:1,caravel:1,configur:1,content:0,creation:3,css:3,custom:3,dashboard:3,defin:3,depend:1,druid:1,express:3,featur:0,filter:3,get:1,indic:0,initi:1,instal:1,intro:3,overview:0,quick:3,slice:3,sql:3,start:1,tabl:[0,3],theme:3,tutori:2,video:3}})