Skip to content

Commit

Permalink
Adding a tutorial
Browse files Browse the repository at this point in the history
  • Loading branch information
mistercrunch committed Apr 3, 2016
1 parent 93405dc commit d2f5190
Show file tree
Hide file tree
Showing 16 changed files with 29 additions and 13 deletions.
Binary file added caravel/assets/images/tutorial/created.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added caravel/assets/images/tutorial/db_added.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added caravel/assets/images/tutorial/db_menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added caravel/assets/images/tutorial/db_plus.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added caravel/assets/images/tutorial/explore.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added caravel/assets/images/tutorial/in_new_dash.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added caravel/assets/images/tutorial/matrix.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added caravel/assets/images/tutorial/new_dash.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added caravel/assets/images/tutorial/pen.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added caravel/assets/images/tutorial/search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions dev-reqs.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
coveralls
pillow
sphinx
sphinx_bootstrap_theme
11 changes: 11 additions & 0 deletions docs/_static/docs.css
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
Expand Down
3 changes: 2 additions & 1 deletion docs/build.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
#!/usr/bin/env bash
rm -rf _build
make html
cp -r ../caravel/assets/images/ _build/html/_static/img/
#cp -r ../caravel/assets/images/ _build/html/_static/img/
cp -r ../caravel/assets/images/ _static/img/
rm -rf /tmp/caravel-docs
cp -r _build/html /tmp/caravel-docs
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@
#html_show_sphinx = True

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
html_show_copyright = False

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
Expand Down
19 changes: 11 additions & 8 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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

Expand All @@ -29,7 +31,8 @@ Contents
:maxdepth: 2

installation
user_guide
tutorial
videos


Indices and tables
Expand Down
6 changes: 3 additions & 3 deletions docs/user_guide.rst → docs/videos.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
User Guide
==========
Videos
======

The user guide is a collection of short videos showing different aspect
Here is a collection of short videos showing different aspect
of Caravel.

Quick Intro
Expand Down

0 comments on commit d2f5190

Please sign in to comment.