Merge pull request #302 from parente/clean-up-demos

Clean up demo notebooks

.gitignore

@@ -63,14 +63,6 @@ node_modules/
 bower_components/
 __pycache__/
 *.egg-info/
-etc/notebooks/*
-!etc/notebooks/*_demo
-!etc/notebooks/test/
-!etc/notebooks/system-test/
-!etc/notebooks/*_demo/*
-!etc/notebooks/*_tutorial
-!etc/notebooks/index.ipynb
-!etc/notebooks/images/
 etc/notebooks/*_demo/.dashboard_cache
 etc/notebooks/*_demo/.ipynb_checkpoints
 etc/jupyter_notebook_config.py

README.md

@@ -14,14 +14,6 @@ layouts.
 
 For a sample of what's possible with the dashboard layout extension, have a look at the [demo dashboard-notebooks](etc/notebooks) in this repository.
 
-The extension can be used in combination with the incubating
-[jupyter-incubator/dashboards_bundlers](https://github.com/jupyter-incubator/dashboards_bundlers)
-and
-[jupyter-incubator/dashboards_server](https://github.com/jupyter-incubator/dashboards_server)
-projects. See the [Understanding the use
-case](http://jupyter-dashboards-layout.readthedocs.io/en/latest/use-cases.html)
-documentation page for more background information.
-
 ## Installation
 
 Detailed installation instructions appear in the [Getting started

docs/source/index.rst

@@ -8,8 +8,6 @@ The dashboards layout extension is an add-on for Jupyter Notebook. It lets you a
 
 For a sample of what's possible with the dashboard layout extension, have a look at the `demo dashboard-notebooks in the project repository <https://github.com/jupyter/dashboards/tree/master/etc/notebooks>`__.
 
-The extension can be used in combination with the incubating `jupyter-incubator/dashboards_bundlers <https://github.com/jupyter-incubator/dashboards_bundlers>`__ and `jupyter-incubator/dashboards_server <https://github.com/jupyter-incubator/dashboards_server>`__ projects.
-
 .. toctree::
    :maxdepth: 2
    :caption: User Documentation

etc/notebooks/README.md

@@ -0,0 +1,32 @@
+# Jupyter Dashboards Demos
+
+The [dashboards layout extension](https://github.com/jupyter/dashboards) is an
+add-on for Jupyter Notebook. It lets you arrange your notebook outputs (text,
+plots, widgets, ...) in grid- or report-like layouts. It saves information
+about your layouts in your notebook document. Other people with the extension
+can open your notebook and view your layouts.
+
+The git repository for the project contains a handful of notebooks that you can
+run and modify to learn how the dashboards extension works. After installing
+the extension and learning the basics by reading the
+[documentation](http://jupyter-dashboards-layout.readthedocs.io/en/latest/index.html),
+do the following to get a copy of the example notebooks to run yourself.
+
+```
+# Get a copy of the project source and example notebooks
+git clone https://github.com/jupyter/dashboards.git
+
+# Activate the virtualenv or conda environment containing your
+# install of jupyter notebook and the extension. Then install
+# the demo requirements.
+pip install -r dashboards/requirements-demo.txt
+
+# Run the notebook server.
+jupyter notebook --notebook-dir=./dashboards/etc/notebooks/
+```
+
+The following demos are kept up-to-date as issues with dependencies are found and fixed.
+
+1. [Got Scotch?](got_scotch_demo/scotch_dashboard.ipynb) - show similarities
+   between scotch varieties
+2. [Plotting demo](plotting_demo.ipynb) - shows how matplotlib, bokeh, and plotly work in a dashboard layout