educational-technology-collective / jupyterlab-pioneer

A JupyterLab extension for generating and exporting JupyterLab event telemetry data.
https://jupyterlab-pioneer.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
11 stars 2 forks source link

Make examples MWE #6

Closed cab938 closed 11 months ago

cab938 commented 11 months ago

For our examples we should try and keep them as minimal as possible. So for the docker example, this file has lots of "extra" database stuff I think should be nuked, and just instead indicate what the five or six lines we need are:

https://github.com/educational-technology-collective/jupyterlab-pioneer/blob/main/configuration_examples/compose.yaml

I think an extra comment before each line in this file would be good too:

https://github.com/educational-technology-collective/jupyterlab-pioneer/issues/new

Also, if you change the pip command:

RUN python3.11 -m pip install --no-cache-dir --upgrade pip \
    && python3.11 -m pip install -U setuptools \
    && python3.11 -m pip install jupyterlab jupyterlab-pioneer==0.1.2

to

RUN python3.11 -m pip install --no-cache-dir --upgrade pip \
    && python3.11 -m pip install -U setuptools \
    && python3.11 -m pip install jupyterlab \
    && python3.11 -m pip install -U jupyterlab-pioneer

You should always get the latest version of the extension in place