Skip to content
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

Adds a section to describe using shortDOI service #121

Merged
merged 4 commits into from
Jan 25, 2021

Conversation

ashepherd
Copy link
Member

Adds section to Dataset guideline to show how a short DOI URL should be described. Also updated the full dataset.jsonld example with a shortDOI URL in the schema:sameAs property of a schema:PropertyValue Identifier for an original DOI.

References #120

@ashepherd ashepherd added this to the v1.2 milestone Nov 5, 2020
@ashepherd ashepherd self-assigned this Nov 5, 2020
Copy link
Collaborator

@mbjones mbjones left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall this looks great. See wording change suggested below. My only substantive comment is that I was surprised that you put the sameAs inside identifier rather than as a property of Dataset, which is where the other sameAs is located. Is that only for short DOIs, or are you proposing that we move all sameAs statements? I think they are better listed as properties of Dataset, indicating that there are multiple identifiers that should be treated as equivalent for the purposes of this Dataset.


`schema:sameAs` is used here for the following reasons:

1. It doesn't add too many more statements that might the page weight (which may impact major search engine crawlers stopping the crawl of schema.org markup).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should be: "that might increase the page weight..."

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah yeah good question. My first thought was that since shortDOI is dependent on the original DOI, the sameAs should go on the DOI directly since its an identifier. Otherwise, why not just put all identifier URIs in the sameAs on the Dataset? And maybe we should do that?

But happy to update and switch to the Dataset.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think having them in one place (all as Dataset properties) makes the whole thing easier to process. Otherwise we have a sameAs that makes an instance of Identifier equivalent to an instance of Dataset.

Copy link
Member Author

@ashepherd ashepherd Nov 5, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't the short DOI an Identifier, not a Dataset? it seems strange to make this equivalence on behalf of harvesters to me. i must be misundertanding something though. my brain ain't working today

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah, i see what you are saying. just resolved the schema.org fo rthe short DOI again, and it does come back types as Dataset. ok, cool. i'll change it here. sorry!

@mbjones
Copy link
Collaborator

mbjones commented Jan 4, 2021

Looks good to me, thanks for the changes.

@mbjones mbjones linked an issue Jan 22, 2021 that may be closed by this pull request
@mbjones
Copy link
Collaborator

mbjones commented Jan 22, 2021

@ashepherd I think this short DOI support looks good now, and I tested it in the JSON-LD playground and it worked well. So, unless there are other reviews, I think we can go ahead and merge this PR. If nobody comments tomorrow, I will go ahead and do so.

@ashepherd ashepherd merged commit 3eb8508 into develop Jan 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

How to reference a Short doi?
2 participants