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

Note: Preview docs contain link to deployed site not preview site #316

Closed
rly opened this issue Jun 26, 2024 · 0 comments
Closed

Note: Preview docs contain link to deployed site not preview site #316

rly opened this issue Jun 26, 2024 · 0 comments

Comments

@rly
Copy link
Contributor

rly commented Jun 26, 2024

A note for future reference. The preview docs site in PRs such as https://neurodatawithoutborders.github.io/nwb_hackathons/pr-preview/pr-315/ contain internal links that use the deployed site rather than the preview site. For example, the preview contains links to
https://neurodatawithoutborders.github.io/nwb_hackathons/HCK21_2024_Janelia_NDRH/ rather than
https://neurodatawithoutborders.github.io/nwb_hackathons/pr-preview/pr-315/HCK21_2024_Janelia_NDRH/

See also rossjrw/pr-preview-action#14

I'm not sure how to address that in the Jekyll config so that the preview has one base URL determined programmatically ("pr-preview/pr-315") and the deployed site has another ("/"). They both publish on the gh-pages branch.

I'm not sure how to resolve this quickly, and it's not a big deal. Just something to remember when browsing the preview docs site.

@rly rly closed this as completed Jun 26, 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

1 participant