Remove local link checks on translated sites
criadoperez opened this issue · 2 comments
Describe the issue
Docusaurus wont build if it has a failing link. This is a very useful feature, however it can cause an issue on the translated versions of the site.
**Example **
Let's say you have a markdown file and you decide to move it's location. You also have on another markdown file with a local link to the file you moved, so you also change that link to the new location.
This will pass the local build in English, but will fail the build in other languages. (because the link change still hasn't changed on the translated sites on Crowdin).
Note that we also normally create a redirect from the old location to the new location of the file, but this doesn't help here and still won't pass the link test.
The current workaround is to eliminate the old link but not the old file. Wait until crowdin syncs and removes the old link from the translated versions. Then merge translations changes into master. Then finally, you will be able to remove the old file and pass all the link tests (as the link wont exist in the translated versions anymore)
Log example of the error
Notice the broken link in the 'es' path.
[ERROR] Unable to build website for locale es.
[ERROR] Error: Docusaurus found broken links!
Please check the pages of your site in the list below, and make sure you don't reference any path that does not exist.
Note: it's possible to ignore broken links with the 'onBrokenLinks' Docusaurus configuration, and let the build pass.
Exhaustive list of all broken links found:
- On source page path = /es/docs/understand-stacks/testnet:
- -> linking to stacks-blockchain-api (resolved as: /es/docs/understand-stacks/stacks-blockchain-api)
Solutions
A possible solution can be to remove link checks on translated versions of the site, but there can also be other better options.
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.
This issue has been automatically closed. Please reopen if needed.