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.

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

Add a Tour of JupyterLite #31

Open
jtpio opened this issue Apr 10, 2021 · 7 comments
Open

Add a Tour of JupyterLite #31

jtpio opened this issue Apr 10, 2021 · 7 comments
Projects

Comments

@jtpio
Copy link
Member

jtpio commented Apr 10, 2021

Using https://github.com/jupyterlab-contrib/jupyterlab-tour

This would help guide new users of the JupyterLite interface, and explain that kernels run the browser.

Also explain what the differences between notebooks and consoles are for instance.

@bollwyvl
Copy link
Collaborator

Tours are a whacking good idea, and best of all, simple ones can be encoded in JSON (jupyterlab-contrib/jupyterlab-tour#2).

Going beyond the docs for this repo, I'd definitely see making custom tours something that can be added without re-building the app, as could be enabled/built in #41.

@bollwyvl
Copy link
Collaborator

bollwyvl commented May 7, 2021

started jupyterlab-contrib/jupyterlab-tour#17

@bollwyvl
Copy link
Collaborator

bollwyvl commented May 9, 2021

That got merged, not sure release timeline, but would give us something concrete to develop #81 around.

In doing docs for that, turns out lab core has a pageConfig.json... perhaps it's worth looking into that, and divesting jupyter-config-data from jupyter-lite.json. I'm thinking any time there is a canonical file, we should use it instead of making up new things... in this case, it doesn't get loaded at runtime, but still...

@bollwyvl
Copy link
Collaborator

tour 3.0.1 landed with the settings stuff, so i'll get #94 buttoned up (just validating JSON at this point, I think) and start into #81...

@jtpio
Copy link
Member Author

jtpio commented May 18, 2021

Thanks!

Pasting the ideas mentioned in https://github.com/jtpio/jupyterlite/pull/98#issuecomment-843168648 here for visibility


Also what do you think the JupyterLite tour should cover?

Ain't that the way! Some ideas, out of order:

  • highlight the file browser icon

    • Where are my files stored?
    • JupyterLite starts with files hosted along with the application
    • You can upload new files, make copies, and change existing tiles. These are stored in your browser's localStorage or IndexDB
    • If you delete a browser file, or work in Private browsing and close your browser, it's GONE FOR REAL
      • maybe we need a trashlite?

  • hilight the file menu

    • If you've used JupyterLite before, there (should) be some things missing here
    • like Download As
    • We hope to support downloading your current JupyterLite site as an archive, though
  • For each kernel, as they grow in complexity, we may need their own tour of their notebook

    • how to import libraries
      • or in the case of pyolite, install libraries
      • and why they might not install/import properly
    • specific limitations

Will do some more thinking... also, big dummy me for not doing it when i did the settings PR, but we should be able to put tours in notebook's metadata.

@bollwyvl bollwyvl added this to Work In Progress in MVP May 22, 2021
@bollwyvl bollwyvl moved this from Work In Progress to In progress in MVP May 22, 2021
@bollwyvl bollwyvl moved this from In progress to To do in MVP May 22, 2021
@bollwyvl
Copy link
Collaborator

big dummy me

Started jupyterlab-contrib/jupyterlab-tour#29

@jtpio
Copy link
Member Author

jtpio commented Jul 23, 2021

As discussed in #287, we could have 2 different tours in JupyterLite: one for lab and one for retro.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
MVP
To do
Development

No branches or pull requests

2 participants