Skip to content

Commit

Permalink
Separate the notebook roadmap into jupyterlab
Browse files Browse the repository at this point in the history
  • Loading branch information
blink1073 committed Dec 13, 2016
1 parent a21c711 commit 946ab16
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 48 deletions.
45 changes: 45 additions & 0 deletions jupyterlab.md
@@ -0,0 +1,45 @@
## JupyterLab

## Beta Release
* Flexible, customizable tabbed and paneled layout system.
* All of JupyterLab will be a set of plugins that exchange runtime APIs.
* Initial plugins:
- Menu bar.
- Overall page layout.
- File browser.
- Text editor.
- Terminal.
- Notebook.
- Console.
* Application infrastucture (keyboard shortcuts, commands, menus, layout), view
layer, and other utilities (signals, properties, messages) provided by phosphorjs
(http://phosphorjs.github.io/).
* JupyterLab now has its own GitHub organization: https://github.com/jupyterlab
* Movement towards having stable, documented JavaScript APIs.
* Usability and UX User survey to help us guide the design process of JupyterLab.
* Draggable standalone output area.
* Ability to hook kernels up to text editors.
* Cell drag and drop


## 1.0 Release
* Feature parity with the classic notebook. We are tracking notebook feature parity issues with a combination of [labels](https://github.com/jupyterlab/jupyterlab/issues?q=is%3Aopen+is%3Aissue+label%3A%22cat%3AFeature+Parity%22+label%3Acomponent%3ANotebook).
* Settings system.
* Work on porting nbextensions to JupyterLab and building the bridge layers.
* Theme switching.
* Ability to hook kernels up to output areas.


## Future
* Variable inspector.
* UI for managing plugins.
* Real-time collaboration on the notebook, text editor, and other plugins.
* Perform and publish accesibility audit by running an automated tool.
* Bring our core plugins up to the level of the Web Accessibility Standards
(http://www.w3.org/standards/webdesign/accessibility)
* Address the [2015 UX survey findings](https://github.com/jupyter/design/blob/master/surveys/2015-notebook-ux/analysis/report_dashboard.ipynb)
* Version control (via git in particular)
* Robust text and code editing (like in Emacs, Vim, Sublime, PyCharm)
* Advanced code development tools (debugging, profiling, variable watching, code modularization)
* Simpler export and deployment options (one-click transformations to slides, scripts, reports)
* Improved installation guides, usage tutorials, and within-tool help
51 changes: 3 additions & 48 deletions notebook.md
Expand Up @@ -8,37 +8,16 @@
* Restart kernel and run all.

### Next+1 (5.0)

* Prototype of *JupyterLab*:
- Initially, a new page in the existing notebook web-app that allows multiple
plugins in the same browser tab.
- Flexible, customizable tabbed and paneled layout system.
- Initial plugins:
- Menu bar.
- Overall page layout.
- File browser.
- Text editor.
- Terminal.
* All new frontend work is being done as small, loosely coupled npm packages.
* All of JupyterLab will be a set of plugins (again just npm packages)
that exchange runtime APIs.
* Application infrastucture (keyboard shortcuts, commands, menus, layout), view
layer, and other utilities (signals, properties, messages) provided by phosphorjs
(http://phosphorjs.github.io/).
* Here is a list of all the repositories in which we are developing JupyterLab:
- https://github.com/jupyter?utf8=%E2%9C%93&query=jupyter-js
* Movement towards having stable, documented JavaScript APIs.
* Usability and UX User survey to help us guide the design process of JupyterLab.
* Ability to hide/show code and entire cells based on query syntax.
* Plan for Phased JupyterLab releases:
* Plan for Phased Notebook/JupyterLab releases:
* Phase 1:
* A series of major releases starting with 5.0 that will have the existing notebook pages as the main UI with a JupyterLab button that takes people to the new JupyterLab page
* These releases may have new features in the existing notebook pages, some API changes, focus on transitioning to JupyerLab.
* These releases will have bug fixes and new features in JupyterLab designed to get JupyterLab to Phase 2.
* During this phase, we will continue to work on porting nbextensions to JupyterLab and building the bridge layers.
* Explicit that people can request help for porting extensions.
* *Criteria for transition to phase 2:*
1. Jupyter Lab has all the primary functionality of the classic notebook interface. We are tracking notebook feature parity issues with a combination of [labels](https://github.com/jupyterlab/jupyterlab/issues?q=is%3Aopen+is%3Aissue+label%3A%22cat%3AFeature+Parity%22+label%3Acomponent%3ANotebook).
1. Jupyter Lab has all the primary functionality of the classic notebook interface.
1. Jupyter Lab offers some interesting features beyond the classic interface.
1. At least some important, popular extensions are ported / bridged to Jupyter Lab.
1. Documentation and examples exist for creating Jupyter Lab plug-ins.
Expand All @@ -51,28 +30,4 @@
* Starting with the z.0 major release. will remove the existing notebook pages.
* Maybe offer the existing notebook as a server extension.

### Next+2

* New plugins for JupyterLab:
- Standalone output area.
- Ability to hook kernels up to text editors and output areas.
- Themes.

### Future

* New plugins for JupyterLab:
- Notebook.
- Variable inspector.
- UI for managing plugins.
* 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.
* Perform and publish accesibility audit by running an automated tool.
* Bring our core plugins up to the level of the Web Accessibility Standards
(http://www.w3.org/standards/webdesign/accessibility)
* Address the [2015 UX survey findings](https://github.com/jupyter/design/blob/master/surveys/2015-notebook-ux/analysis/report_dashboard.ipynb)
* Version control (via git in particular)
* Robust text and code editing (like in Emacs, Vim, Sublime, PyCharm)
* Advanced code development tools (debugging, profiling, variable watching, code modularization)
* Simpler export and deployment options (one-click transformations to slides, scripts, reports)
* Improved installation guides, usage tutorials, and within-tool help
* If, and only if, JupyterLab becomes a full replacement, deprecate existing pages in the notebook web-application.

0 comments on commit 946ab16

Please sign in to comment.