Skip to content

fix .html suffix on generated urls #428

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.

Sign up for GitHub

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

Jump to bottom
Closed
cwaring opened this issue Sep 22, 2020 · 1 comment · Fixed by #634
Closed

fix .html suffix on generated urls #428

cwaring opened this issue Sep 22, 2020 · 1 comment · Fixed by #634
Assignees
@cwaring
Labels
dif/medium Prior experience is likely helpful effort/days Estimated to take multiple days, but less than a week P2 Medium: Good to have, but can wait until someone steps up

Comments

@cwaring
Copy link
Contributor

cwaring commented Sep 22, 2020

Originally posted by @cwaring in #154 (comment)

The first chunk of 404s are caused by this upstream issue in VuePress, we recently introduced local 404 checking for internal content urls #119, which requires the links to point to the .md version of the file and unfortunately it seems that the markdown link generator is hardcoding the .html suffix.

A couple of solutions to this:

  1. Patch VuePress upstream to fix this issue so that it interacts with the clean url plugin better.
  2. Revert back to using absolute path links in our docs and then do 404 checking async via another external crawler (could be more comprehensive).
  3. Remove the clean urls plugin and default to .html extensions for our docs.

The later broken links are related to how your browser refetches these metadata files on route change. These paths are relative in order to be compatible with IPFS gateway links (gateway.ipfs.io/ipfs/hash/) and if you open the page in a new window you will see the paths are correct on first load. I would like to find a better solution to this but it's a lower priority, but as we are currently not hosting these docs on IPFS (due to required server-side redirects) I could disable this for now.
@johnnymatthews johnnymatthews added dif/hard Having worked on the specific codebase is important effort/days Estimated to take multiple days, but less than a week kind/maintenance P2 Medium: Good to have, but can wait until someone steps up labels Oct 4, 2020
@cwaring
Copy link
Contributor Author

cwaring commented Nov 5, 2020

This is now an upstream fix for this issue. TODO: test and report back using our docs configuration.

@cwaring cwaring self-assigned this Nov 5, 2020
@johnnymatthews johnnymatthews added dif/medium Prior experience is likely helpful status/blocked Unable to be worked further until needs are met topic/dependencies and removed dif/hard Having worked on the specific codebase is important status/blocked Unable to be worked further until needs are met labels Nov 5, 2020
@cwaring cwaring mentioned this issue Jan 11, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@cwaring cwaring

Labels
dif/medium Prior experience is likely helpful effort/days Estimated to take multiple days, but less than a week P2 Medium: Good to have, but can wait until someone steps up
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: setup pageSuffix to remove .html links filecoin-project/filecoin-docs
2 participants
@cwaring @johnnymatthews