Hyku update starting docs#1214
Merged
Merged
Conversation
Point teammates at docs/local and .env.local.mac.example, call out Sidekiq env vars early, cache Solr under tmp/ for faster restarts, and add a Markdown docs style rule for readable previews.
Strip Hyku's legacy thread_safe Redis option so Sidekiq 7 can boot, and document Solr-ready checks before seeding.
Make fcrepo_wrapper_compat unpack Solr with rubyzip 3, document Redis thread_safe preload for Rails seed/server, and set SOLR_* localhost defaults so db:seed does not hit Docker hostnames.
Fix RuboCop on local Solr/Sidekiq shims so CI can merge this docs branch cleanly.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/local/into a junior-friendly, no-Docker Hyku setup path (dependency pages, start-services / start-test-services, run-the-app, env, troubleshooting).config/fcrepo_wrapper_compat.rb, rubyzip 3 extract) and Sidekiq Redisthread_safestrip (config/sidekiq_redis_compat.rb) for Ruby 3.3 / Sidekiq 7..env.local.mac.examplefor localhost Solr,HYKU_CACHE_ROOT, and Sidekiq; documents that Hykudb:seeddoes not create sample works..solr_wrapper), refreshesyarn.lock/.gitignore, and adds a markdown docs Cursor rule.Test plan
docs/local/README.mdon a clean Mac: deps → env → start-services →db:setup→ open http://localhost:3000RUBYOPT="-r./config/fcrepo_wrapper_compat"and unpacks undertmp/solr-development(not./var/folders/...)db:seedwork withRUBYOPT="-r./config/sidekiq_redis_compat"(nounknown keyword: :thread_safe)HYKU_CACHE_ROOTset (noErrno::EROFS/ mkdir/app)INITIAL_ADMIN_*