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

Add support for composing MyST configurations #1123

Open
agoose77 opened this issue Apr 17, 2024 · 1 comment
Open

Add support for composing MyST configurations #1123

agoose77 opened this issue Apr 17, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@agoose77
Copy link
Collaborator

Proposal

In a meeting with @rowanc1, it was mentioned that journals might wish to define base configurations that e.g. set attribution information. Rowan also pointed out the value to satellite-like organisations such as 2i2c's community work to define a "base" set of acronyms, glossaries, or other features and have derived MyST projects inherit them.

I think this feature has pertinence to Jupyter Book 2's configuration, which may be as simple as defining a base JB set of defaults.

We should consider a new field in the configuration, e.g. overlays or composes that defines a set of URIs that resolve to configuration files.

Whether JB 2 still chooses its own jupyter-book.yaml that abstracts this mechanism remains to be seen.

@agoose77 agoose77 added the enhancement New feature or request label Apr 17, 2024
@choldgraf
Copy link
Member

choldgraf commented Apr 18, 2024

Oooh yes this is great - this would I think solve the internationalization issues. I also think it leans into the MyST idea of "one source of truth" applied to the config layer.

For one example, I could see 2i2c using this to configure standardized navigation links across all of its websites by defining them in one repository, and re-using them in others.

I like the idea that a Jupyter Book specific config is effectively using this feature as a starting point, and letting users specify their own config (or overrides) in addition.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants