-
Notifications
You must be signed in to change notification settings - Fork 495
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add 3d objects metadata block #11167
base: develop
Are you sure you want to change the base?
Conversation
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some feedback.
scripts/api/update-datasetfields.sh
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this update-datasetfields.sh used anywhere? I don't think so, based on the history: https://github.com/IQSS/dataverse/commits/4b94bf56aed2b1f5aae2762cd6a454964bed6bbe/scripts/api/update-datasetfields.sh
Should we simply delete this script? @sekmiller you added it in 1787fc7. Are you (or anyone reading this) actively using it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I checked with @sekmiller and he's not using it. I'm asking in Slack as well: https://iqss.slack.com/archives/C010LA04BCG/p1738082204798969
I say we git rm
it. 🔥
This feature adds a new Metadata block for describing 3D Object Data | ||
|
||
The new Metadata block will be added during the installation or upgrade of Dataverse |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This feature adds a new Metadata block for describing 3D Object Data | |
The new Metadata block will be added during the installation or upgrade of Dataverse | |
### New 3D Object Data Metadata Block | |
A new metadata block has been added for describing 3D object data. You can download it from the [guides](https://dataverse-guide--11167.org.readthedocs.build/en/11167/user/appendix.html). See also #11120 and #11167. | |
All new Dataverse installations will receive this metadata block by default. We recommend adding it by following the upgrade instructions below. | |
## Upgrade Instructions | |
TODO: local 3d block, update schema, etc. |
As I wrote below, I don't think update-datasetfields.sh is actively used and I'm not sure why we're maintaining it. There's no magic to do all the updating (especially including the Solr schema) so we have to write it out. Some suggestions are below.
In a GitHub suggestion I can't add fenced code blocks so I'm just going to post verbatim the 6.4 part I think we need to add and tweak. We need to change citation to 3dwhatever and otherwise edit this and add it where I'm putting TODO:
6. Update metadata blocks
These changes reflect incremental improvements made to the handling of core metadata fields.
wget https://raw.githubusercontent.com/IQSS/dataverse/v6.4/scripts/api/data/metadatablocks/citation.tsv
curl http://localhost:8080/api/admin/datasetfield/load -H "Content-type: text/tab-separated-values" -X POST --upload-file citation.tsv
7. Update Solr schema.xml file. Start with the standard v6.4 schema.xml, then, if your installation uses any custom or experimental metadata blocks, update it to include the extra fields (step 7a).
Stop Solr (usually service solr stop
, depending on Solr installation/OS, see the Installation Guide).
sudo service solr stop
Replace schema.xml
wget https://raw.githubusercontent.com/IQSS/dataverse/v6.4/conf/solr/schema.xml
sudo cp schema.xml /usr/local/solr/solr-9.4.1/server/solr/collection1/conf
Start Solr (but if you use any custom metadata blocks, perform the next step, 7a first).
sudo service solr start
7a. For installations with custom or experimental metadata blocks:
Before starting Solr, update the schema to include all the extra metadata fields that your installation uses. We do this by collecting the output of the Dataverse schema API and feeding it to the update-fields.sh
script that we supply, as in the example below (modify the command lines as needed to reflect the names of the directories, if different):
wget https://raw.githubusercontent.com/IQSS/dataverse/v6.4/conf/solr/update-fields.sh
chmod +x update-fields.sh
curl "http://localhost:8080/api/admin/index/solr/schema" | sudo ./update-fields.sh /usr/local/solr/solr-9.4.1/server/solr/collection1/conf/schema.xml
Now start Solr.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@stevenwinship two things.
I accidentally put a typo in your release note snippet. I said "local 3d block" when I meant "load".
More importantly, can you please take the instructions above (about loading the block and messing with Solr) and massage them into the release note snippet? QA/devops will need them when upgrading dataverse-internal, beta, demo, and eventually production. It doesn't have to be perfect but QA should be able to follow it and give feedback.
Co-authored-by: Philip Durbin <[email protected]>
Co-authored-by: Philip Durbin <[email protected]>
Co-authored-by: Philip Durbin <[email protected]>
Co-authored-by: Philip Durbin <[email protected]>
This comment has been minimized.
This comment has been minimized.
3 similar comments
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
📦 Pushed preview images as
🚢 See on GHCR. Use by referencing with full name as printed above, mind the registry name. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I haven't tested this myself but I think it's ready for QA.
📦 Pushed preview images as
🚢 See on GHCR. Use by referencing with full name as printed above, mind the registry name. |
What this PR does / why we need it: Add to the metadata blocks that ship with Dataverse a metadata block for describing 3D data
Which issue(s) this PR closes: #11120
Special notes for your reviewer:
Suggestions on how to test this: create dataverse with added 3d metadata block. Create new dataset. add 3d object block and test searching with those fields
Does this PR introduce a user interface change? If mockups are available, please link/include them here: No
Is there a release notes update needed for this change?: Included
Additional documentation: