Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
Tracked by #207
jnywong opened this issue Mar 13, 2024 · 5 comments
Closed
Tracked by #207

Comments

@jnywong
Copy link
Member

jnywong commented Mar 13, 2024

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
Copy link
Member

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
Copy link
Member Author

jnywong commented Mar 14, 2024

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
Copy link
Member Author

jnywong commented Mar 20, 2024

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

@agoose77
Copy link

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
Copy link
Member Author

jnywong commented Mar 21, 2024

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

@jnywong jnywong closed this as completed Mar 21, 2024
@jnywong jnywong closed this as not planned Won't fix, can't repro, duplicate, stale Mar 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants