|
@@ -1,4 +1,5 @@
|
|
|
## General
|
|
|
+
|
|
|
* [What is JupyterLab?](#What-is-JupyterLab?)
|
|
|
* [What new features does JupyterLab offer?](#What-new-features-does-JupyterLab-offer?)
|
|
|
* [How stable is JupyterLab?](#How-stable-is-JupyterLab?)
|
|
@@ -7,20 +8,31 @@
|
|
|
|
|
|
## Development
|
|
|
|
|
|
-* [How do I report a bug or provide feedback?](#How-do-I-report-a-bug-or-provide-feedback?)
|
|
|
-* [How can I contribute?](#How-can-I-contribute?)
|
|
|
-* [How can I extend or customize JupyterLab?](#How-can-I-extend-or-customize-JupyterLab?)
|
|
|
+* [How can you report a bug or provide feedback?](#How-can-you-report-a-bug-or-provide-feedback?)
|
|
|
+* [How can you contribute?](#How-can-you-contribute?)
|
|
|
+* [How can you extend or customize JupyterLab?](#How-can-you-extend-or-customize-JupyterLab?)
|
|
|
|
|
|
## General
|
|
|
|
|
|
+Welcome to the Frequently Asked Questions (FAQ) for the JupyterLab Beta 1 Release.
|
|
|
+
|
|
|
### What is JupyterLab?
|
|
|
|
|
|
-JupyterLab is a new user interface for the Jupyter Notebook, allowing
|
|
|
-users to arrange multiple Jupyter notebooks, text editors, terminals,
|
|
|
-output areas, etc. on a single page with multiple panels and tabs in
|
|
|
-one integrated application. The codebase and user-interface of JupyterLab
|
|
|
-is based on a flexible extension system that makes it easy to extend with new
|
|
|
-functionality.
|
|
|
+JupyterLab is a new user interface for Project Jupyter, allowing users to
|
|
|
+arrange multiple Jupyter notebooks, file editors, terminals, output areas,
|
|
|
+etc. on a single page with multiple panels and tabs in one integrated
|
|
|
+application. While JupyterLab looks like an IDE (Integrated Development
|
|
|
+Environment), it remains focused on the core Jupyter experience of
|
|
|
+interactive computing with data.
|
|
|
+
|
|
|
+In addition to the Jupyter Notebook, JupyterLab offers multiple models of
|
|
|
+interactive computing, including a scratchpad-like Code Console and the
|
|
|
+ability to attach kernels to any text file. JupyterLab has
|
|
|
+built-in support for many common file and output formats (CVS, PDF, Vega,
|
|
|
+Vega-Lite, Markdown, JSON, VDOM, PNG, JPEG, HTML, etc.).
|
|
|
+
|
|
|
+The codebase and user-interface of JupyterLab is based on a flexible extension
|
|
|
+system that makes it easy to extend with new functionality.
|
|
|
|
|
|
### What new features does JupyterLab offer?
|
|
|
|
|
@@ -29,18 +41,21 @@ Notebook. Here are a few of them you may want to try out:
|
|
|
|
|
|
* Arrange multiple notebooks, terminals, text files, etc. in the
|
|
|
application using drag and drop.
|
|
|
-* Run code interactively outside of a notebook in the Code Console,
|
|
|
- and connect one to a text file.
|
|
|
-* Right click on a markdown file and "Open with..." a live markdown
|
|
|
- viewer.
|
|
|
+* Run code interactively outside of a notebook in the Code Console, and
|
|
|
+ connect one to a text file.
|
|
|
+* Right click on a markdown file and "Open with..." a live markdown viewer.
|
|
|
* Double click on CSV files to view them as a nicely formatted table.
|
|
|
* Drag and drop notebook cells within a notebook or between notebooks.
|
|
|
|
|
|
+See the [JupyterLab Documentation](http://jupyterlab.readthedocs.io/en/latest/)
|
|
|
+for more detailed information about these and other features.
|
|
|
+
|
|
|
### How stable is JupyterLab?
|
|
|
|
|
|
-This beta version of JupyterLab will be characterized by:
|
|
|
+This Beta 1 version of JupyterLab is ready for you to use! Starting with this
|
|
|
+release, the JupyterLab Beta series of releases are characterized by:
|
|
|
|
|
|
-* Stable and featureful enough for daily usage by most Jupyter users.
|
|
|
+* Stable and featureful enough for daily usage.
|
|
|
* Most of the commonly used features in the classic notebook are
|
|
|
implemented.
|
|
|
* Developer APIs that are approaching stability but still undergoing
|
|
@@ -49,7 +64,9 @@ This beta version of JupyterLab will be characterized by:
|
|
|
Early in 2018, we will release the 1.0 version of JupyterLab that will
|
|
|
provide additional UI/UX improvements, features, and API stability. At
|
|
|
that point, JupyterLab should be a full featured replacement for the
|
|
|
-classic notebook - and go far beyond its capabilities.
|
|
|
+classic notebook - and go far beyond its capabilities. Between now and then
|
|
|
+we will release a series of beta releases, all of which should be stable
|
|
|
+for daily usage.
|
|
|
|
|
|
### What will happen to the classic Jupyter Notebook?
|
|
|
|
|
@@ -62,29 +79,31 @@ and the notebook document format is unchanged during this transition.
|
|
|
|
|
|
### Where is the documentation for JupyterLab?
|
|
|
|
|
|
-The documentation for JupyterLab can be found on ReadTheDocs [here](http://jupyterlab.readthedocs.io/en/latest/).
|
|
|
+The [JupyterLab Documentation](http://jupyterlab.readthedocs.io/en/latest/) can be found on ReadTheDocs.
|
|
|
|
|
|
## Development
|
|
|
|
|
|
-### How do I report a bug or provide feedback?
|
|
|
+### How can you report a bug or provide feedback?
|
|
|
|
|
|
If you find a bug or want to provide feedback, please open an issue
|
|
|
-on our [GitHub Issues page](https://github.com/jupyterlab/jupyterlab/issues).
|
|
|
+on our [GitHub Issues](https://github.com/jupyterlab/jupyterlab/issues) page.
|
|
|
|
|
|
-### How can I contribute?
|
|
|
+### How can you contribute?
|
|
|
|
|
|
We welcome other developers and designers to contribute to JupyterLab.
|
|
|
-Development of JupyterLab takes place on our [GitHub Repository](https://github.com/jupyterlab/jupyterlab).
|
|
|
+Development of JupyterLab takes place on our
|
|
|
+[GitHub Repository](https://github.com/jupyterlab/jupyterlab).
|
|
|
To get started with development, please have a look at our
|
|
|
[Contributing Guide](https://github.com/jupyterlab/jupyterlab/blob/master/CONTRIBUTING.md)
|
|
|
or chat with us on our [Gitter Channel](https://gitter.im/jupyterlab/jupyterlab).
|
|
|
|
|
|
JupyterLab is a
|
|
|
-part of Project Jupyter and follows the [Jupyter Code of Conduct](https://github.com/jupyter/governance/blob/master/conduct/code_of_conduct.md).
|
|
|
+part of Project Jupyter and follows the
|
|
|
+[Jupyter Code of Conduct](https://github.com/jupyter/governance/blob/master/conduct/code_of_conduct.md).
|
|
|
|
|
|
-### How can I extend or customize JupyterLab?
|
|
|
+### How can you extend or customize JupyterLab?
|
|
|
|
|
|
-JupyterLab consists entirely of *JupyterLab Extensions*, which are simply
|
|
|
+JupyterLab consists entirely of *JupyterLab Extensions*, which are
|
|
|
[NPM](https://www.npmjs.com/) packages that utilize the public JupyterLab
|
|
|
APIs. You can develop your own custom extensions that use these APIs to
|
|
|
extend the functionality of JupyterLab. Examples of possible extensions include:
|