cbioportal icon indicating copy to clipboard operation
cbioportal copied to clipboard

Documentation - absolute links do not work in Github repo browser [Development issue]

Open pappde opened this issue 6 months ago • 1 comments

REPRO

  1. go to a markdown document in the repo using the github website. E.g. https://github.com/cBioPortal/cbioportal/blob/master/docs/Architecture-Overview.md
  2. note the URL path is {branchname}/docs/....
  3. click on a markdown link to another document. E.g.
[OncoKB Data Access](/deployment/integration-with-other-webservices/OncoKB-Data-Access.md)
  1. observe a 404 error as it is trying to open:
https://github.com/cBioPortal/cbioportal/blob/master/deployment/integration-with-other-webservices/OncoKB-Data-Access.md

EXPECTED

  1. it opens the correct URL with the /docs/:
https://github.com/cBioPortal/cbioportal/blob/master/docs/deployment/integration-with-other-webservices/OncoKB-Data-Access.md

NOTE

All of these links work fine in the documentation website (https://docs.cbioportal.org) since the domain name is the root. For example, following the above path, you would end up at the correct page:

https://docs.cbioportal.org/deployment/integration-with-other-webservices/oncokb-data-access/

PROPOSED SOLUTION

Changing all these links to relative should fix it so it works in both the github repo and the documentation website. E.g. since the Architecture Overview is in the root:

[OncoKB Data Access](integration-with-other-webservices/OncoKB-Data-Access.md)

pappde avatar Aug 13 '24 19:08 pappde