Improve local dev environment setup documentation - #7927
Conversation
506ed94 to
6585088
Compare
|
Could a maintainer please add the |
6585088 to
a1ccfb8
Compare
a1ccfb8 to
8c6b6ca
Compare
Add prerequisites table (Python >= 3.10, Node.js 22.x), two additional setup paths (pixi, pip+yarn/npm) alongside the existing mamba instructions, dev server flags for local development, and a troubleshooting guide for common issues. Preserves all original content and wording. Addresses jupyter#7701 and jupyter#7029.
8c6b6ca to
8a2a173
Compare
|
@jtpio let me know if this pr has any major issues to address - i think the language/detail is subject to your review, but the rest is something I can take care of based on your opinions |
| yarn install # or: npm install | ||
| yarn build # or: npm run build |
There was a problem hiding this comment.
Since this repo assumes jlpm to be used as the package manager, which is a pinned version of yarn, we should not mention yarn only, since it may refer to a different version.
Also npm may work, but there is no associated package-lock.json file, only one for yarn, so installing dependencies with npm may lead to unpredictable results and make the build fail.
There was a problem hiding this comment.
makes sense, let me address both
Drop the yarn/npm alternates from Option C and the troubleshooting section. The repo only ships yarn.lock, so plain yarn or npm may resolve different package versions and break the build; jlpm is the pinned yarn version installed with Jupyter Builder.
|
@jtpio i think this is ready |
Addresses #7701 and #7029.
Summary
--no-browser,--ServerApp.token='',--NotebookApp.allow_origin='*')jlpm: command not foundModuleNotFoundErrorTest plan