Better Instructions for Updating Metadata Blocks, how to handle Solr updates in PRs
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.1k
- Forks
- 564
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 29
Description
When working on #7810 it was suggested that we would benefit from outlining the process/expectations for a contributor making a metadata block update. Possible areas to add content:
- https://guides.dataverse.org/en/5.8/admin/metadatacustomization.html#updating-the-solr-schema
- https://guides.dataverse.org/en/5.8/developers/tips.html#solr
Happy to serve as a test case for this, as I've learned a lot over the last few days myself. We have another test case for these instructions coming up in #8127.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Updating the Solr Schema section in the admin metadatacustomization guide and the Solr section in the developers tips guide. Review the contributor workflow implied by issues #7810 and #8127, then document the expectations for metadata block changes and related Solr updates in pull requests. Done means both guide locations clearly explain the required process.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100