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

Create "What is Jupyter" page(s) + resources #8

Open
ericsnekbytes opened this issue Oct 11, 2023 · 6 comments
Open

Create "What is Jupyter" page(s) + resources #8

ericsnekbytes opened this issue Oct 11, 2023 · 6 comments

Comments

@ericsnekbytes
Copy link
Collaborator

ericsnekbytes commented Oct 11, 2023

We should create "What is Jupyter" page(s) + resources for subproject/meta documentation, as confusion about the Jupyter ecosystem is commonly observed by those working in the ecosystem:

one of the repeated pieces of feedback we've heard from groups deploying Jupyter components (JupyterLab, JupyterHub, etc.) who aren't active in the community is that it's challenging to get a unified view of "what is Jupyter" and how the components work together.

This effort can include making a set of pages + some reusable diagrams such as the Jupyter client-server architecture, etc.

@ericsnekbytes ericsnekbytes changed the title Create "What is Jupyter" page(s) Create "What is Jupyter" page(s) + resources Oct 25, 2023
@chbrandt
Copy link
Collaborator

chbrandt commented Oct 25, 2023

A current view of "Jupyter", relating the projects. As proposed in issue #16 , a diagram can feature in the page.
This page is complementary to "History of Jupyter" (issue #10 ) in the sense that here we want to explain what is directly relevant to the user today.

@manics
Copy link

manics commented Oct 25, 2023

I think it'd be helpful if this also explained some of the confusing terminology and names. For example, "notebook" can refer to both the Jupyter Notebook server, and the notebook format. JupyterHub is a server, that runs instances of jupyter-server.

@ericsnekbytes
Copy link
Collaborator Author

@manics You're absolutely right. The problems you're describing come up frequently in conversations with the community, as many people report experiencing these same points of confusion. These are all key points that should be thoroughly explained and clarified in a "What is Jupyter" document.

@chbrandt
Copy link
Collaborator

chbrandt commented Nov 7, 2023

Good point, @manics , thanks! I started addressing this issue in PR #23 . You are more than welcome to check if that's what you have in mind and suggest modifications if you have some time available.

@ericsnekbytes
Copy link
Collaborator Author

Can I steal some of this? I'm gonna open a PR to the jupyter/jupyter repo and we can collaborate more there perhaps?

@chbrandt
Copy link
Collaborator

Yes, sure

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants