OBOFoundry.github.io
OBOFoundry.github.io copied to clipboard
Improve OBO Foundry website documentation of versioning
Under FAQ there is:
How should I manage my ontology using version control?
But the link provided seems to point to something quite different (and the link provided at the top of that page which does indeed contain the term 'version' seems not to be a Guide at all, but rather some sort of warning)
I was hoping to see the old Versioning guide under Legacy - Coordination but that link is dead
The FAQ links to a blog post by @cmungall: https://douroucouli.wordpress.com/2014/01/08/creating-an-ontology-project/. That's about starting a new ontology project, and that material has been superseded by the Ontology Development Kit. I agree that the blog post doesn't squarely address the question. I couldn't find the old versioning guide that you're referring to.
We should either find a better page to link to, or point to ODK materials and revise the FAQ.
The Foundry Principle 004 Versioning page is also unhelpful.
(The next blog post is on "The perils of managing OWL in a version control system", which points out difficulties using version control with OWL file formats. The most critical problem, with RDF/XML serialization, was solved a few years ago in collaboration with the OWLAPI developers.)
how about we have a single web page on the obo site for OBO-recommended ontology development tools. This could link to Protege, ROBOT, ODK (where the bulk of the detailed documentation will live). We can replace the existing FAQ entry
We have a new page at http://obofoundry.org/docs/OntologyTools
It still needs to be added to the menus.
We still need a page with (clear simple) versioning instructions Linking to a page with instructions for using PURLs BS
It should be as simple as possible but no simpler.
But we may be conflating two related but distinct issues:
- how should I manage my ontology using version control
- how should I release my ontology with versioned PURLs
The documentation on the OBO site should focus on what people should do, and link out to tutorials on the different tutorials on how to do this.
Our principle on versioning is massively under-specified http://obofoundry.org/principles/fp-004-versioning.html
see also: #1016