docs: add a faq about mapbox api key (#968)

Also add it to sample config Fix #952
apache · Aug 17, 2016 · a029eaa · a029eaa
1 parent ac512ef
commit a029eaa
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/docs/faq.rst b/docs/faq.rst
@@ -54,3 +54,10 @@ increase the default (50), you can specify the timeout when starting the
 web server with the ``-t`` flag, which is expressed in seconds.
 
 ``caravel runserver -t 300``
+
+
+Why is the map not visible in the mapbox visualization?
+-------------------------------------------------------
+
+You need to register to mapbox.com, get an API key and configure it as
+``MAPBOX_API_KEY`` in ``caravel_config.py``.
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -141,6 +141,9 @@ of the parameters you can copy / paste in that configuration module: ::
     # Flask-WTF flag for CSRF
     CSRF_ENABLED = True
 
+    # Set this API key to enable Mapbox visualizations
+    MAPBOX_API_KEY = ''
+
 This file also allows you to define configuration parameters used by
 Flask App Builder, the web framework used by Caravel. Please consult
 the `Flask App Builder Documentation