pt
/
superset
mirror of https://github.com/apache/superset.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improving the docs

This commit is contained in:
Maxime Beauchemin 2016-03-02 12:19:11 -08:00
parent b6a2521722
commit bd296720b8
2 changed files with 63 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/index.rst
View File

@ -1,8 +1,3 @@
.. panoramix documentation master file, created by
sphinx-quickstart on Thu Dec 17 15:42:06 2015.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. image:: img/tux_panoramix.png
Overview
@ -11,11 +6,18 @@ Overview
Features
---------
- A rich set of data visualizations, integrated from some of the best visualization libraries
- A rich set of data visualizations, integrated from some of the best
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
- Enterprise-ready authentication with integration with major authentication 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
- An extensible, high-granularity security/permission model allowing
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)
- 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
- Integration with most RDBMS through SqlAlchemy
- Deep integration with Druid.io

53
docs/user_guide.rst
View File

@ -1,3 +1,54 @@
User Guide
==========
Panoramix is easy to use, so this User Guide should be short.
The user guide is a collection of short videos showing different aspect
of Panoramix.
Quick Intro
'''''''''''
This video demonstrates how Panoramix works at a high level, it shows how
to navigate through datasets and dashboards that are already available.
- Coming soon!
Dashboard Creation
''''''''''''''''''
This video walk you through the creation of a simple dashboard as a
collection of data slices.
- Coming soon!
Dashboard Filtering
'''''''''''''''''''
This video shows how to create dynamic filters on dashboards, how to
immunize certain widgets from being affected by filters.
- Coming soon!
Customize CSS and dashboard themes
''''''''''''''''''''''''''''''''''
A quick walkthrough on how to apply existing CSS templates, alter them and
create new ones.
- Coming soon!
Slice Annotations
'''''''''''''''''
A short video on how to annotate your charts, the markdown language and
to toggle them on dashboards.
- Coming soon!
Adding a Table
''''''''''''''
This videos shows you how to expose a new table in Panoramix, and how to
define the semantics on how this can be accessed by others in the ``Explore``
and ``Dashboard`` views.
- Coming soon!
Define SQL Expressions
''''''''''''''''''''''
A walkthrough on how to create your own derived dimensions and metrics.
- Coming soon!