Merge pull request #62 from JessXu/docs

Jessica (Jiayi) Xu · web-flow · commit bda88d7c91a1 · 2020-08-25T09:56:00.000-07:00
Docs
diff --git a/README.md b/README.md
@@ -2,6 +2,7 @@
 
 ![Github Actions Status](https://github.com/jupytercalpoly/jupyterlab-interactive-dashboard-editor/workflows/Build/badge.svg)
 [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupytercalpoly/jupyterlab-interactive-dashboard-editor/master?urlpath=lab)
+[![npm version](https://badge.fury.io/js/jupyterlab-interactive-dashboard-editor.svg)](https://www.npmjs.com/package/jupyterlab-interactive-dashboard-editor)
 [![Documentation Status](https://readthedocs.org/projects/jupyterlab-interactive-dashboard-editor/badge/?version=latest)](https://jupyterlab-interactive-dashboard-editor.readthedocs.io/en/latest/?badge=latest)
 
 Interactively create and customize dashboards in JupyterLab
diff --git a/census.ipynb b/census.ipynb
diff --git a/docs/contributor/codebase.rst b/docs/contributor/codebase.rst
@@ -0,0 +1,4 @@
+.. _codebase:
+
+Codebase Orientation
+--------------------
diff --git a/docs/contributor/contribute.rst b/docs/contributor/contribute.rst
@@ -0,0 +1,4 @@
+.. _contribute:
+
+How to Contribute
+-----------------
diff --git a/docs/contributor/file_format.rst b/docs/contributor/file_format.rst
@@ -0,0 +1,4 @@
+.. _file_format:
+
+.dash File Format
+-----------------
diff --git a/docs/getting_started/changelog.rst b/docs/getting_started/changelog.rst
@@ -0,0 +1,30 @@
+.. _changelog:
+
+Changelog
+---------
+
+v0.1.0
+^^^^^^
+* Free-floating Layout
+* Drag and drop live code cell outputs and markdown
+* Widget Relocation and Resizing
+* Undo/Redo using WidgetStore
+* Interactions between dashboards (copy/cut/paste/drag and drop)
+* Save to and load from .dashboard file
+* Run and stop outputs
+* Edit/View Mode
+* Widget fit to content
+
+v0.2.0
+^^^^^^
+* Document Registry Integration: native saving, loading, renaming, autosaving, downloading, etc
+* Missing notebook/cell cases are both handled with colored backgrounds
+* Both .dash and .dashboard files are supported
+
+v0.3.0
+^^^^^^
+* Experimental tiled layout
+* Overlap detection/mitigation
+* Extension provides an IDashboardTracker token
+* Set dimensions when creating a new dashboard
+* Widget overlay in edit modes
diff --git a/docs/getting_started/installation.rst b/docs/getting_started/installation.rst
@@ -3,9 +3,47 @@
 Installation
 ------------
 
+Requirements
+~~~~~~~~~~~~
+JupyterLab >= 2.0
+
+Install
+~~~~~~~
 Note: You will need NodeJS to install the extension.
 
 .. code:: bash
 
     pip install jupyterlab_interactive_dashboard_editor
-    jupyter lab build
+    jupyter lab build
+
+.. code:: bash
+
+    # Clone the repo to your local environment
+    # Move to jupyterlab-interactive-dashboard-editor directory
+
+    # Install dependencies
+    jlpm
+    # Build Typescript source
+    jlpm build
+    # Link your development version of the extension with JupyterLab
+    jupyter labextension install .
+    # Rebuild Typescript source after making changes
+    jlpm build
+    # Rebuild JupyterLab after making any changes
+    jupyter lab build
+
+You can watch the source directory and run JupyterLab in watch mode to watch for changes in the extension's source and automatically rebuild the extension and application.
+
+.. code:: bash
+
+    # Watch the source directory in another terminal tab
+    jlpm watch
+    # Run jupyterlab in watch mode in one terminal tab
+    jupyter lab --watch
+
+Now every change will be built locally and bundled into JupyterLab. Be sure to refresh your browser page after saving file changes to reload the extension (note: you'll need to wait for webpack to finish, which can take 10s+ at times).
+
+Uninstall
+~~~~~~~~~
+.. code:: bash
+jupyter labextension uninstall jupyterlab-interactive-dashboard-editor
diff --git a/docs/getting_started/overview.rst b/docs/getting_started/overview.rst
@@ -6,4 +6,6 @@ Overview
 Interactively create and customize dashboards in JupyterLab.
 
 .. image:: ../../Design/gifs/overview.gif
-   :align: center
+   :align: center
+
+The JupyterLab Interactive Dashboard Editor extension is a live editor that enables you to intuitively build aesthetic, interactive dashboards side-by-side with your notebook. You can rearrange, remove, and customize outputs (plots, widgets, text, etc.) in a grid layout by dragging cells directly from your notebook onto the dashboard.
diff --git a/docs/index.rst b/docs/index.rst
@@ -4,7 +4,7 @@
    contain the root `toctree` directive.
 
 JupyterLab Interactive Dashboard Editor Documentation
-=======================================================
+=====================================================
 
 Interactively create and customize dashboards in JupyterLab. `Try it on Binder <https://mybinder.org/v2/gh/jupytercalpoly/jupyterlab-interactive-dashboard-editor/master?urlpath=lab>`__.
 
@@ -17,9 +17,19 @@ Interactively create and customize dashboards in JupyterLab. `Try it on Binder <
 
    getting_started/overview
    getting_started/installation
+   getting_started/start
+   getting_started/changelog
 
 .. toctree::
    :maxdepth: 1
    :caption: User Guide
    
-   user/interface
+   user/ux
+   user/features
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contributor Guide
+   
+   contributor/codebase
+   contributor/contribute
diff --git a/docs/user/features.rst b/docs/user/features.rst
@@ -0,0 +1,4 @@
+.. _features:
+
+Features
+--------
diff --git a/docs/user/interface.rst b/docs/user/interface.rst
diff --git a/docs/user/ux.rst b/docs/user/ux.rst
@@ -0,0 +1,4 @@
+.. _ux:
+
+User Experience
+---------------
diff --git a/sample.dash b/sample.dash
@@ -0,0 +1,158 @@
+{
+  "metadata": {
+    "dashboardHeight": 1270,
+    "dashboardWidth": 2000
+  },
+  "version": 1,
+  "outputs": {
+    "1c9191a6-2e25-4bb0-90f0-68fe8ecbe7f5": [
+      {
+        "cellId": "70d33a92-6fd7-48f2-a455-68494cc3f0df",
+        "pos": {
+          "left": 1084,
+          "top": 424,
+          "width": 500,
+          "height": 294
+        }
+      },
+      {
+        "cellId": "9491fc09-cc45-49eb-9be7-d0e1efa166ee",
+        "pos": {
+          "left": 19,
+          "top": 368,
+          "width": 500,
+          "height": 294
+        }
+      },
+      {
+        "cellId": "a6f74791-2204-46c8-aa19-48fb1d9088b2",
+        "pos": {
+          "left": 31,
+          "top": 674,
+          "width": 500,
+          "height": 236
+        }
+      },
+      {
+        "cellId": "9e2ebdd7-b08d-4fbe-80d7-3c998186b438",
+        "pos": {
+          "left": 1588,
+          "top": 160,
+          "width": 412,
+          "height": 144
+        }
+      },
+      {
+        "cellId": "4e26f4fd-8dd4-4a92-bd79-702d2d877cb0",
+        "pos": {
+          "left": 1628,
+          "top": 360,
+          "width": 358,
+          "height": 210
+        }
+      },
+      {
+        "cellId": "57bdcaf6-cd6e-465e-84a7-b2fa68ccf132",
+        "pos": {
+          "left": 549,
+          "top": 766,
+          "width": 500,
+          "height": 96
+        }
+      },
+      {
+        "cellId": "7533ae1c-2365-4682-9a84-88fd95620018",
+        "pos": {
+          "left": 31,
+          "top": 916,
+          "width": 499,
+          "height": 354
+        }
+      },
+      {
+        "cellId": "207b0abd-398f-453f-a586-95c6e33adba9",
+        "pos": {
+          "left": 549,
+          "top": 448,
+          "width": 500,
+          "height": 294
+        }
+      },
+      {
+        "cellId": "0b518286-836b-4c05-ad86-89524e7bbfa1",
+        "pos": {
+          "left": 9,
+          "top": 12,
+          "width": 315,
+          "height": 74
+        }
+      },
+      {
+        "cellId": "6a65ada9-0dd3-4968-b3d3-13978b684361",
+        "pos": {
+          "left": 13,
+          "top": 124,
+          "width": 500,
+          "height": 228
+        }
+      },
+      {
+        "cellId": "4edcc39e-aba5-45e9-8d2a-87ca661f021e",
+        "pos": {
+          "left": 1632,
+          "top": 638,
+          "width": 358,
+          "height": 262
+        }
+      },
+      {
+        "cellId": "5a634abd-35c9-40cc-8f2c-bccea9c08a92",
+        "pos": {
+          "left": 551,
+          "top": 880,
+          "width": 499,
+          "height": 294
+        }
+      },
+      {
+        "cellId": "5fe5caeb-c0f8-4d6e-8138-e4e825837121",
+        "pos": {
+          "left": 1071,
+          "top": 156,
+          "width": 499,
+          "height": 236
+        }
+      },
+      {
+        "cellId": "c06d229b-ff60-462f-9d5d-59a728b1b29e",
+        "pos": {
+          "left": 547,
+          "top": 154,
+          "width": 499,
+          "height": 310
+        }
+      },
+      {
+        "cellId": "ef171bbd-2746-4790-9288-992ebff6372f",
+        "pos": {
+          "left": 1073,
+          "top": 950,
+          "width": 500,
+          "height": 294
+        }
+      },
+      {
+        "cellId": "e4cb68c1-f613-4453-8ff0-e4da1e6ad937",
+        "pos": {
+          "left": 1083,
+          "top": 750,
+          "width": 500,
+          "height": 124
+        }
+      }
+    ]
+  },
+  "paths": {
+    "demo/census.ipynb": "1c9191a6-2e25-4bb0-90f0-68fe8ecbe7f5"
+  }
+}

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +.. _codebase:
++
 +Codebase Orientation
 +--------------------