search

projectblacklight / blacklight

Blacklight provides a discovery interface for any Solr (http://lucene.apache.org/solr) index.
http://projectblacklight.org/
Other
758 stars 256 forks source link

Update quickstart documentation to use docker #2183

Open jcoyne opened 4 years ago

jcoyne commented 4 years ago

I (Bess) have started working on this as preparation for a workshop I'm teaching soon. I plan to use lando to run docker. I'll write it up as a separate document so we can talk about it. It will also necessitate a pull request to include a lando.yml file.

I think it's somewhat urgent for us to do this, since the QuickStart currently (as of Feb 21 2024) doesn't work with the latest release.

cdmo commented 4 years ago

Am I alone in thinking this would be better in the README? Having this information in the README allows for documentation to be more accurate per the version/commit it is on. (EDITED)

mjgiarlo commented 4 years ago

@jcoyne Currently, I thought the plan was to use docker for 1) CI for Blacklight, and 2) local development of Blacklight proper (not of Blacklight apps). If that is true, I don't think we want to amend the Quickstart. Unless we want Blacklight to generate docker-compose.yml for downstream apps, or we want to add docker-compose knowledge as a requirement for getting a Blacklight app up and running. cc: @cdmo

cdmo commented 4 years ago

I think it's okay to have docker-compose be the way of doing a "quick start" with Blacklight. It isn't really a "requirement" so much as a "hey here's one super easy way to get going quick" - people can use whatever they want to fulfill the stack requirements of ruby, rails, bundler and solr (homebrew or vagrant + solr_wrapper for example). Seems like docker-compose would be okay, just my $.02.

bess commented 6 months ago

I published a first draft of a blacklight_lando gem: https://github.com/bess/blacklight_lando I'm going to try it out with workshops this week and when we've got some good instructions I'll move the gem to the Blacklight organization and update the quick start to use it.