Add install script (#104)

* Add install script

* Remove link command usage

* Update basics/hello-world/README.md

Co-authored-by: Jeremy Tuloup <[email protected]>

Author: fcollonval

.github/workflows/main.yml

@@ -72,7 +72,7 @@ jobs:
       run: |
         cd ${EXAMPLE_FOLDER}
         jlpm run build
-        jupyter labextension link .
+        jupyter labextension install .
         python -m jupyterlab.browser_check
       env:
         EXAMPLE_FOLDER: ${{ matrix.example }}
@@ -140,7 +140,7 @@ jobs:
         cd advanced/server-extension
         pip install -e .
         jupyter serverextension enable --py jlab_ext_example
-        jupyter labextension link .
+        jupyter labextension install .
     - name: Check extension as dev
       if: startsWith(runner.os, 'Linux') || startsWith(runner.os, 'macOS')
       run: |
@@ -176,5 +176,5 @@ jobs:
       run: |
         jlpm build-ext
         jlpm lint:check
-        jlpm link-ext
+        jlpm install-ext
         jlpm build-jlab

README.md

@@ -17,7 +17,7 @@ git clone https://github.com/jupyterlab/extension-examples.git jupyterlab-extens
   cd basics/hello-world && \
   jlpm && \
   jlpm run build && \
-  jupyter labextension link . && \
+  jupyter labextension install . && \
   jupyter lab
 ```
 
@@ -205,12 +205,12 @@ conda env create && \
 
 ## Develop and Use the Examples
 
-### Build and Link all Examples at once
+### Build and Install all Examples at once
 
 ```bash
 jlpm
 jlpm build-ext
-jlpm link-ext
+jlpm install-ext
 jlpm build-jlab
 jupyter lab
 ```
@@ -221,14 +221,14 @@ To clean the lib folders:
 jlpm clean-ext
 ```
 
-### Build and Link one Example
+### Build and Install one Example
 
 Go to the example directory you want to install, e.g. `cd ./basics/hello-world`, and run the following commands:
 
 ```bash
 jlpm install
 jlpm run build
-jupyter labextension link .
+jupyter labextension install .
 ```
 
 Rebuild the JupyterLab application:

advanced/kernel-messaging/package.json

@@ -27,7 +27,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf lib tsconfig.tsbuildinfo",
-    "link": "jupyter labextension link . --no-build",
+    "install-ext": "jupyter labextension install . --no-build",
     "prepare": "jlpm run clean && jlpm run build",
     "eslint": "eslint . --ext .ts,.tsx --fix",
     "eslint:check": "eslint . --ext .ts,.tsx",

advanced/kernel-output/package.json

@@ -27,7 +27,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf lib tsconfig.tsbuildinfo",
-    "link": "jupyter labextension link . --no-build",
+    "install-ext": "jupyter labextension install . --no-build",
     "prepare": "jlpm run clean && jlpm run build",
     "eslint": "eslint . --ext .ts,.tsx --fix",
     "eslint:check": "eslint . --ext .ts,.tsx",

advanced/server-extension/README.md

@@ -712,8 +712,8 @@ jupyter serverextension enable --py jlab_ext_example
 jlpm
 # Build Typescript source
 jlpm build
-# Link your development version of the extension with JupyterLab
-jupyter labextension link .
+# Install your development version of the extension with JupyterLab
+jupyter labextension install .
 
 # Rebuild Typescript source after making changes
 jlpm build

advanced/server-extension/package.json

@@ -35,7 +35,7 @@
     "clean:all": "jlpm run clean:lib && jlpm run clean:labextension",
     "eslint": "eslint . --ext .ts,.tsx --fix",
     "eslint:check": "eslint . --ext .ts,.tsx",
-    "link": "jupyter labextension link . --no-build",
+    "install-ext": "jupyter labextension install . --no-build",
     "prepare": "jlpm run clean && jlpm run build",
     "watch": "tsc -w"
   },

basics/datagrid/package.json

@@ -27,7 +27,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf lib tsconfig.tsbuildinfo",
-    "link": "jupyter labextension link . --no-build",
+    "install-ext": "jupyter labextension install . --no-build",
     "prepare": "jlpm run clean && jlpm run build",
     "eslint": "eslint . --ext .ts,.tsx --fix",
     "eslint:check": "eslint . --ext .ts,.tsx",

basics/hello-world/README.md

@@ -156,8 +156,8 @@ These are the instructions on how your extension can be installed for developmen
 jlpm
 # Build Typescript source
 jlpm build
-# Link your development version of the extension with JupyterLab
-jupyter labextension link .
+# Install your development version of the extension with JupyterLab
+jupyter labextension install .
 ```
 
 The first command installs the dependencies that are specified in
@@ -166,7 +166,10 @@ components that you want to use in your project.
 
 The second step runs the build script. In this step, the TypeScript code gets
 converted to javascript using the compiler `tsc` and stored in a `lib`
-directory. Finally, the module is linked to JupyterLab.
+directory. Finally, the module is installed into JupyterLab.
+
+> There is also a `jupyter labextension link <path>` command. It can be used to
+> install packages but not consider them as extensions (more information in [that discussion](https://discourse.jupyter.org/t/about-jupyter-labextension-link-v-s-install))
 
 After all of these steps are done, running `jupyter labextension list` should
 show something like:

basics/hello-world/package.json

@@ -27,7 +27,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf lib tsconfig.tsbuildinfo",
-    "link": "jupyter labextension link . --no-build",
+    "install-ext": "jupyter labextension install . --no-build",
     "prepare": "jlpm run clean && jlpm run build",
     "eslint": "eslint . --ext .ts,.tsx --fix",
     "eslint:check": "eslint . --ext .ts,.tsx",

basics/signals/package.json

@@ -27,7 +27,7 @@
   "scripts": {
     "build": "tsc",
     "clean": "rimraf lib tsconfig.tsbuildinfo",
-    "link": "jupyter labextension link . --no-build",
+    "install-ext": "jupyter labextension install . --no-build",
     "prepare": "jlpm run clean && jlpm run build",
     "eslint": "eslint . --ext .ts,.tsx --fix",
     "eslint:check": "eslint . --ext .ts,.tsx",