search

RayTracing / gpu-tracing

Ray tracing on GPU systems
https://raytracing.github.io/gpu-tracing
Creative Commons Attribution 4.0 International
105 stars 7 forks source link

Feat: Site deployment #9

Closed KorigamiK closed 5 months ago

KorigamiK commented 5 months ago

Really appreciate the work you put into the book. But as of now users are not able to see the draft deployed, so I have created a workflow with some fixes to deploy the site to github-pages. Please look at the commit messages for the changes.

Once merged the site would look something like this: https://korigamik.is-a.dev/gpu-tracing/ but on the main repo which would be https://raytracing.github.io/gpu-tracing.

Cheers!

hollasch commented 5 months ago

Is there an associated issue I can look at that explains the reason for static site deployment? The whole point of Markdeep is that it should not require any static site deployment. An index.html and GitHub pages setup is all you need.

hollasch commented 5 months ago

By the way, one important goal of the RTW project is that users can create a local clone and start browsing the content immediately and locally without requiring any sort of static site generator infrastructure.

KorigamiK commented 5 months ago

By the way, one important goal of the RTW project is that users can create a local clone and start browsing the content immediately and locally without requiring any sort of static site generator infrastructure.

You're right, and I was introducing more complexity than needed. The latest changes can deploy the site through the dev branch itself without using actions. However, changes that are made here would still be necessary for deployment.

Please feel free to change the content of the index.html file, I've added a little intro to it.

hollasch commented 5 months ago

changes that are made here would still be necessary for deployment.

No, they're not necessary. We host the Ray Tracing in One Weekend site and all books via GitHub pages without any deployment process. That's the joy of Markdeep.

KorigamiK commented 5 months ago

I've removed static site generation. Github pages work fine without deployment now. You can review the changes.

hollasch commented 5 months ago

I'm heading out for now, but will review these later. Or @armansito, feel free to merge and we can iterate further if necessary.

hollasch commented 5 months ago

I'll make the corresponding updates to the RTW book.css later as well.

hollasch commented 5 months ago

I have a query out to Morgan asking why the <!DOCTYPE html> tag is not suggested for the standard Markdeep preamble.

Regarding the Markdeep version we use, we always prefer the latest, but add a reference to the snapshotted library included in the project as a backup in case you're reading the document offline. We should not remove the latest library preference.

hollasch commented 5 months ago

Ref https://github.com/RayTracing/raytracing.github.io/issues/1566

KorigamiK commented 5 months ago

@armansito sounds good, the static site should work on enabling gh-pages on the dev branch now. Squashing and merging this pr would be best.

KorigamiK commented 5 months ago

@hollasch if you are already in conversation with Markdeep, you should also request to add crossorigin="anonymous" attribute to the script tags of all the templates.

armansito commented 5 months ago

The site is now deployed at https://raytracing.github.io/gpu-tracing.