docs: Add a note about jupytext and jupyter-fs compatbility

Signed-off-by: Mahendra Paipuri <[email protected]>
mwouts · Jul 7, 2024 · 303c8fb · 303c8fb
1 parent cf5395a
commit 303c8fb
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/docs/install.md b/docs/install.md
@@ -32,6 +32,17 @@ If you don't have the notebook icon on text documents after a fresh restart of y
 jupyter serverextension enable jupytext
 ```
 
+When [`jupyter-fs>=1.0.0`](https://github.com/jpmorganchase/jupyter-fs) is being used along with `jupytext`, use `SyncMetaManager` as the contents manager for `jupyter-fs` as `jupytext` do not support async contents manager which is used in default `MetaManager` of `jupyter-fs`. The `jupyter-fs` config must be as follows:
+
+```json
+{
+  "ServerApp": {
+    "contents_manager_class": "jupyterfs.metamanager.SyncMetaManager",
+  }
+}
+```
+so that `jupytext` will create its own contents manager derived from `SyncMetaManager`.
+
 ## Jupytext commands in JupyterLab
 
 Jupytext comes with a frontend extension for JupyterLab which provides pairing commands (accessible with View / Activate Command Palette, or Ctrl+Shift+C):

diff --git a/pyproject.toml b/pyproject.toml
@@ -76,6 +76,7 @@ test-external = [
   "pre-commit",
   # Interaction with other contents managers
   # Starting with jupyter-fs==1.0.0, there is SyncMetaManager available
+  # Bump to 1.0.1 once it is released which has some important bugfixes
   "jupyter-fs==1.0.0"
 ]
 # Coverage requirements