search

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
9 stars 2 forks source link

More docs in configuration example #4

Closed cab938 closed 10 months ago

cab938 commented 10 months ago

I love that you have a docker compose with full configuration example for this!

Can we put more docs inline in this configuration example in comments?

https://github.com/educational-technology-collective/jupyterlab-pioneer/blob/main/configuration_examples/jupyter_jupyterlab_pioneer_config.py

For instance, what does the activeEvents mean vs. the logNotebookContentEvents? When would I have some things active and logged and some things not? For each of the exporters can you have a description of what it means inline with it?

mengyanw commented 10 months ago

https://github.com/educational-technology-collective/jupyterlab-pioneer/blob/283c554f7b8a7692ff5f1ea6f6c7e0fb1606d1c2/configuration_examples/all_exporters/jupyter_jupyterlab_pioneer_config.py