jupyter_server icon indicating copy to clipboard operation
jupyter_server copied to clipboard

Updates To Contribution Documentation

Open alzaar opened this issue 3 years ago • 3 comments

Description

When setting up the local server setup, there is no documentation for connecting the front-end app to the server.

Type of change

CONTRIBUTING.rst has been modified as this contains the server setup instructions for running the server locally. Instructions have been added on the Jupyter extension (nbclassic) required for connecting the server and the front-end app. No information has been removed.

  • This change requires a documentation update

How Has This Been Tested?

Emulation of the entire local sever setup has been done a few times in order record any missing steps and no further issue was found.

alzaar avatar Dec 26 '21 12:12 alzaar

Thanks for submitting your first pull request! You are awesome! :hugs:
If you haven't done so already, check out Jupyter's Code of Conduct. Also, please make sure you followed the pull request template, as this will help us review your contribution more quickly. welcome You can meet the other Jovyans by joining our Discourse forum. There is also a intro thread there where you can stop by and say Hi! :wave:
Welcome to the Jupyter community! :tada:

welcome[bot] avatar Dec 26 '21 12:12 welcome[bot]

Codecov Report

Merging #649 (d19c031) into main (3e78339) will increase coverage by 0.09%. The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #649      +/-   ##
==========================================
+ Coverage   77.79%   77.88%   +0.09%     
==========================================
  Files         110      110              
  Lines       10465    10405      -60     
  Branches     1419     1400      -19     
==========================================
- Hits         8141     8104      -37     
+ Misses       1923     1915       -8     
+ Partials      401      386      -15     
Impacted Files Coverage Δ
jupyter_server/services/kernels/kernelmanager.py 80.63% <0.00%> (-2.54%) :arrow_down:
jupyter_server/utils.py 65.90% <0.00%> (ø)
jupyter_server/traittypes.py 68.64% <0.00%> (+6.84%) :arrow_up:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 3e78339...d19c031. Read the comment docs.

codecov-commenter avatar Dec 26 '21 12:12 codecov-commenter

Great! Thank you! I had been debugging with jupyterlab before and was completely unaware of nbclassic

Wh1isper avatar Jan 26 '22 07:01 Wh1isper

I think it would be valuable to include instructions on installing a frontend for Jupyter Server; however, I don't think nbclassic is the frontend we want to advertise here since it is a legacy frontend.

I suggest we change this to JupyterLab or Notebook v7 (currently in alpha).

Zsailer avatar Feb 16 '23 16:02 Zsailer