fix(content-docs): translate generated index pagination title

[Josh-Cena]

Pre-flight checklist

• I have read the Contributing Guidelines on pull requests.
• If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
• If this is a new API or substantial change: the PR has an accompanying issue (closes Generated category index page title not translated in pagination link #8118) and the maintainers have approved on my working plan.

Motivation

This is the same kind of fix as #7634 — deferring the generation of some metadata until contentLoaded.

Test Plan

We don't have tests for i18n + metadata generation, but I did test locally:

Previous:

Current:

Test links

Deploy preview: https://deploy-preview-_____--docusaurus-2.netlify.app/

Related issues/PRs

[Josh-Cena]

@slorber I'm not sure if this qualifies as a breaking change since we removed some metadata returned from loadContent. But we should not anticipate piggy-backing the plugin as an intended use case, should we?

[netlify]

✅ [V2]

Name	Link
🔨 Latest commit	80fe374
🔍 Latest deploy log	https://app.netlify.com/sites/docusaurus-2/deploys/6358d9f53e50080008ad47ec
😎 Deploy Preview	https://deploy-preview-8123--docusaurus-2.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site settings.

[github-actions]

⚡️ Lighthouse report for the deploy preview of this PR

URL	Performance	Accessibility	Best Practices	SEO	PWA	Report
/	🟠 62	🟢 97	🟢 100	🟢 100	🟢 90	Report
/docs/installation	🟠 73	🟢 100	🟢 100	🟢 100	🟢 90	Report

[github-actions]

Size Change: 0 B

Total Size: 819 kB

ℹ️ View Unchanged

Filename	Size
website/.docusaurus/globalData.json	52.6 kB
website/build/assets/css/styles.********.css	112 kB
website/build/assets/js/main.********.js	614 kB
website/build/index.html	40.8 kB

_{compressed-size-action}

[slorber]

So what I understand is that we should add the navigation metadata to the docs only after having translated the sidebars (ie the category index titles).

---

What annoys be me a bit is that I wish the contentLoaded() was receiving data in an already "processed" shape where the data structure can immediately be used to construct routes and everything. IE make it easy for users to implement their own contentLoaded.

Maybe we need an extra processContent lifecycle for that? loadContent => translate => process > contentLoaded: does it make sense? IMHO we can delay this decision after having a first-class API to extend plugins.

---

Note: is this expected that the sidebar became untranslated? I'm assuming your local test didn't include downloading all the translated MD and you just translated the category index title locally?

---

@slorber I'm not sure if this qualifies as a breaking change since we removed some metadata returned from loadContent. But we should not anticipate piggy-backing the plugin as an intended use case, should we?

To me removing data from a lifecycle is a breaking change. But I wouldn't consider it a breaking change only if we added new data.

At the same time we don't officially provide an official public API to override contentLoaded so only users doing the temporary workaround suggested in #4138 would likely be affected by it. That may include some plugin authors.

I think we can mark it as a breaking change. It is a minor i18n bugfix that can wait 3.0 IMHO and it's not really worth it to backport it immediately.

[slorber]

I guess you didn't update the snapshots for now to help the review, can you make the PR pass?

Also, we had the navigation snapshotted before, is there a good way to still prevent possible navigation regressions with our current test setup?

[Josh-Cena]

There are other tests failing because this has changed the loaded content. I will fix that later. And yes—I only hand-wrote the translation that needed to be written.

is there a good way to still prevent possible navigation regressions with our current test setup?

This is the reason I haven't fixed the tests yet. I think we can only snapshot the generated data instead.

[Josh-Cena]

OK! I think I've finally got the tests figured out.

[Josh-Cena]

Maybe not yet😅 Such a pain

[Lorde627]

any progress about this 👀

[ikallali]

+1

[yujingz]

Would much appreciate if we can take another look at this issue. This is esp. bad if EN is not the default locale.

[qvignaud]

We're encountering the same issue, and as @yujingz it feels really weird for users as the primary language of website is not EN.
Any news on it? And what could be done to help if required?

[ncoroy]

Hi, we are experiencing the same issue with the generated index not being fully translated. Any plan to correct this shortly ? Is it possible to help in a way or another ?

[l-qttk]

Any updates on this?