Reduce Schema.org jsonld for datasets with many files#12118
Draft
qqmyers wants to merge 1 commit intoIQSS:developfrom
Draft
Reduce Schema.org jsonld for datasets with many files#12118qqmyers wants to merge 1 commit intoIQSS:developfrom
qqmyers wants to merge 1 commit intoIQSS:developfrom
Conversation
Member
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
3 participants
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.
What this PR does / why we need it: At QDR, we noticed a dataset with ~10K files was not getting indexed by Google. Investigating, we say that Google was failing to read the schema.org information in the page header, apparently due to it's length.
After finding some guidance on an alternate way to provide file download URLs - https://github.com/ESIPFed/science-on-schema.org/blob/main/guides/Dataset.md#accessing-data-through-a-service-endpoint - I went ahead and implemented that approach. It essentially replaces writing a json object per file with one object and a list of fileIds which is significantly shorter.
Subsequent testing at QDR shows that this was effective in allowing Google to index that dataset again.
Which issue(s) this PR closes:
Special notes for your reviewer: posting as a draft in case people want to go forward with it while I'm out. Probably needs a release note about the new jvmoption and doc updates for it. It should probably go in the new https://guides.dataverse.org/en/latest/admin/big-data-administration.html as well.
Suggestions on how to test this: Should be able to set the flag to a low number to trigger the new format with just a few files and could then use Google's tools to verify it can parse the output (I forget which tool/the URL for it).
Does this PR introduce a user interface change? If mockups are available, please link/include them here:
Is there a release notes update needed for this change?:
Additional documentation: