Skip to content

Fixing docs broken link #2657

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

Closed
wants to merge 1 commit into from
Closed

Conversation

chethanuk
Copy link

Description

Related Issues

  • Fixes #...
  • Closes #...
  • Resolves #...

Additional Context

Copy link

netlify bot commented May 17, 2025

Deploy Preview for dlt-hub-docs ready!

Name Link
🔨 Latest commit f0d4614
🔍 Latest deploy log https://app.netlify.com/projects/dlt-hub-docs/deploys/6828d7bb40f85c0008987bab
😎 Deploy Preview https://deploy-preview-2657--dlt-hub-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@burnash burnash self-assigned this May 18, 2025
@burnash
Copy link
Collaborator

burnash commented May 18, 2025

Hi @chethanuk, thank you for spotting this. From what I can see the issue here is different, it appears to be an issue with Docusaurus or docs deployment: the link is only broken when there's a trailing slash in the URL path.

E.g. :

I'll take a closer look at the config to see what's wrong.

@sh-rp
Copy link
Collaborator

sh-rp commented Jun 5, 2025

@chethanuk the problem here is that we are using a relative link in the url and it resolves differently depending on a trailing slash on the alert page as @burnash mentioned. The correct fix would be to turn this into an absolute url, relative to the base url of the docs page, but not to link to the python file. Let me know if you'd like to change this, otherwise I'd close this PR.

@sh-rp
Copy link
Collaborator

sh-rp commented Jun 5, 2025

Hi @chethanuk, thank you for spotting this. From what I can see the issue here is different, it appears to be an issue with Docusaurus or docs deployment: the link is only broken when there's a trailing slash in the URL path.

E.g. :

* https://dlthub.com/docs/running-in-production/alerting - "examples" links properly

* https://dlthub.com/docs/running-in-production/alerting/ - "examples" is not found.

I'll take a closer look at the config to see what's wrong.

I don't think this is a big problem. All the internal links resolve to pages without the trailing slash as far as I can see, so this case should not happen very often?

@burnash
Copy link
Collaborator

burnash commented Jun 10, 2025

All the internal links resolve to pages without the trailing slash as far as I can see, so this case should not happen very often?

I suspect this is may be either external links or search traffic. Somehow people get into a page with a trailing slash.

@burnash
Copy link
Collaborator

burnash commented Jun 12, 2025

Closing this for now.

@burnash burnash closed this Jun 12, 2025
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

Successfully merging this pull request may close these issues.

3 participants