feat: add admonition type title translations by slorber · Pull Request #7556 · facebook/docusaurus

slorber · 2022-06-03T13:56:34Z

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 #0000) and the maintainers have approved on my working plan.

Motivation

Admonition default titles are not translated by default

This leads translations to use translate :::tip as :::tip astuce to get it translated

This is better to have it translated with theme translations by default.

It is also safer as we can exclude :::tip from translated strings in Crowdin, preventing translation mistakes that may lead to failing CI builds.

Also added:

admonition stable theme class names
minor refactors

Test Plan

Tested locally

Test links

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

Related issues/PRs

#4542

Josh-Cena · 2022-06-03T14:01:59Z

packages/docusaurus-theme-classic/src/theme/Admonition/index.tsx

  secondary: 'note',
  important: 'info',
  success: 'tip',
  warning: 'danger',


"Warning" is used more often than "danger", at least for our docs. Do we really want to not translate it?

good point, this is a bit annoying to have these aliases and would require duplicating some translation duplication

btw I'm not fan at all of "caution". "warning" is more natural to me.

Do we really need different default labels for both cases?

Is there a good reason to use both on our own website, or is it just historically the case?

I agree that "warning" = "danger" and "caution" being another thing is not at all obvious😅 I can't even think of two distinct words for "warning" and "caution" in Chinese. Maybe we can keep it like this, since it... should be better than what we had?

TBH, on Crowdin, I never translate the admonition titles, because using "tip"/"info" is actually more natural than using any Chinese characters in the title. Maybe that's just me.

@forresst do you find it useful to have 2 orange admonitions for warning/caution ?

They are currently translated in French as "avertissement" / "attention", but to me we could as well use "attention" for both and it would remain a good translation

@slorber You are right. I agree with you. One is enough. "attention" is perfect

I'm not good at French at all, but I struggle to capture the nuance between "warning" and "caution" in my Chinese translations. "Caution" does sound less severe than "warning". I think "avertissement" is more severe than "attention" (forgive my ignorance if that's not true)?

@forresst personally I find "Attention" more usual in French and would use it in both cases

I guess all this is quite subjective 🤪 hopefully it is now customizable

oh yes, I'm misunderstanding things now.

Our alias "warning" -> "danger" feels really wrong to me. To me a warning should be yellow/orange.

BTW it looks like I'm not alone to think so

https://v1.vuepress.vuejs.org/guide/markdown.html#custom-containers

https://nextra.vercel.app/themes/docs/callout

https://vitepress.vuejs.org/guide/markdown.html#custom-containers

https://docs.gitbook.com/editing-content/rich-content/with-command-palette#hints-and-callouts

I'll open a dedicated issue, we should probably do like all others, but we need a way to migrate this gracefully or this will be annoying for our users

That's very right. It has always been tricky for me as well. A breaking change is probably worth it, considering :::warning wasn't documented anyway...

slorber

If someone has translations to suggest, please do so :)

packages/docusaurus-theme-translations/locales/fr/theme-common.json

slorber · 2022-06-03T13:57:54Z

packages/docusaurus-theme-translations/locales/ru/theme-common.json

  "theme.NotFound.p2": "Пожалуйста, обратитесь к владельцу сайта, с которого вы перешли на эту ссылку, чтобы сообщить ему, что ссылка не работает.",
  "theme.NotFound.title": "Страница не найдена",
  "theme.TOCCollapsible.toggleButtonLabel": "Содержание этой страницы",
+  "theme.admonition.caution": "caution",


cc @lex111 , want to provide translations?

packages/docusaurus-theme-translations/locales/zh-Hant/theme-common.json

slorber · 2022-06-03T14:00:55Z

packages/docusaurus-theme-translations/locales/pt-BR/theme-common.json

+  "theme.admonition.danger": "danger",
+  "theme.admonition.info": "info",
+  "theme.admonition.note": "note",
+  "theme.admonition.tip": "tip",


cc @sseraphini , translations to suggest? 😄

slorber · 2022-06-03T14:01:31Z

packages/docusaurus-theme-translations/locales/ko/theme-common.json

+  "theme.admonition.danger": "danger",
+  "theme.admonition.info": "info",
+  "theme.admonition.note": "note",
+  "theme.admonition.tip": "tip",


cc @koko8829 @leeyspaul , translations to suggest?

slorber · 2022-06-03T14:02:34Z

packages/docusaurus-theme-translations/locales/fa/theme-common.json

+  "theme.admonition.danger": "danger",
+  "theme.admonition.info": "info",
+  "theme.admonition.note": "note",
+  "theme.admonition.tip": "tip",


cc @massoudmaboudi translations to suggest?

netlify · 2022-06-03T14:03:39Z

✅ [V2]

Name	Link
🔨 Latest commit	`5d6bc15`
🔍 Latest deploy log	https://app.netlify.com/sites/docusaurus-2/deploys/629a19a0c0c8c60008755555
😎 Deploy Preview	https://deploy-preview-7556--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 · 2022-06-03T14:04:25Z

⚡️ Lighthouse report for the deploy preview of this PR

URL	Performance	Accessibility	Best Practices	SEO	PWA	Report
/	🟠 79	🟢 100	🟢 100	🟢 100	🟢 90	Report
/docs/installation	🟠 81	🟢 100	🟢 100	🟢 100	🟢 90	Report

packages/docusaurus-theme-translations/locales/zh-Hans/theme-common.json

packages/docusaurus-theme-translations/locales/zh-Hant/theme-common.json

github-actions · 2022-06-03T14:08:18Z

Size Change: +72 B (0%)

Total Size: 798 kB

Filename	Size	Change
`website/build/assets/js/main.********.js`	600 kB	+72 B (0%)

ℹ️ View Unchanged

Filename	Size
`website/.docusaurus/globalData.json`	52.6 kB
`website/build/assets/css/styles.********.css`	106 kB
`website/build/index.html`	38.9 kB

_{compressed-size-action}

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>

slorber · 2022-06-03T14:39:53Z

Going to merge now, we'll figure out the details in other PRs if there's anything to change

If you want to submit your translation, just open a PR after modifying your localized file here: https://github.com/facebook/docusaurus/tree/main/packages/docusaurus-theme-translations/locales

slorber added 4 commits June 3, 2022 15:22

add admonition stable className

bc03b61

add admonition default label translations

fcc5451

typo

548ffdc

add default theme translations

37e399d

slorber added the pr: new feature This PR adds a new API or behavior. label Jun 3, 2022

slorber requested review from Josh-Cena and lex111 as code owners June 3, 2022 13:56

facebook-github-bot added the CLA Signed Signed Facebook CLA label Jun 3, 2022

Josh-Cena reviewed Jun 3, 2022

View reviewed changes

slorber commented Jun 3, 2022

View reviewed changes

Josh-Cena reviewed Jun 3, 2022

View reviewed changes

packages/docusaurus-theme-translations/locales/zh-Hans/theme-common.json Outdated Show resolved Hide resolved

packages/docusaurus-theme-translations/locales/zh-Hant/theme-common.json Outdated Show resolved Hide resolved

slorber and others added 2 commits June 3, 2022 16:24

zh-Hant translations

ba7b4bc

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>

zh-Hans translations

5d6bc15

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>

slorber mentioned this pull request Jun 3, 2022

Translate admonition keyword elviswolcott/remark-admonitions#35

Closed

slorber merged commit 9d0bf2e into main Jun 3, 2022

slorber deleted the slorber/admonitions-translate branch June 3, 2022 14:40

This was referenced Jun 3, 2022

[i18n] Making everything translatable (website title, description...) #4542

Open

Help us translate the Docusaurus website #3526

Open

RFC: change Docusaurus admonition warning color from red to yellow #7558

Closed

Josh-Cena mentioned this pull request Jun 5, 2022

fix(theme-translations): improve zh translation #7570

Merged

3 tasks

linear bot mentioned this pull request Jul 11, 2022

chore(deps): update docusaurus monorepo to v2.0.0-beta.22 logto-io/docs#142

Merged

1 task

Uh oh!

Conversation

slorber commented Jun 3, 2022

Pre-flight checklist

Motivation

Test Plan

Test links

Related issues/PRs

Uh oh!

Choose a reason for hiding this comment

Uh oh!

slorber Jun 3, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Josh-Cena Jun 3, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

slorber left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

netlify bot commented Jun 3, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ [V2]

Uh oh!

github-actions bot commented Jun 3, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚡️ Lighthouse report for the deploy preview of this PR

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jun 3, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

slorber commented Jun 3, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

slorber Jun 3, 2022 •

edited

Loading

Josh-Cena Jun 3, 2022 •

edited

Loading

netlify bot commented Jun 3, 2022 •

edited

Loading

github-actions bot commented Jun 3, 2022 •

edited

Loading

github-actions bot commented Jun 3, 2022 •

edited

Loading