Thanks to visit codestin.com
Credit goes to github.com

Skip to content

add blog post about mystification / overall blog structure #542

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

Merged
merged 15 commits into from
Jul 11, 2025

Conversation

jukent
Copy link
Contributor

@jukent jukent commented Jul 10, 2025

Thanks for editing the document @brian-rose @dcamron and @kafitzgerald

@jukent jukent requested review from a team as code owners July 10, 2025 15:39
@jukent jukent requested review from dopplershift, clyne and mgrover1 and removed request for a team July 10, 2025 15:39
Copy link
Contributor

github-actions bot commented Jul 10, 2025

👋 Thanks for opening this PR! The Cookbook will be automatically built with GitHub Actions. To see the status of your deployment, click below.
🔍 Git commit SHA: ba8d12c
✅ Deployment Preview URL: https://projectpythia.github.io/_preview/542

@jukent
Copy link
Contributor Author

jukent commented Jul 10, 2025

Preview link to most relevant file: https://projectpythia.org/_preview/542/posts/mystification

Screenshot 2025-07-10 at 9 44 03 AM (3) Screenshot 2025-07-10 at 9 44 21 AM (3)

@kafitzgerald
Copy link
Contributor

Not something that needs to be solved now, but I'm curious if there's a good way to add author metadata for folks who's info isn't already propagating from the upstream config.

I suppose we could add that in the MyST config for this repo, but not sure if there's an article/post level option.

@brian-rose
Copy link
Member

There is, but we should take this opportunity to add people upstream since that will simply all future posts. I'll open a PR for that.

@brian-rose
Copy link
Member

Not something that needs to be solved now, but I'm curious if there's a good way to add author metadata for folks who's info isn't already propagating from the upstream config.

I suppose we could add that in the MyST config for this repo, but not sure if there's an article/post level option.

The answer to your question is that the authors: field in the page frontmatter can have an arbitrary list of authors objects which can each contain full metadata: https://mystmd.org/guide/frontmatter#frontmatter-authors

The shortcut here is that we're just giving the id field, which has been set upstream to be identical to each person's GitHub handle. But there's no reason we couldn't mix and match short id references and full author records in the page frontmatter if we wanted to, to my knowledge.

@brian-rose
Copy link
Member

Upstream PR: ProjectPythia/pythia-config#16

once that is merged, we can regenerate the preview here and make sure everyone is showing up correctly.

Copy link
Member

@brian-rose brian-rose left a comment

Choose a reason for hiding this comment

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

Fixed some errant links here. There is also some formatting that needs fixing in the first section.

@ktyle
Copy link
Contributor

ktyle commented Jul 10, 2025

Hi from SciPy! The post is looking very nice. Note that in the list of authors, Julia needs to come after Angus to follow last-name alphabetical sorting.

kafitzgerald
kafitzgerald previously approved these changes Jul 10, 2025
Copy link
Contributor

@kafitzgerald kafitzgerald left a comment

Choose a reason for hiding this comment

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

Just a couple of minor things to take or leave. Otherwise, looks good to me (with Brian's edits).

Thanks for putting this together!

@jukent jukent requested a review from brian-rose July 10, 2025 21:08
Co-authored-by: Katelyn FitzGerald <[email protected]>
@brian-rose brian-rose closed this Jul 11, 2025
@brian-rose brian-rose reopened this Jul 11, 2025
github-actions bot pushed a commit that referenced this pull request Jul 11, 2025
@brian-rose
Copy link
Member

It turns out that MyST doesn't know how to interpret the family-names and given-names in the author yaml. I'll go fix that upstream so that @dcamron's actually appears.

Copy link
Member

@brian-rose brian-rose left a comment

Choose a reason for hiding this comment

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

I suggested some edits here that should fix the formatting in the "Motivation" section.

@brian-rose
Copy link
Member

Closing and reopening one more time to fix the authors list.

@jukent jukent changed the title add blog post about mystification add blog post about mystification / overall blog structure Jul 11, 2025
@jukent
Copy link
Contributor Author

jukent commented Jul 11, 2025

I tried a collapsible-by-year navbar and it isn't working

  toc:
    - file: index.md
    - file: about.md
    - title: Blog
      children:
        - title: 2025
          children:
            - file: posts/2025/mystification.md
            - file: posts/2025/cookoff2025-website.md
            - file: posts/2025/binderhub_status.md
            - file: posts/2025/new-cookbooks.md
        - title: 2024
          children:
            - file: posts/2024/cookoff2024-website.md
        - title: 2023
          children:
            - file: posts/2023/cookoff2024-savethedate.md
            - file: posts/2023/fundraiser.md
            - file: posts/2023/cookoff2023.md
    - file: contributing.md
    - file: cookbook-guide.md
    - file: quick-cookbook-guide.md
    - file: metrics.md

I'm not pressed on it though.

What are your thoughts on the new directory structure @brian-rose ?

Copy link
Member

@brian-rose brian-rose left a comment

Choose a reason for hiding this comment

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

I think it all looks good. We can work on improved blog navigation in a separate PR.

@mgrover1
Copy link
Contributor

I think it all looks good. We can work on improved blog navigation in a separate PR.

If you are looking for inspiration/examples, Chris Holdgraf's site uses myst and has a nice structure around it!
https://chrisholdgraf.com/blog

Here is a link to his blog post about building it
https://chrisholdgraf.com/blog/2024/mystmd-with-the-blog

@jukent
Copy link
Contributor Author

jukent commented Jul 11, 2025

Thanks for this link @mgrover1 I'll look into implementing this after this PR is merged! I was thinking of using the same type of gallery extension we use elsewhere, will look at what his method is this afternoon.

@jukent
Copy link
Contributor Author

jukent commented Jul 11, 2025

In light of our link checker being too strict - it is stalled on a call to localhost. There are many incomplete/template links in the contribution guides and elsewhere that aren't meant to be clickable.

@jukent jukent merged commit 9cf898b into ProjectPythia:main Jul 11, 2025
2 of 3 checks passed
github-actions bot pushed a commit that referenced this pull request Jul 11, 2025
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.

5 participants