Browse Source

Update About and FAQ for Beta Release (#3560)

* Minor changes to About dialog.

* Initial work on FAQ

* Update FAQ and About for Beta release.

* Address review comment and move to Beta 1

* Lowercase beta when not a proper noun
Brian E. Granger 7 years ago
parent
commit
54fad58e20

+ 43 - 24
packages/faq-extension/faq.md

@@ -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:

+ 3 - 3
packages/help-extension/src/index.ts

@@ -308,8 +308,8 @@ function activate(app: JupyterLab, mainMenu: IMainMenu, palette: ICommandPalette
       // Create the header of the about dialog
       let headerLogo = h.div({className: 'jp-About-header-logo'});
       let headerWordmark = h.div({className: 'jp-About-header-wordmark'});
-      let release = 'beta release';
-      let versionNumber = `version: ${info.version}`;
+      let release = 'Beta 1 Release';
+      let versionNumber = `Version ${info.version}`;
       let versionInfo = h.span({className: 'jp-About-version-info'},
         h.span({className: 'jp-About-release'}, release),
         h.span({className: 'jp-About-version'}, versionNumber)
@@ -339,7 +339,7 @@ function activate(app: JupyterLab, mainMenu: IMainMenu, palette: ICommandPalette
       );
       let copyright = h.span({
         className: 'jp-About-copyright'
-      }, '© 2017 Project Jupyter');
+      }, '© 2018 Project Jupyter');
       let body = h.div({ className: 'jp-About-body' },
         externalLinks,
         copyright

+ 4 - 7
packages/help-extension/style/index.css

@@ -30,9 +30,6 @@
 
 .jp-About-body {
   display: flex;
-  font-family: var(--jp-ui-font-family);
-  /* This is needed so that all font sizing of children done in ems is
-   * relative to this base size */
   font-size: var(--jp-ui-font-size1);
   color: var(--jp-ui-font-color1);
   text-align: left;
@@ -55,8 +52,9 @@
 
 
 .jp-About-version-info {
-  color: var(--md-grey-600);
-  font-size: var(--jp-ui-font-size2);
+  color: var(--jp-ui-font-color1);
+  /* Dialog-header sets the font size to 3, we reset to 1 */
+  font-size: var(--jp-ui-font-size1);
   width: 200px;
   font-weight: 400;
   letter-spacing: .4px;
@@ -73,7 +71,6 @@
 
 .jp-About-release, .jp-About-version {
   display: block;
-  color: var(--jp-ui-font-color0);
 }
 
 
@@ -99,7 +96,7 @@
 
 .jp-About-copyright {
   position: relative;
-  bottom: -48px;
+  bottom: -44px;
 }