Documentation Friction Log

[Cerchie]

Homepage and Your First Local JupyterHealth Exchange Tutorial

Note

First of all, this is such a thoughtful piece of documentation so far! Really wonderful and easy to follow. Mostly my feedback is nits related to links etc.

My perspective: A software developer experienced with general app development (think Next.js, GraphQL, Kafka clients, Electron apps) who has not developed or even used JupyterHub platforms that much. MacOS user.

1. Home Page: "the #jupyter-health-software channel on 2i2c’s Slack instance" Where is this? Is there a link?
2. Home Page: "the jupyterhealth/jupyter-health-software github repository" same section, is this meant to be more than just a README or is this a placeholder?
3. Tutorials -> Your First Local JupyterHealth Exchange: Is this localhost URI meant to be clickable?
4. Tutorials -> Your First Local JupyterHealth Exchange -> Before We Start: I think pipenv is not universally installed with python and pip (I have both and I got an error) so we should include a link out to installation here, earlier than when it comes up later.
5. Tutorials -> Your First Local JupyterHealth Exchange -> Access PostgreSQL: Connecting with the default user led to permissions errors: psql -U postgres -d postgres
6. Tutorials -> Your First Local JupyterHealth Exchange -> Start Your JupyterHealth Exchange: For some reason, when I cmd+click on Mac to follow the link, I get this output:

Resource 'XMLSchema.xsd' is already loaded
System check identified no issues (0 silenced).
December 02, 2025 - 18:53:18
Django version 5.2.8, using settings 'jhe.settings'
Starting development server at http://127.0.0.1:8000/
Quit the server with CONTROL-C.

WARNING: This is a development server. Do not use it in a production setting. Use a production WSGI or ASGI server instead.
For more information on production servers see: https://docs.djangoproject.com/en/5.2/howto/deployment/
D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^[[D^

Going to localhost:8000 manually in my Chrome browser resolves the issue.

[Cerchie]

Example: Deploying JupyterHealth Exchange on Kubernetes:

For this example, I was a bit shy about using AWS resources as I didn't want to pay for an account (I believe that is required although I may be wrong here). However, I did notice a few things.

1. Example: Deploying JupyterHealth Exchange on Kubernetes: Where does the cluster.yml file go in the folder structure?
2. Example: Deploying JupyterHealth Exchange on Kubernetes: Need a how to install link for eksctl zsh: command not found: eksctl
3. Where does ingress-nginx.yaml go? Same folder as cluster.yml?
4. For " Example: Deploying JupyterHealth Exchange on Kubernetes: ->Seed the database", it says it's outdated, but is that just seeding the database or everything after it too?

[Cerchie]

Example: Open mHealth Blood Pressure Visualization

1. Example: Open mHealth Blood Pressure Visualization -> Where would the pip command be run, in a new folder? %pip install -q pandas matplotlib requests I think the % is accidentally included here.
2. Data from Open mHealth web-visualizations -> This also felt disembodied, need a main func etc to run.
3. Zooming out, as a brand-new user I might not know what this example would then have to do with JupyterHub.

[minrk]

Thanks for these reports, they are super useful!