-
Notifications
You must be signed in to change notification settings - Fork 50
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 information about the identifiers used by Mondo to the README #7478
Add information about the identifiers used by Mondo to the README #7478
Conversation
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 content is correct and very much appreciated, but it needs to go into the "Mondo user guide". I can only find an editors guide and a developer guide.
@nicolevasilevsky What would be the best place to put such content? Should we start building a "user guide"?
on our readthedocs documentation, we actually have a "user's corner" on the left hand nav, but I have my doubts if many users know that is there. Screenshot pasted below I've always thought the website was meant to be more of the user documentation. But then there was talk at some point about merging the website and the readthedocs site, which I am in favor of. I think a more prominent users guide is a great idea. At C-Path, we are going to have a week-long hackathon in a few weeks where we are going to focus on documentation. Maybe Mondo should consider a 1 or 2 day hackathon to focus on revising + updating documentation and aggregating and reorganizing all of the docs? |
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.
small change requested
My FHIR RDF colleagues pointed out one other thing I missed in addition to Trish's feedback:
|
I've updated this PR add an 'Identifiers' page to the Mondo User Guide -- I'm not sure what other content would make sense on that page, but if this approach makes more sense than adding this paragraph to the README, then that would be fine by me too! |
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.
Lets merge this and reconsider it during our Mondo documentation hackathon in June!
when is the hackathon in June? |
No date yet. |
That sounds good to me, but of course I don't get a vote :) |
@gaurav thank you for your patience and contribution here! Really sorry it took so long! We highly appreciate any further suggestions as well :) |
I noticed that the information on constructing a Mondo identifier is currently located in two places:
"http://purl.obolibrary.org/obo/" IDSPACE "_" LOCALID
should be used.I really like how the LOINC User Guide (in section 12.7.2) clearly describes how to construct an RDF URI for a LOINC concept, and I think it would be great to include this information in Mondo's documentation somewhere.
In this PR I propose a short paragraph on the main README page in a new section entitled "Identifiers" that would contain this information. If there is a better place to place this document (e.g. the editor's guide linked to above), let me know and I'll make a PR to target that file itself. Feel free to change my proposed wording or move it another file if that would be better.