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

Fix links to project files that result in 404s #1251

Closed
wants to merge 1 commit into from

Conversation

npentrel
Copy link

Pull Request Description

Fix enso-org/developer-docs#32. This pull request replaces the broken relative references with absolute references.

Checklist

Please include the following checklist in your PR:

  • The documentation has been updated if necessary.
  • All code conforms to the Scala, Java, and Rust style guides.
  • All documentation and configuration conforms to the markdown and YAML style guides.
  • All code has been tested where possible.

@CLAassistant
Copy link

CLAassistant commented Oct 30, 2020

CLA assistant check
All committers have signed the CLA.

@joenash
Copy link
Contributor

joenash commented Oct 30, 2020

@npentrel to close the ➿, having a look into whether this is fixable on the jekyll side (i.e. in the handling of relative links) because that would mean docs writers don't have to change how they write the docs. However I think this is probably due to the use of this gem and it assuming that all relative links are to other docs in the static site, which is why it's failing to make good links for these build files...looking into it

@joenash
Copy link
Contributor

joenash commented Oct 30, 2020

@npentrel Ah, ok think I've got it!

jekyll-relative-links can be set to exclude certain directories and files from it's conversion in the site's _config.yml. So the files for which you've had to change the URLs to absolute here can be added to that instead, or the directory when that directory isn't root, I think.

@joenash joenash added w-docs Website: Documentation Category: External d-easy Difficulty: little prior knowledge required labels Oct 30, 2020
@npentrel
Copy link
Author

It seems you can only exclude whole files or whole directories. There's files that contain relative links to the repo and to the docs - so excluding the file would break the other links. 🤷‍♀️

@joenash
Copy link
Contributor

joenash commented Oct 30, 2020

Hmm ok. I'd like to find a solution to this that doesn't involve diving into that gem...I would prefer we do absolute paths in that case but as they're GitHub URLs, @iamrecursion's concern is that will break docs navigation in local clones.

@iamrecursion
Copy link
Contributor

Hi @npentrel! Thanks so much for this contribution! Has there been any luck fixing this on the Jekyll side?

@joenash
Copy link
Contributor

joenash commented Nov 6, 2020

This is a substantial problem on the Jekyll side. I'm going to close this for now whilst I find a way to do it, but there is a chance this could circle back round to it being easier to absolute link these things.

@joenash joenash closed this Nov 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
d-easy Difficulty: little prior knowledge required w-docs Website: Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Links to project files result in 404
4 participants