NCATSTranslator / Feedback

A repo for tracking gaps in Translator data and finding ways to fill them.
7 stars 0 forks source link

For the "source" link for KP-provided result edges in Translator, provide the link to the KP's definitive documentation page in the Translator readthedocs developer documentation (rather than a GitHub project area which may be kind of a dead-end for most users). #234

Closed TranslatorIssueCreator closed 2 months ago

TranslatorIssueCreator commented 1 year ago

Type: Bug Report

URL: https://ui.test.transltr.io/results?l=Alzheimer%27s&t=0&q=fa8a1e75-dd48-45cf-920c-9614e2950377

ARS PK: c3ee1172-587e-4f48-9771-fa5d1a770b97

Steps to reproduce:

Go to this translator query result: https://ui.test.transltr.io/results?l=Alzheimer%27s&t=0&q=fa8a1e75-dd48-45cf-920c-9614e2950377

Scroll down to "Tanakan" and click on "Treats" and click on the "Source" tab. Look at the hyperlink. The hyperlink goes to a GitHub repo: https://github.com/UCDenver-ccp/text-mining-provider-trapi

It might instead be better to use a link to the appropriate KP page on the readthedocs Translator documentation area. Not all KPs have pages on that documentation area yet, but presumably they will soon. For KG2, here is the KP-specific page page, as an example: https://translator-developer-documentation.readthedocs.io/en/latest/architecture/kp/rtx-kg2/

Screenshots:

saramsey commented 1 year ago

Including this as a "bug report" only so that I can include "steps to reproduce".

For the "source" link for KP-provided result edges in Translator, provide the link to the KP's definitive documentation page in the Translator readthedocs developer documentation (rather than a GitHub project area which may be kind of a dead-end for most users).

sierra-moxon commented 1 year ago

from TAQA: primary knowledge source is linked to a GitHub page - no contact page, no README, etc. At least we should send them to the official documentation from Richard. 1) no github links in infores catalog unless that's the only thing 2) short descriptions in the infores catalog for every source.

sierra-moxon commented 1 year ago

Further progress: the team met on Friday to update URLs to Translator Wiki URLs wherever possible. We also tried to give URLs to any sources that didn't already have them. Curation was captured in these spreadsheets, https://docs.google.com/spreadsheets/d/1eLaj21m8jq26-pK2JvIeFdjcv06XnOL5ugwDEGBEDus/edit#gid=1940732560 and then transferred into Biolink-Model release 3.5.0 (released on Friday), here: https://github.com/biolink/biolink-model/blob/v3.5.0/infores_catalog.yaml.