search

greenelab / word-lapse

Explore how a word changes over time
https://greenelab.github.io/word-lapse/
Other
6 stars 3 forks source link

Moves /server/data to a submodule #8

Closed falquaddoomi closed 2 years ago

falquaddoomi commented 2 years ago

This PR moves the contents of ./server/data to a submodule, specifically https://github.com/greenelab/word-lapse-models. This has a number of advantages:

  1. no surprise 20GB+ download when a naive user who's just installed git LFS clones the repo.
  2. a separate commit history for the models, with the option to sync up at a specific commit in the parent repo.
  3. easier docker deployments: the image can remain small, and doesn't need the git index from this repo to clone the data into the container at runtime and keep it up to date.

As for downsides:

  1. submodules introduce a bit more complexity when cloning if you do want the contents of the submodule, too. (Specifically, you have to pass --recursive when cloning to recursively clone submodules, but you can always clone it later.)
  2. you need an extra "sync" commit to bring the parent up to date, so there's a bit of overhead if you frequently sync the parent to the submodule's HEAD.