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

Links Broken in German Quick Start #439

Open
dsanders11 opened this issue Aug 9, 2023 · 2 comments
Open

Links Broken in German Quick Start #439

dsanders11 opened this issue Aug 9, 2023 · 2 comments
Labels
area:i18n Related to website internationalization 🪲 bug Something isn't working

Comments

@dsanders11
Copy link
Member

https://www.electronjs.org/de/docs/latest/tutorial/quick-start

Links to app and BrowserWindow look to be broken only under this translation. 🤔

[WARNING] 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 = /de/docs/latest/tutorial/quick-start:
   -> linking to latest/tutorial/installation.md (resolved as: /de/docs/latest/tutorial/latest/tutorial/installation.md)
   -> linking to latest/api/app.md (resolved as: /de/docs/latest/tutorial/latest/api/app.md)
   -> linking to latest/api/browser-window.md (resolved as: /de/docs/latest/tutorial/latest/api/browser-window.md)
   -> linking to latest/api/app.md#event-ready (resolved as: /de/docs/latest/tutorial/latest/api/app.md)
   -> linking to latest/api/app.md#appwhenready (resolved as: /de/docs/latest/tutorial/latest/api/app.md)
   -> linking to latest/api/app.md#event-activate-macos (resolved as: /de/docs/latest/tutorial/latest/api/app.md)
   -> linking to latest/api/app.md#event-window-all-closed (resolved as: /de/docs/latest/tutorial/latest/api/app.md)
   -> linking to latest/api/app.md#appquit (resolved as: /de/docs/latest/tutorial/latest/api/app.md)
   -> linking to latest/tutorial/process-model.md (resolved as: /de/docs/latest/tutorial/latest/tutorial/process-model.md)
@dsanders11 dsanders11 added 🪲 bug Something isn't working area:i18n Related to website internationalization labels Aug 9, 2023
@DevanceJ
Copy link
Contributor

Hi @dsanders11, This bug occurs only for German which is very strange, from what I noticed is that when app link is clicked from quick-start in German page.

Actual behaviour: https://www.electronjs.org/de/docs/latest/tutorial/latest/api/app.md
Expected behaviour: https://www.electronjs.org/de/docs/latest/api/app
latest/tutorial is being added to the path along with latest/api/app.

In German:
image

When I checked Crowdin for all languages the href tag used was "/latest/api/app.md" hence it should not have been working differently for German.

There is one thing that stood out which is only for German the values lbb and fo are 2 and 5 respectively but for all the other languages it is 2 and 6. Although I am unaware of what is the usage of lbb and fo, I though this might help.
German:
Screenshot 2024-03-13 at 7 34 07 PM

French:
Screenshot 2024-03-13 at 7 36 30 PM

@c6z3h
Copy link

c6z3h commented Mar 31, 2024

took a deeper look into this, seems in this repo quick-start.md is not using the correct Markdown Link syntax prescribed by Docusaurus (last updated 2 days ago). But looking even further, seems there is a cron job from this repo's docs folder to pull from electron's docs folder every 3 months (or perhaps for every update to this quick-start.md file) -- need some looking into that.

Two interesting things strike me, and might be worth investigating:

  1. Why does the auto-update of website/docs not perform in a timely manner? This update in electron/electron repository's quick-start.md was merged on November 22, 2023. However, it was not picked up in this repository's update in Dec 5, 2023. It was only updated over in Feb 22, 2024.
  2. Is there something wrong with the automated action to update website/docs from electron/docs? In electron's docs folder, the Markdown Links are in correct Docusaurus syntax '../api/app.md', while the version here is 'latest/api/app.md'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:i18n Related to website internationalization 🪲 bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants