Cannot add contents to Jupyter Gallery

[kcpevey]

Context

I'm trying to get a repo deployed on Jupyter Gallery but even the simplest configuration isn't working.

          hub:
            extraConfig:
              99-gallery-manager.py: |
                c.GalleryManager.title = "JATIC Gallery"
                c.GalleryManager.destination = "jatic-gallery"
                c.GalleryManager.exhibits = [
                    {
                        "git": "https://github.com/Kitware/nrtk.git",
                        "homepage": "https://nrtk.readthedocs.io/",
                        "title": "NRTK",
                        "description": "Generating realistic perturbations to evaluate the natural robustness of computer vision algorithms",
                    }
                ]

JupyterHub deployed fine and I can still do things on the platform, but this juptyer gallery entry is not present on JHub. There is likely an error in the logs somewhere.

Value and/or benefit

People can use a tool that we "support"

Anything else?

No response

[viniciusdc]

Got the gallery rendering exhibits. The fix is where the config lives.

c.GalleryManager.exhibits has to be set in the singleuser server's config, e.g. a file on the Jupyter config path like /etc/jupyter/jupyter_gallery_config.py. Setting it in jupyterhub.hub.extraConfig (what the original report does, and what our internal deployment does too) runs it in the hub process. GalleryManager only exists in the singleuser server, so the hub-side assignment is never applied and the tab comes up empty.

          singleuser:
            # jhub-apps gallery (jupyterlab-gallery): GalleryManager runs in the
            # SINGLEUSER server, so inject its config into jupyter_server_config.d
            # via z2jh extraFiles (additive - does NOT clobber the chart's own
            # singleuser extraVolumes). This is the workaround for issue #134
            # (which put GalleryManager under hub.extraConfig - the hub never
            # reads it).
            extraFiles:
              gallery-config:
                mountPath: /etc/jupyter/jupyter_gallery_config.py
                stringData: |
                  c.GalleryManager.title = "Tutorials"
                  c.GalleryManager.destination = "tutorials"
                  c.GalleryManager.exhibits = [
                      {
                          "title": "3D Visualization with PyVista",
                          "git": "https://github.com/pyvista/pyvista-tutorial.git",
                          "homepage": "https://github.com/pyvista/pyvista-tutorial",
                      },
                      {
                          "title": "Xarray",
                          "git": "https://github.com/xarray-contrib/xarray-tutorial.git",
                          "homepage": "https://github.com/xarray-contrib/xarray-tutorial",
                      },
                  ]

Verified on a live AWS deploy (ds-pack 0.1.0-alpha.16, singleuser image on JupyterLab 4.6.0): dropping the same c.GalleryManager.exhibits block into /etc/jupyter/jupyter_gallery_config.py in the singleuser pod and respawning makes the exhibits appear. {title, git, homepage} items render with no extra keys.

One thing still open, separate from this: clicking pull on an exhibit fails with net::ERR_INCOMPLETE_CHUNKED_ENCODING on /jupyterlab-gallery/pull. That looks like the gateway cutting the streaming clone response rather than a gallery-config problem, so I'm treating it as its own thread.

Docs follow-up worth doing: a short note in the ds-pack docs that gallery exhibits go in jupyter_gallery_config.py on the singleuser config path, not hub.extraConfig (the latter silently no-ops in a z2jh setup, which is the trap here). Better still would be a first-class gallery.exhibits values key so deployers don't have to hand-roll the singleuser config file. I can open that PR.

[kcpevey]

I tried this exact snippet, but it didn't work. This is on an internal cluster I can give you access to.