Builds dynamic sitemaps that scale for your Blacklight applications.
Based on original work here: sul-dlss/SearchWorks#2351
Concept developped by: @magibney @mejackreed @agazzarini @netsensei
Add this line to your application's Gemfile:
And then execute:
$ bundle install
Or install it yourself as:
$ gem install blacklight_dynamic_sitemap
Run the install generator
$ bundle exec rails generate blacklight_dynamic_sitemap:install
This feature relies on a unique hexadecimal hash field in your solr response for each document. You can have solr automatically do this for you using the
updateRequestProcessorChain used in this project's
solrconfig.xml for an example.
This gem offers several configuration options that can be configured in a Rails initializer.
See engine.rb for available configurations.
Rails version compatibility note
Note that the gemspec does not list a lower threshold for Rails version compatibility. This gem has been anecdotally demonstrated to work fine as low as Rails 4.2, but maintaining compatibility of the test suite with rails <5.0 was more complex than practical benefits warranted. Exercise caution when using with Rails <5.0.
After checking out the repo, run
bin/setup to install dependencies. Then, run
rake ci to run the tests. You can also run
bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run
bundle exec rake install. To release a new version, update the version number in
version.rb, and then run
bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the
.gem file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/sul-dlss/blacklight_dynamic_sitemap.