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

Links to project files result in 404 #32

Open
radeusgd opened this issue Jul 29, 2020 · 1 comment
Open

Links to project files result in 404 #32

radeusgd opened this issue Jul 29, 2020 · 1 comment
Labels
Type: Bug A bug in the docs site

Comments

@radeusgd
Copy link
Member

General Summary

We sometimes link to source files directly (in contrast to linking to documentation files), for example when mentioning some project configuration files.

These links do not work currently in the documentation (but they work correctly when viewed on GitHub). It would be great if they would also work in the docs, probably linking to the source code in the main branch.

Steps to Reproduce

  1. Go to https://dev.enso.org/docs/enso/CONTRIBUTING.html#system-requirements
  2. Click on the build.sbt link

Expected Result

I see the file contents of build.sbt file.

Actual Result

Nothing happens at all, if I open it in a new tab I get a 404 error.

@joenash
Copy link
Contributor

joenash commented Oct 30, 2020

Just to note that this is a result of jekyll-relative-links and submodules: jekyll-relative-links converts our relative links to work with the output of static site generation, but we don't actually pull in these project files to the static site, so it's generating links that don't exist.
This PR fixes it by changing those links to absolute ones. But another approach would be to excluse those links from the jekyll-relative-links config, I think, I'm not 100% how it'll work given those files don't exist in the site tree but I'm hoping it excludes just based on the strings.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Bug A bug in the docs site
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants