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

Integrate wax tasks w/jekyll build or something. #73

Open
bmschmidt opened this issue May 9, 2021 · 0 comments
Open

Integrate wax tasks w/jekyll build or something. #73

bmschmidt opened this issue May 9, 2021 · 0 comments

Comments

@bmschmidt
Copy link

Is your feature request related to a problem? Please describe.

This is probably quite a difficult thing to do. But it is quite hard to continuously update a wax site right now. If a CSV or exhibit is edited, it's hard to know if those changes are getting pushed through to the final version, so it often involves:

  1. Shutting down the jekyll server
  2. Running wax:clobber (maybe--because it's not clear from the user end whether, e.g., minor changes to images will be passed through into the manifests or not) which requires a rebuild of all the derivative files.
  3. Running wax:pages
  4. Running wax:search (although I skip this in iterative development)
  5. Restarting Jekyll with a clean rebuild.

This takes 30-45 minutes on our collection.

Describe the solution you'd like

In an ideal world, I want to be able to run bundle exec wax serve which wraps jekyll serve with continuous updating of changed files

Describe alternatives you've considered

  1. Clear guarantees in the documentation about which rebuild steps are actually necessary when which files are edited. (Like--under what circumstances is it safe to keep the derivatives from a previous build?)
  2. Making my own Makefile to handle the rebuilding, since I'm not a ruby dev and don't really know how to plumb the interior of the rakefiles
  3. Fine-tuning the clobber command so that you can delete everything except the IIIF manifests. This alone would be a big help, especially in combination with 1.
  4. Porting the Wax themes to Svelte-kit instead of Jekyll to get instant hot-module-reloading based on JSON description in dev, with pretty-much identical static HTML produced only at the time of a publication build and optionally rebuilt client-side in-browser. (I have indeed seriously considered this--not saying that you should, but you asked!)

Additional context
This flurry of issues is being caused by my having borked up my open sea dragon displays somehow, and it being extremely slow to trace the flow of changes in the upstream metadata to the user-facing HTML. Nothing in there is Wax's fault, I'm pretty confident, but it would still be nice for the platform to be debuggable.

@bmschmidt bmschmidt changed the title Integrate wax tasks into continuous updating Integrate wax tasks w/jekyll build or something. May 9, 2021
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