Backport PR jupyterlab#11391: Improve documentation on galata setup (jupyterlab#11400)

Co-authored-by: Frédéric Collonval <[email protected]>

Author: meeseeksmachine

MANIFEST.in

@@ -34,7 +34,7 @@ recursive-exclude jupyterlab *.js.map
 
 # Galata
 include galata/README.md
-include galata/jupyter_server_config.py
+include galata/jupyter_server_test_config.py
 include galata/*.js
 recursive-include galata/media *.*
 graft galata/src

galata/README.md

@@ -26,7 +26,7 @@ jlpm playwright install
 
 Create a Playwright configuration file `playwright.config.js` containing:
 
-```
+```js
 module.exports = require('@jupyterlab/galata/lib/playwright-config');
 ```
 
@@ -66,8 +66,8 @@ Create `jupyter_server_test_config.py` with the following content.
 from tempfile import mkdtemp
 
 c.ServerApp.port = 8888
+c.ServerApp.port_retries = 0
 c.ServerApp.open_browser = False
-c.LabApp.dev_mode = True
 
 c.ServerApp.root_dir = mkdtemp(prefix='galata-test-')
 c.ServerApp.token = ""
@@ -137,6 +137,13 @@ PWDEBUG=1 jlpm playwright test
 
 Here are the new test fixture introduced by Galata on top of [Playwright fixtures](https://playwright.dev/docs/api/class-fixtures).
 
+### baseURL
+
+- type: < string >
+
+Application base URL without `/lab`. It defaults to environment variable `TARGET_URL` or `http://localhost:8888` if nothing
+is defined.
+
 ### appPath
 
 - type: < string >

galata/jupyter_server_config.py renamed to galata/jupyter_server_test_config.py

@@ -6,6 +6,7 @@
     c.ServerApp.ip = "0.0.0.0"
 
 c.ServerApp.port = 8888
+c.ServerApp.port_retries = 0
 c.ServerApp.open_browser = False
 c.LabApp.dev_mode = True
 

galata/package.json

@@ -34,7 +34,7 @@
     "build:galata": "tsc -b",
     "build:inpage": "webpack --mode=production",
     "clean": "rimraf lib tsconfig.tsbuildinfo",
-    "start": "jupyter lab --config ./jupyter_server_config.py",
+    "start": "jupyter lab --config ./jupyter_server_test_config.py",
     "start:detached": "(jlpm run start&)",
     "test": "playwright test",
     "test:benchmark": "jlpm run test -c playwright-benchmark.config.js",