2i2c-org / docs

Documentation for 2i2c community JupyterHubs.
https://docs.2i2c.org
9 stars 17 forks source link

Directive to replace custom Python, e.g. list of running hubs and feature tables #212

Closed jnywong closed 6 months ago

jnywong commented 6 months ago

Context

In my work to #207 Port existing Hub Service Guide content to Jupyter Book, I have identified that we run custom Python scripts to generate tables such as the list of running hubs and feature table.

Proposal

@agoose77 suggested that we expose the tabular data as a JSON file (which is apparently already done in this Infrastructure repo comment - docs/_static/hub-table.json is published with the docs and meant for reuse in other parts of 2i2c) and then write a directive to parse this data into a table component.

Although this issue doesn't block the work in #207, exploring this direction will help with our eventual migration to using MyST in the future.

Updates and actions

No response

choldgraf commented 6 months ago

One idea here is to use a Jupyter Notebook to trigger this execution, rather than a MyST directive. Since notebooks will execute and insert content, this should basically behave the same way.

jnywong commented 6 months ago

Yeah, we don't think this issue will block work in #207 since my plan was to execute the Python script in some way during the build process anyway.

I think what's being proposed here is to test-drive a way for us to customise MyST components for the future.

@agoose77 let's timebox this? As I said in our meeting, there's no need for you to go down the rabbit-hole on this one :)

jnywong commented 6 months ago

@agoose77 feel free to close this one if it's not a priority, since I've already found a workaround in #209 👍

agoose77 commented 6 months ago

Thanks Jenny - I was following this issue and misread the above as suggesting there was no need for a directive, hence no reply. Is that still the case? I can see a benefit to using notebook execution like this, so let me know where you settle?

jnywong commented 6 months ago

No worries! I think I am good, I'll close this one now