search

ukri-excalibur / excalibur-tests

Performance benchmarks and regression tests for the ExCALIBUR project
https://ukri-excalibur.github.io/excalibur-tests/
Apache License 2.0
18 stars 15 forks source link

[docs] Exclude unrelated files #293

Closed giordano closed 6 months ago

giordano commented 6 months ago

apps/ and post-processing/ are symlinks to the directories in our repository, with the result the website includes all the files in them.

giordano commented 6 months ago

Our website currently bundles all files in apps/ and post-processing, with the result the entire website has a size of whopping 39.2 MiB. Instead with this PR the entire website, including the preview for the current PR, is 39.9 MiB, which means the website in the preview is only 0.7 MiB, instead of 39.2 MiB.

giordano commented 6 months ago

An alternative is to selectively symlink the README.md files for each individual benchmark, but that'd add an extra step to adding a new benchmark.

tkoskela commented 6 months ago

The Details link on the Documentation deployed action seems to have broken

giordano commented 6 months ago

Right, because that's a Python script, not a bash one 😅 Will fix it.

giordano commented 6 months ago

Fixed, now the link should be correct again. For reference, it's https://ukri-excalibur.github.io/excalibur-tests/preview/PR293/

giordano commented 6 months ago

We might also want to squash the history of the gh-pages branch at some point, so that we forget about the files that had been checked in.

giordano commented 6 months ago

New website is only 691 KiB, and this diff shows all the deleted files 🙂