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

Breadcrumb links should be encoded as local path not external URLs #1337

Closed
Tracked by #1667
chalin opened this issue Dec 16, 2022 · 2 comments · Fixed by #1699
Closed
Tracked by #1667

Breadcrumb links should be encoded as local path not external URLs #1337

chalin opened this issue Dec 16, 2022 · 2 comments · Fixed by #1699
Labels
Milestone

Comments

@chalin
Copy link
Collaborator

chalin commented Dec 16, 2022

Currently, links in breadcrumbs are encoded as external URLs, even if they are obviously site-local paths. This causes the following problems:

  • When working on docsy sites served from Cloud editors like those offered by GitPod. The "external" links encoded in the breadcrumbs don't actually correspond to the URL the site is served from -- which can be of the form https://1313-foo-bee-doo.ws-us79.gitpod.io.
  • External link checking is unnecessarily burdened (which leads to timeouts etc) for external links that are actually both site-local and unlikely to be invalid.

I thought that we had an issue open over this before, but can't find any. Having previously investigated this, there doesn't seem to be a hard requirement (contrary to what is state in some articles), that breadcrumb links be full URLs.

@chalin chalin added e0-minutes Effort < 60 min p2-medium labels Dec 16, 2022
@chalin
Copy link
Collaborator Author

chalin commented Feb 22, 2023

Another option is to use link-checker ignore attributes. E.g., see:

@chalin chalin added this to the 23Q4 milestone Nov 7, 2023
@chalin
Copy link
Collaborator Author

chalin commented Nov 13, 2023

@fekete-robert - funny thing, if you check the Docsy website now, the breadcrumbs are relative :)

$ curl -s https://www.docsy.dev/docs/get-started/ | perl -ne 'print $& if /<li class="?breadcrumb-item"?>.*?<\/li>/'
<li class=breadcrumb-item><a href=/docs/>Documentation</a></li>

But that's due to another issue that I'll fix shortly.

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

Successfully merging a pull request may close this issue.

1 participant