ncbo / bioportal-project

Serves to consolidate (in Zenhub) all public issues in BioPortal
BSD 2-Clause "Simplified" License
7 stars 5 forks source link

Create a documenation page for redirecting ontology IRIs to BioPortal #312

Open jvendetti opened 3 months ago

jvendetti commented 3 months ago

Occasionally we are asked on the support list for advice on how to get ontology IRIs to redirect to BioPortal. One user recently shared with us their solution:

... I have gotten my ontology IRIs to redirect to bioportal. The .htaccess and README files can viewed in this directory: https://github.com/perma-id/w3id.org/tree/master/neural-electronic-interface-ontology And here is a link the .htaccess file itself: https://github.com/perma-id/w3id.org/blob/master/neural-electronic-interface-ontology/.htaccess You can test the redirect with https://w3id.org/neural-electronic-interface-ontology/NEIO_0000101. Hopefully this may help others who want to do something similar in the future.

I think it would be useful to start a documentation page (on the wiki? or somewhere else?) to keep track of how others are doing this.

jvendetti commented 3 months ago

Some previous comments from @johardi on this topic:

I would suggest ... to read the implementation steps in the documentation here: https://w3id.org/ and look for an example. The example below is a good one from BioLink:

https://github.com/perma-id/w3id.org/tree/master/biolink

An excerpt from the implementation:

# vocab/ --> biolink-model/docs
RewriteRule ^vocab$ biolink-model/docs
RewriteRule ^vocab\/(.*)$ biolink-model/docs

# Rewrite Base URL
RewriteRule ^(.*)$ https://biolink.github.io/$1 [R=302]

These rules above will rewrite w3id URLs with biolink/vocab/ suffix to its actual location at https://biolink.github.io/biolink-model/docs to resolve.

Click this following link to understand its effect —> https://w3id.org/biolink/vocab/Gene.

jonquet commented 3 months ago

Totally un favor of documenting this. I have mentionned this to the team (Syphax, Bilel and Guillaume) that should complete this thread.

We are working on URI resolution right now in AgroPortal and we shall be able to propose a "get my htaccess file" button somewhere customized for the user needs and that will eventually count on AgroPortal for resolution of UI and more.

Also it will support resolution of URI insides the ontologies that are not classes or properties.

imadbourouche commented 2 months ago

We're actively working on this, taking steps forward as Clement mentioned.

Our aim is to ensure comprehensive URI resolution for all resources, including concepts, classes, properties, instances, schemes... etc where we can make human redeable URIs and also the IRI rederiction. We're making progress step by step, addressing various aspects of the resolution process. For more detailed information, you can refer to the following issues:

After this we will tackle the IRI redirection using the htacces file

For the documentation, @galviset will be informed and involved in planning this documentation page to ensure its effectiveness for the community.