Create Website from Notebooks

[wildintellect]

@hrodmn has created some great notebooks #1 explaining and demonstrating working with eoAPI. For the most accessibility and sharing we should encase those notebooks in a Quarto or JupyterBook site to get good navigation and be able to generate a static site for Github Pages hosting.

[wildintellect]

😆 I just went to open a new ticket, apparently I had this idea - will work on it tomorrow.

[wildintellect]

I've evaluated Jupyter-Book, Myst (Myst Markdown, aka Jupyter-Book 2), and quarto.

Myst seems to be the most straight-forward for a simple site with nice continuation nav between pages by default. They otherwise all have similar features, Myst was just fewer commands and tinkering to get the site going including a github actions generator.

Commands so far - I used pixi for simplicity of local development.

pixi init
pixi add mystmd
pixi shell
myst
myst init --write-toc
# Open and edit myst.yml
myst init --gh-pages
myst start # to spin up a server and check what pages look like

[hrodmn]

The myst site in #9 looks really good - we just need to sort out how to make the static site useful when we tear down the workshop deployment. If we tear down the deployment then all of the IFrames and tile requests would not work.

After discussing with @wildintellect and @gadomski it would probably make most sense to point the docs at the permanent eoapi.dev deployment, then set up the notebook execution environment up in a way that a) no database operations are attempted, and b) the examples in the titiler-pgstac and stac-fastapi-pgstac notebooks point at a collection that exists in stac.eoapi.dev.

This might be possible to automate to some degree, but maybe we can do some hacky manual things in a gh-pages branch to make the site work.

[hrodmn]

I was thinking about how to make these notebooks usable in the website context and had this idea. What if we create a "eoapi-workshop-demo" collection with some sample sentinel-2 items which gets created at deploy time (like we upload the ecoregion table to the postgis database). Then we can have this notebook and the titiler-pgstac notebook default to use that collection but allow the user to override it. We could load this collection to the eoapi.dev STAC then the website could be set up to point at those endpoints.

[wildintellect]

@hrodmn yes that's the same rough idea I was kicking around, so that everything except for the "loading" would always work for everyone.