Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add dashboarding section #8

Merged
merged 2 commits into from
Apr 22, 2016
Merged

Add dashboarding section #8

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
db44bc2
Add section on dashboarding
parente Mar 31, 2016
1401215
Dashboard URL renderer TBD
parente Apr 4, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 34 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ our documentation spans all subprojects, each of which have their own release cy
versioning, the documentation roadmap doesn't have concrete version numbers associated with
each milestone.

### Next
### Next

* Hire full time and part time staff who will focus on improving our documentation.
* Research existing tools for writing documentation (Readthedocs, Sphinx, Notebooks, etc.)
Expand Down Expand Up @@ -110,7 +110,6 @@ each milestone.
- Notebook.
- Variable inspector.
- UI for managing plugins.
* Dashboarding of output areas and interactive widgets.
* If, and only if, JupyterLab becomes a full replacement, deprecate existing pages in the notebook
web-application.
* Real-time collaboration on the notebook, text editor, and other plugins.
Expand All @@ -123,9 +122,9 @@ each milestone.
### Next (5.0)

* Improved and consistent visual style of built-in widgets.
* Hands off approach to styling. ipywidgets only provides an API for
adding/removing CSS classes and the Style API. The Style API provides the
ability to set layout CSS traits in a mutable fashion. All other styling APIs
* Hands off approach to styling. ipywidgets only provides an API for
adding/removing CSS classes and the Style API. The Style API provides the
ability to set layout CSS traits in a mutable fashion. All other styling APIs
are deprecated.
* Ability to run ipywidgets outside of the notebook.
* Initial refactoring to start to use npm for packaging the JavaScript code.
Expand All @@ -136,7 +135,7 @@ each milestone.
### Next+1 (6.0)

* jupyter-js-widgets will be modernized, using a modern packaging specification,
a modern transpiler, and offloading much of JavaScript weight lifting to third
a modern transpiler, and offloading much of JavaScript weight lifting to third
party packages.
* Explore how we can start to treat widgets as regular output, and not have to have
a separate widget area in the DOM.
Expand All @@ -145,13 +144,13 @@ each milestone.
the backbone models with phosphorjs widget-based views.
* Allow widgets to be used at the top-level of the JupyterLab UI to create dashboards.
* The model layer of the widgets will be made even more symmetric, allowing
widgets to be created, with traits, entirely in the front-end. This will
widgets to be created, with traits, entirely in the front-end. This will
further support the declaritive widgets and similar work. It will also enable
the mapping of typed models into the front-end to the back-end with no effort.

### Future

* The backbone widgets provided with jupyter-js-widgets will be moved into their
* The backbone widgets provided with jupyter-js-widgets will be moved into their
own repository or will be removed altogether.

## traitlets
Expand Down Expand Up @@ -193,12 +192,10 @@ each milestone.
- Once the single-user notebook package supports realtime collaboration,
implement sharing mechanism integrated into the Hub.


## Deployment

- provide reference "best practice" deployment of JuptyerHub, via Ansible scripts or otherwise


## IPython

IPython is comparatively mature, and there are consequently fewer major changes
Expand All @@ -211,6 +208,33 @@ planned. However, we plan to:
Python code (separate completion machinery is still needed for our special
syntax).

## Dashboarding

### jupyter/enhancement-proposals (now)

* Create an enhancement proposal to define an extensible layout metadata schema within the Jupyter notebook document format.
* Use the jupyter-incubator/dashboards and Anaconda-server/nbpresent metadata as a guide for what needs to be supported.

### jupyter-incubator/dashboards (0.6.0)

* Update the incubator extension to work with the new schema and deprecate support for the older `urth.layout` schema.
* Submit an enhancement proposal to graduate the project from incubator as a "classic" Jupyter Notebook extension.

### jupyter-js-plugins (>0.16.0)

* Implement a dashboard layout editor/viewer in Jupyter Lab compatible with the layout metadata schema and jupyter-incubator/dashboards use of that schema to layout dashboards.
* Improve upon the layout authoring experience afforded in the "classic" Notebook by taking advantage of the multi-view capabilities of the Jupyter Lab interface.

### jupyter/notebook (>4.2)

* Add a URL in the single user notebook server that shows a rendered dashboard given a notebook that follows the layout metadata schema.
* TBD what renderer implementation does the rendering at the URL (e.g., new Jupyter Lab code?)
* Possibly bundle the `jupyter/dashboards` extension in a Jupyter Notebook release.

### jupyter-incubator/dashboards_bundlers, jupyter-incubator/dashboards_server

* For now, continue to explore the bundling and external deployment of notebooks as dashboards in incubator (e.g., security beyond trusted users).

## nbgrader

## nbviewer
Expand Down