Skip to content

Commit

Permalink
Merge pull request #28 from jupyter/dashboarding-section-cleanup
Browse files Browse the repository at this point in the history
Dashboard section clarifications, added detail and sequencing to graduation and post-graduation efforts
  • Loading branch information
JamieW committed Jun 1, 2016
2 parents 7f7f518 + 348e5ff commit 48eb7f3
Showing 1 changed file with 18 additions and 17 deletions.
35 changes: 18 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -352,30 +352,31 @@ is planned until Fall/Winter 2017, and passive support until mid 2019.

## Dashboarding

### jupyter/enhancement-proposals (now)
Discussed during the Spring 2016 dev meeting.

* 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)
### Graduate jupyter/dashboards from Incubator

* 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.
The [dashboards wiki](https://github.com/jupyter-incubator/dashboards/wiki) summarizes the current scope of the dashboarding effort in jupyter incubator. We discussed graduation of these assets and agreed on the following rough steps.

### jupyter-js-plugins (>0.16.0)
1. 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.
* https://github.com/jupyter/enhancement-proposals/pull/15
2. Update the incubator projects to work with the new schema and deprecate support for the older `urth.layout` schema.
* https://github.com/jupyter-incubator/dashboards/wiki/Dashboard-Metadata-and-Rendering
* https://github.com/jupyter-incubator/dashboards/issues/243
3. Submit an enhancement proposal to graduate the jupyter-incubator/dashboards project from incubator as a "classic" Jupyter Notebook extension.
* Will be submitted when [v0.6.0 is released](https://github.com/jupyter-incubator/dashboards/milestones/0.6.0)
4. For now, keep the other two dashboard projects ([jupyter-incubator/dashboards_bunders](https://github.com/jupyter-incubator/dashboards_bundlers) and [jupyter-incubator/dashboards_server](https://github.com/jupyter-incubator/dashboards_server)) in incubator to continue exploration of the bundling and external deployment of notebooks as dashboards in incubator (e.g., security beyond trusted users).

* 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.
### Dashboarding Support in Jupyter Lab

### jupyter/notebook (>4.2)
We also discussed actions to be taken post-graduation, primarily with respect to dashboarding support in Jupyter Lab. We agreed on the following rough steps.

* Add a URL in the single user notebook server that shows a rendered dashboard given a notebook that follows the layout metadata schema.
1. 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.
2. Improve upon the layout authoring experience afforded in the "classic" Notebook by taking advantage of the multi-view capabilities of the Jupyter Lab interface.
3. 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).
4. Possibly bundle the `jupyter/dashboards` extension in a Jupyter Notebook release.

## nbgrader

Expand Down

0 comments on commit 48eb7f3

Please sign in to comment.