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

conversation starter for introductory docs #654

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

conversation starter for introductory docs #654

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 7 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,18 @@

JupyterLab Desktop is the cross-platform desktop application for [JupyterLab](https://github.com/jupyterlab/jupyterlab). It is the quickest and easiest way to get started with Jupyter notebooks on your personal computer, with the flexibility for advanced use cases.

![JupyterLab Desktop](media/jupyterlab-desktop.png)
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is a good tight sentence. I like the screenshot early.

My thinking is, when I land on a repo for a piece of software, the software should sell the benefits first, then explain how to install. If a repo explains how to install before showing me what it does, my thought is "why do I want to go through the effort of downloading this thing , when I don't know how it helps me".

It is also worthwhile to disqualify users who will never be a match for a product early.


## Installation
![JupyterLab Desktop](media/jupyterlab-desktop.png)

If you have an existing JupyterLab Desktop installation, please uninstall it first by following the [uninstall instructions](user-guide.md#uninstalling-jupyterlab-desktop).
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can Uninstall be punted to a troubleshooting section? Or possibly the installer (more work I know)

## Who is it for?
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We want the proper user facing term that identifies which persona they are


- [Debian, Ubuntu Linux Installer](https://github.com/jupyterlab/jupyterlab-desktop/releases/latest/download/JupyterLab-Setup-Debian.deb)
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is separate work and probably requires a separate landing page... but could we setup a webpage that reads the browser user-agent and suggests/auto-starts the most relevant download. I think the benefit here is less distraction more than it is a user not knowing what OS they are on.

- [Red Hat, Fedora, SUSE Linux Installer](https://github.com/jupyterlab/jupyterlab-desktop/releases/latest/download/JupyterLab-Setup-Fedora.rpm)
- [macOS Intel Installer](https://github.com/jupyterlab/jupyterlab-desktop/releases/latest/download/JupyterLab-Setup-macOS-x64.dmg), [macOS Apple silicon Installer](https://github.com/jupyterlab/jupyterlab-desktop/releases/latest/download/JupyterLab-Setup-macOS-arm64.dmg)
- [Windows Installer](https://github.com/jupyterlab/jupyterlab-desktop/releases/latest/download/JupyterLab-Setup-Windows.exe)
- less technical users. Install Jupyter with one download and run it with a single click, no messing with environments and the command line. [Less technical user guide](./to-be-written)
- Sysadmins/IT. Do you have to setup this jupyter thing for data scientists at your organization? [Sysadmin docs](./to-be-written)
- Advanced users. Do you want a one-click way to manage your multiple jupyter lab servers running on your machine. Do you want to know about all of the advanced features and config [Advanced user guide](./to-be-written)
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's talk together to make each one of these personas a tighter more apt description.

Are there other personas that I don't know about yet?


Additionally, JupyterLab Desktop can be installed on Windows via winget: `winget install jupyterlab`.
## Auto-configured-quick-install page

Please check out the [Python Environment Customization Guide](user-guide.md#Customizing-the-Bundled-Python-Environment) if you plan to customize the Python environment to add new packages.
[Click here to install Jupyterlab Desktop](./externally-hosted-page-to-be-written)
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can take a look at writing the auto-package-selection page. Where would you want to host it? Does the source for that page live in this repo?


## Launching JupyterLab Desktop

Expand Down