Skip to content

Update docs to be more informative on startup as per issue https://gi… #356

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

Merged
merged 2 commits into from
Apr 20, 2021

Conversation

cottrell
Copy link
Contributor

…thub.com//issues/351

See #351.

I built the docs but didn't seem to create a diff so I'm assuming there is some doc build in the github pipelines.

Copy link
Member

@kevin-bates kevin-bates left a comment

Choose a reason for hiding this comment

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

Hi @cottrell - thank you for the pull request - this is great information. My only comment is that I wonder if most of this belongs in the Running section: https://jupyter-kernel-gateway.readthedocs.io/en/latest/http-mode.html#running

Either that or I think we should make a point that these updates are relative only to the notebook-http mode and perhaps add an analogous entry for jupyter-websocket mode (which is the default).

Does that sound ok?

@cottrell
Copy link
Contributor Author

Yes, what is the test for the websocket mode? I can add that in.

@kevin-bates
Copy link
Member

Thank you David.

The startup output is a bit quieter...

jupyter kernelgateway --KernelGatewayApp.api=kernel_gateway.jupyter_websocket --port=10100
[KernelGatewayApp] Jupyter Kernel Gateway at http://127.0.0.1:10100

(and this option --KernelGatewayApp.api=kernel_gateway.jupyter_websocket is the default, but listed for completeness.)

You could hit the same swagger endpoint. I also like fetching the set of kernelspecs as a litmus test:

curl http://127.0.0.1:10100/api/kernelspecs

The output is a bunch of JSON that looks much better if piped through jq ( ... | jq).

@cottrell
Copy link
Contributor Author

Updated again.

Copy link
Member

@kevin-bates kevin-bates left a comment

Choose a reason for hiding this comment

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

Good stuff - thanks David!

@kevin-bates kevin-bates merged commit fd216d2 into jupyter-server:master Apr 20, 2021
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 this pull request may close these issues.

2 participants