Skip to content

Commit 2243acf

Browse files
committed
Add orientation comments to yarn config files
1 parent 329c794 commit 2243acf

File tree

3 files changed

+13
-3
lines changed

3 files changed

+13
-3
lines changed

labextension/.yarnrc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
# jlpm in JupyterLab 2 and 3 is yarn 1, and this is a yarn 1 compatible
2+
# configuration file.
3+
#
4+
# Config reference: https://classic.yarnpkg.com/lang/en/docs/yarnrc/
5+
#
16
disable-self-update-check true
27
ignore-optional true
38
network-timeout "300000"

labextension/.yarnrc.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
# jlpm in JupyterLab 4 is yarn 3, and this is a yarn 2+ compatible configuration
2+
# file.
3+
#
4+
# Config reference: https://yarnpkg.com/configuration/yarnrc
5+
#
16
nodeLinker: node-modules
27
httpTimeout: 300000
38
npmRegistryServer: "https://registry.npmjs.org/"

labextension/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ configured server processes managed by the python package `jupyter-server-proxy`
77

88
## Prerequisites
99

10-
- JupyterLab >=2,<4
10+
- JupyterLab >=2,<5
1111

1212
## Installation
1313

14-
For JupyterLab 3, use your preferred Python package manager to install `jupyter-server-proxy`:
14+
For JupyterLab 3+, use your preferred Python package manager to install `jupyter-server-proxy`:
1515

1616
```bash
1717
pip install jupyter-server-proxy
@@ -40,4 +40,4 @@ jupyter labextension install @jupyterhub/jupyter-server-proxy
4040
> - a download of a great deal of build assets from `npmjs.org`
4141
> - a large `webpack` build that may exhaust memory and open files handles
4242
>
43-
> **Please** consider upgrading to JupyterLab 3 before reporting issues.
43+
> **Please** consider upgrading to JupyterLab 3+ before reporting issues.

0 commit comments

Comments
 (0)