Skip to content

move site configuration from myst.yml to a separate site.yml file - #312

Merged
LauraLangdon merged 3 commits into
mainfrom
add_site_yml
May 19, 2026
Merged

move site configuration from myst.yml to a separate site.yml file#312
LauraLangdon merged 3 commits into
mainfrom
add_site_yml

Conversation

@virginiascarlett

Copy link
Copy Markdown
Collaborator

As discussed in #307, I am testing putting the Sustainability Playbook in a separate repo, and then configuring the playbook repo to inherit certain HTML assets (favicon, footer, etc.) from the core site. This workflow is based on the workflow used by the JupyterBook project, described here (https://jupyterbook.org/blog/posts/2026/multi-repo).

I'd be happy to explain why I think this is a better choice than sticking it on the main website, and happy to discuss. It's actually live right now at https://ucospo.net/playbook. (Obviously, this is an "unlisted" link; you can only find it if you type the URL in your browser.) I hope I did not overstep my bounds by creating it; we can delete it/take it down if you don't like it.

In order to test out the inheritance thing, I need to be able to point my repo's myst.yml file at just the site configuration data from your repo. Currently, that's located within the myst.yml file, but when I point my repo to your myst.yml file, I inherit everything, including your ToC--not good.

If we put ucospo.net's site config data into a separate site.yml file, and remove it from your myst.yml file, then I can point my configs to your site.yml file so that I inherit only a few assets, not absolutely everything. I made this split on a feature branch, deployed the site locally, and it worked. Your site looks exactly the same, and my site inherited your stuff. (Well, it couldn't find the images, but I think using absolute github URLs instead of local relative paths will fix that.)

This PR proposes to split the myst.yml file into two files: myst.yml and site.yml. With a separate site.yml file, I'll be able to proceed with sprucing up the playbook site.

@netlify

netlify Bot commented May 18, 2026

Copy link
Copy Markdown

Deploy Preview for ucospo-net ready!

Name Link
🔨 Latest commit 2a671a4
🔍 Latest deploy log https://app.netlify.com/projects/ucospo-net/deploys/6a0cec8f9910a20008f9b28a
😎 Deploy Preview https://deploy-preview-312--ucospo-net.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@virginiascarlett

Copy link
Copy Markdown
Collaborator Author

pre-commit.ci autofix

@LauraLangdon LauraLangdon left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems good! I have some thoughts on maybe duplicating our sidebar links in the header so that can be ported over as well, but that's not in the scope here!

@LauraLangdon
LauraLangdon merged commit 8f11616 into main May 19, 2026
7 checks passed
@LauraLangdon
LauraLangdon deleted the add_site_yml branch May 19, 2026 23:06
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

Successfully merging this pull request may close these issues.

2 participants