search

ICA-EGAD / RiC-O

ICA Records in Contexts-Ontology (ICA RiC-O) GitHub repository web pages
https://ica-egad.github.io/RiC-O/
51 stars 16 forks source link

online documentation browser #99

Closed VladimirAlexiev closed 10 months ago

VladimirAlexiev commented 10 months ago

The README says

Once you have downloaded the folder, simply open the RiC-O_1-0_documentation.html file in your browser.

But that's not a very convenient way to read the documentation, and it doesn't let people paste a link to a section they want to discuss.

Luckily, people have made servers that let you use a githib HTML file online:

https://rawgit2.com/ICA-EGAD/RiC-O/master/ontology/current-version/HTML_view/RiC-O_1-0_documentation.html

I've been using it for 10 years (eg for my pubs page https://rawgit2.com/VladimirAlexiev/my/master/index.html), so it's not going away.

Can you mention this link in the README?

florenceclavaud commented 10 months ago

Well, our target is not to make this HTML documentation on GitHub the way you can access RiC-O 1.0 specification as a human, but, when the ICA website is migrated, to load the OWL file and this HTML view to the ICA server, and make sure that the IRI is derefenced correctly. I think we will be able to do this in a few weeks. However we also decided to upload the HTML file to the GitHub repo, so that, again, the persons interested can download and browse the documentation locally. We thought it could be useful, specially when you do not have any connexion, and/or you want to give a course on the subject, etc. I am not sure it would not be confusing to provide a link to this HTML page in the Readme...

BTW I am working on some last tasks and once this is done, I will make a GitHub release, so everybody will be able to download the files more easily.

Any reactions?

VladimirAlexiev commented 10 months ago

Sure, deploying the HTML at the ICA site is better than at rawgit2. Cheers!

florenceclavaud commented 10 months ago

I am closing this issue. See also issue #100 which is open, and is about providing an access to the HTML through the ICA website.