8000 Update conf.py to try to fix opengraph image for dev and future deployments by psobolewskiPhD · Pull Request #700 · napari/docs · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Update conf.py to try to fix opengraph image for dev and future deployments #700

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 1 commit into from
May 13, 2025

Conversation

psobolewskiPhD
Copy link
Member

References and relevant issues

Part of: #698

Description

Based on my reasoning in the issue, I think this should fix things. We only deploy to /dev or a versioned folder.
So I think the image should be in /dev and then it should be available properly.

@psobolewskiPhD psobolewskiPhD requested a review from TimMonko May 1, 2025 12:56
@github-actions github-actions bot added the documentation Improvements or additions to documentation label May 1, 2025
@TimMonko
Copy link
Contributor
TimMonko commented May 1, 2025

I think this is good, but my only worry about using dev would be that if we update it while changing the UI before cutting a new release, then the preview image will look different than stable since it will be deployed right away. But realistically, that will be rare I think, since we shouldn't update this preview image very often.

@psobolewskiPhD
Copy link
Member Author
psobolewskiPhD commented May 1, 2025

/stable is just a symlink, so that won't help.
So the question is what happens when a versioned deployment occurs.
because /0.6.0/_static exists:
https://github.com/napari/napari.github.io/tree/gh-pages/0.6.0/_static

I think for any of the unversioned pages copied into the versioned folder, it should work with that search/replace in the action. So yeah I think we would need a similar search and replace to have the opengraph links be versioned, because I don't think at the docs build level (when sphinx is writing the metadata header) any version numbers exist.

@psobolewskiPhD
Copy link
Member Author

So looking at #699 as the alternative, it's the same thing sort of.
/stable is a symlink, so right now it points to 0.6.0 and but in 0.6.1 it will point to 0.6.1 which will mean that any docs deployed with /stable/_static will have the same graphic. So right now the two options we have on the table are :

@TimMonko
Copy link
Contributor
TimMonko commented May 4, 2025

My final verdict on this is that it will best serve us for maintenance to use /dev/_static as you've proposed here. Thanks!

@TimMonko TimMonko added this to the 0.6.1 milestone May 4, 2025
@TimMonko TimMonko merged commit 776324e into napari:main May 13, 2025
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
0