`Error: Broken links found!` facing on docusaurus build #3136

bhaskarhc · 2020-07-28T05:35:53Z

🐛 Bug Report

Recent build are getting failed with an below error message ,

ValidationError: themeConfig.navbar.links has been renamed as themeConfig.navbar.items

Replaced links with items on docusaurus.config.js
Again all sidebar links getting broke on docusaurus build

Build Logs

Error: Broken links found!

- Page path = /docs/dir1***/dir-2***/dir-3***:
   -> link to /<readme-file>
   -> link to /<readme-file>
   -> link to /<readme-file>
   -> link to /<readme-file>
   -> link to /<readme-file>

Note: it's possible to ignore broken links with the 'onBrokenLinks' Docusaurus configuration.

The text was updated successfully, but these errors were encountered:

slorber · 2020-07-28T09:49:21Z

@bhaskarhc broken links detection is new, and as it's shawn in the error message you can simply disable it if it's annoying to you.

However if you feel like it reports broken links while it shouldn't, I'd be interested to have more informations.

Do you have a public site, a public repo, a PR migrating your site to alpha.59?

If not, can you give us the real file structure of your site, the urls of docs that actually exist, and the navbar.items config content.

From the data you gave us, I can't check anything.

bhaskarhc · 2020-07-28T10:23:41Z

@slorber PTAL of code repo https://github.com/mayadata-io/oep-e2e/tree/master/testplan

slorber · 2020-07-28T10:46:46Z

@bhaskarhc this site is not alpha 59, can you provide me the site that produces the broken links

Also it would help if I could see the existing site hosted somewhere online

From your repo, I see 3 nav items, which one is being reported as broken?

Error: Broken links found!

- Page path = /docs/dir1***/dir-2***/dir-3***:
   -> link to /<readme-file>
   -> link to /<readme-file>
   -> link to /<readme-file>
   -> link to /<readme-file>
   -> link to /<readme-file>

Note: it's possible to ignore broken links with the 'onBrokenLinks' Docusaurus configuration.

Please give me the non-obfuscated output, I need to see the real content of this error

bhaskarhc · 2020-07-28T11:11:10Z

By seeing the Failed build logs got that links key need to Replace with items in docusaurus config .
, made replace chnages links with items in docusaurus.config and pushed [ commit changes ] (mayadata-io/oep-e2e#828) .
@slorber Whatever changes did that build is also got failed with error message of Error: Broken links found!, build logs can see here https://travis-ci.com/github/mayadata-io/oep-e2e/builds/177425701 .

bhaskarhc · 2020-07-28T11:18:55Z

@slorber
site hosted domain https://e2e.mayadata.io/docs/getstarted

slorber · 2020-07-28T12:11:04Z

@bhaskarhc thanks. I now have proper informations to reproduce this bug:

Page /docs/director/authentication/authentication contains a link to an existing doc in the same dir: [TCID-DIR-AUTH-LOCAL-ADMIN](TCID-DIR-AUTH-LOCAL-ADMIN)

But this link is reported as broken:

- Page path = /docs/director/authentication/authentication:
   -> link to /TCID-DIR-AUTH-LOCAL-ADMIN

That's what I needed, and there's definitively something wrong happening here

Note: it's possible to ignore broken links with the 'onBrokenLinks' Docusaurus configuration.

You can temporarily ignore those broken link errors, did you try this 'onBrokenLinks' setting?

bhaskarhc · 2020-07-28T12:31:21Z

In my case all links are breaking.
Didn't try brokenLink settings . I dont want to ignore any link / page / doc .

daniellavoie · 2020-07-28T12:54:35Z

Hi, I'm also encountering problems with broken link. In my case, it seems that relative path are not resolved properly

Here's a snippet of my document.

* A Reserved [RFC1918](https://en.wikipedia.org/wiki/Private_network#Private_IPv4_addresses) /24 CIDR (e.g.: `10.114.23.0/24`) as per [reference architecture](reference-architecture)

Generates this error:

- Page path = /docs/gcp/install:
   -> link to /reference-architecture

It seems that the path are now absolute and not relative.

It don't think this is a reporting issue that can be ignored with the brokenLink setting. I have the feeling that the latest version can't handle relative paths.

slorber · 2020-07-28T12:57:24Z

Yes I've noticed some strange behavior reported, will try to see where the regression comes from.

I think if you reference the docs with the .md extension it will work, but will try to get this fixed asap and publish a new version

daniellavoie · 2020-07-28T12:59:55Z

I also noticed a problem with external link references

Snippet in my document

* [5.5.0 Helm chart for Grafana](https://github.com/helm/charts/tree/master/stable/grafana)

Produces:

- Page path = /docs/grafana:
   -> link to /(https://github.com/helm/charts/tree/master/stable/grafana)

There's a weird front slash in the external URL.

daniellavoie · 2020-07-28T13:05:33Z

I'm feeding more info as this may help with the investigation. For the given url:

as per [reference architecture](reference-architecture.md)

It get resolved to http://localhost:3000/reference-architecture which is an absolute path and not a relative one. I tried without .md and I get the same result.

slorber · 2020-07-28T13:27:42Z

Yes I think there's a leading / added by mistake in relative links, will check where to remove it.

@daniellavoie for me using the .md extension does produce absolute links:

[theme](using-themes.md)
href: "/docs/next/test/using-themes"

[theme](using-themes)
href: "/using-themes"

If you don't have this behavior this is surprising.

daniellavoie · 2020-07-28T13:31:43Z

I confirm I get the same broken link with and without .md. I'll wait for the fix on the leading slash before worrying about this specific behaviour.

slorber · 2020-07-28T16:20:15Z

I have a fix ready, but @daniellavoie this is totally unrelated to how links to .md extensions are resolved, this part of the code did not change recently, so please double-check that referencing a md file path work for you (it should).

If this does not work, it's a totally different bug to report with the full details

slorber · 2020-07-28T17:41:13Z

Will be fixed in next release (probably tomorrow)

davenquinn · 2020-07-28T18:06:13Z

FYI: I cannot find any documentation on the location or signature of the onBrokenLinks config setting to disable this behavior. This should be intergrated into whatever fix you create.

slorber · 2020-07-28T18:10:07Z

https://v2.docusaurus.io/docs/docusaurus.config.js/#optional-fields

It takes 4 possible values, as documented

davenquinn · 2020-07-28T18:13:09Z

I stand corrected!

I was also able to find this in the original typescript defs, but nice work on the documentation search.

bhaskarhc · 2020-07-29T11:08:52Z

Will be fixed in next release (probably tomorrow)

@slorber is issue fixed version avaliable now ?

slorber · 2020-07-29T13:24:30Z

Hi, not yet but I will release in the next hours (unless there's a new important bug reported)

viztastic · 2020-08-08T23:40:31Z

I've just upgraded to alpha 61 and getting this error when I run npx docusaurus --version :

Tried to find where in the release notes it describes links as being renamed to items but I couldn't. Is this expected behaviour?

teikjun · 2020-08-09T09:51:25Z

@viztastic Yes, this is the expected behavior. It was renamed in alpha.59, but it was not stated explicitly in the release notes.
You can just rename links to items and it should be good :)

slorber · 2020-08-11T13:34:23Z

yes sorry it's not very visible on the changelog (should probably highlight more by editing the changelog next time) but it is in one of the PRs in the breaking changes: #2971

bhaskarhc added bug An error in the Docusaurus core causing instability or issues with its execution status: needs triage This issue has not been triaged by maintainers labels Jul 28, 2020

slorber mentioned this issue Jul 28, 2020

fix(v2): absolute Links should be automatically prefixed by baseurl #3143

Merged

slorber closed this as completed Jul 28, 2020

craicoverflow mentioned this issue Jul 30, 2020

fix(docs): ignore broken links in docusaurus aerogear/graphback#1786

Merged

Navaneeth-pk mentioned this issue Oct 4, 2021

documentation link looping ToolJet/ToolJet#852

Closed

Josh-Cena removed the status: needs triage This issue has not been triaged by maintainers label Apr 5, 2022

Juju26 mentioned this issue Oct 16, 2023

Dropdown elements of Transition not visible. fkhadra/react-toastify-doc#73

Open

adiati98 mentioned this issue Feb 3, 2024

fix: items array in OpenSauced Maintainers Guides sidebar open-sauced/docs#245

Merged

16 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`Error: Broken links found!` facing on docusaurus build #3136

`Error: Broken links found!` facing on docusaurus build #3136

bhaskarhc commented Jul 28, 2020 •

edited

Loading

slorber commented Jul 28, 2020 •

edited

Loading

bhaskarhc commented Jul 28, 2020

slorber commented Jul 28, 2020 •

edited

Loading

bhaskarhc commented Jul 28, 2020

bhaskarhc commented Jul 28, 2020 •

edited

Loading

slorber commented Jul 28, 2020

bhaskarhc commented Jul 28, 2020 •

edited

Loading

daniellavoie commented Jul 28, 2020 •

edited

Loading

slorber commented Jul 28, 2020

daniellavoie commented Jul 28, 2020 •

edited

Loading

daniellavoie commented Jul 28, 2020

slorber commented Jul 28, 2020 •

edited

Loading

daniellavoie commented Jul 28, 2020 •

edited

Loading

slorber commented Jul 28, 2020

slorber commented Jul 28, 2020

davenquinn commented Jul 28, 2020

slorber commented Jul 28, 2020

davenquinn commented Jul 28, 2020

bhaskarhc commented Jul 29, 2020

slorber commented Jul 29, 2020

viztastic commented Aug 8, 2020

teikjun commented Aug 9, 2020

slorber commented Aug 11, 2020

Error: Broken links found! facing on docusaurus build #3136

Error: Broken links found! facing on docusaurus build #3136

Comments

bhaskarhc commented Jul 28, 2020 • edited Loading

🐛 Bug Report

slorber commented Jul 28, 2020 • edited Loading

bhaskarhc commented Jul 28, 2020

slorber commented Jul 28, 2020 • edited Loading

bhaskarhc commented Jul 28, 2020

bhaskarhc commented Jul 28, 2020 • edited Loading

slorber commented Jul 28, 2020

bhaskarhc commented Jul 28, 2020 • edited Loading

daniellavoie commented Jul 28, 2020 • edited Loading

slorber commented Jul 28, 2020

daniellavoie commented Jul 28, 2020 • edited Loading

daniellavoie commented Jul 28, 2020

slorber commented Jul 28, 2020 • edited Loading

daniellavoie commented Jul 28, 2020 • edited Loading

slorber commented Jul 28, 2020

slorber commented Jul 28, 2020

davenquinn commented Jul 28, 2020

slorber commented Jul 28, 2020

davenquinn commented Jul 28, 2020

bhaskarhc commented Jul 29, 2020

slorber commented Jul 29, 2020

viztastic commented Aug 8, 2020

teikjun commented Aug 9, 2020

slorber commented Aug 11, 2020

`Error: Broken links found!` facing on docusaurus build #3136

`Error: Broken links found!` facing on docusaurus build #3136

bhaskarhc commented Jul 28, 2020 •

edited

Loading

slorber commented Jul 28, 2020 •

edited

Loading

slorber commented Jul 28, 2020 •

edited

Loading

bhaskarhc commented Jul 28, 2020 •

edited

Loading

bhaskarhc commented Jul 28, 2020 •

edited

Loading

daniellavoie commented Jul 28, 2020 •

edited

Loading

daniellavoie commented Jul 28, 2020 •

edited

Loading

slorber commented Jul 28, 2020 •

edited

Loading

daniellavoie commented Jul 28, 2020 •

edited

Loading