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

need docs #26

Closed
minrk opened this issue Sep 17, 2018 · 5 comments · Fixed by #101
Closed

need docs #26

minrk opened this issue Sep 17, 2018 · 5 comments · Fixed by #101

Comments

@minrk
Copy link
Contributor

minrk commented Sep 17, 2018

This repo needs documentation for what it does and how to use it. Right now, it's not clear what starting jupyter-server gets you, or how to write an extension (e.g. turn the notebook package into an extension of this repo)

@ProximaDas
Copy link

If nobody is working on this, I can pick it up.

@blink1073
Copy link
Contributor

Hi @ProximaDas, yes, please!

@Zsailer
Copy link
Member

Zsailer commented Jun 6, 2019

I'm working on the documentation for server extensions now. Once #48 lands, writing server extensions should be much easier by inheriting from the ExtensionApp class.

I've also begun turning the notebook package into a server extension (see jupyter/notebook#4653).

@willingc
Copy link
Contributor

@Zsailer @minrk The current docs (https://jupyter-server.readthedocs.io/en/latest/) for this repo are confusing as the title is The Jupyter Notebook which is the same as the notebook docs (https://jupyter-notebook.readthedocs.io/en/stable/).

Could there be greater distinction between the two? Possibly changing the title for Jupyter-Server docs and also putting a directive at the top of each page that this is not yet a for production project.

@Zsailer
Copy link
Member

Zsailer commented Sep 26, 2019

@willingc Embarrassingly, I didn't even know we had a readthedocs page deployed live already.

Thanks for the PR! The docs are terribly behind, but something on the list of things to do soon.

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

Successfully merging a pull request may close this issue.

5 participants