Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
pappde opened this issue Aug 13, 2024 · 1 comment

Comments

@pappde
Copy link
Contributor

pappde commented Aug 13, 2024

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
Copy link
Contributor Author

pappde commented Aug 13, 2024

Added PR #10938 to address the files under /deployment/customization/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant