Material-ui: [docs] Traduire les docs

Créé le 15 déc. 2017  ·  63Commentaires  ·  Source: mui-org/material-ui

Salut les gars, que pensez-vous de la traduction de documentation ?

Je pense que ça pourrait être bien pour la v1 .

Comment cela pourrait-il être fait en suivant votre système de documentation actuel ?

docs enhancement

Commentaire le plus utile

Honnêtement, je pense que dans un monde où la majorité des ressources de développement sont en anglais, essayer de maintenir plusieurs traductions des documents serait un exercice futile et pour un gain marginal.

Tous les 63 commentaires

Nous aurions besoin de commencer à comparer la façon dont les autres traitent le problème et à copier la meilleure solution. Vue semble simplement bifurquer la documentation :

@oliviertassinari Mais qu'en est-il des docs API ?

qu'en est-il des docs API ?

@mbrookes je ne sais pas. Cela peut être fait avec des clés de traduction. Comme api.componentName.propertyName . Mais c'est une telle surcharge pour prendre en charge i18n.

Honnêtement, je pense que dans un monde où la majorité des ressources de développement sont en anglais, essayer de maintenir plusieurs traductions des documents serait un exercice futile et pour un gain marginal.

Crowdin est une entreprise qui fournit des services de traduction. Pour les projets Open Source, Crowdin fournit des traductions de chaînes gratuites

https://docusaurus.io/docs/en/translation.html

Docusaurus pourrait être une bonne solution

@TorzuoliH Docusaurus n'est pas une option. Il est essentiel pour nous d'alimenter nos composants.

Salut. Je serais prêt à aider à traduire les docs en espagnol.

Je sais que la plupart des documentations logicielles sont en anglais, ce qui signifie idéalement que chaque développeur devrait pouvoir la lire. Mais ce n'est pas le cas. Quand il n'y a pas de documentation « officielle » dans sa propre langue, ce sont des blogs, des vidéos, etc. qui prennent la place d'une autorité plutôt douteuse : il suffit de regarder les ressources suggérées pour apprendre React en espagnol : https://github.com/jlobos /react-espanol . Je pense que le fait d'avoir les documents dans plusieurs langues peut rendre Material-UI beaucoup plus accessible.

Heureux de vous aider avec toutes les traductions espagnol/portugais si nécessaire également !

En regardant notre part de marché en Chine, je pense que nous devons vraiment faire avancer l'histoire de la traduction de Material-UI. Par exemple, nous avons moins de trafic depuis la Chine que depuis la France…

J'ai commencé à comparer ce que fait l'industrie. Quelques solutions à regarder qui sont intéressantes d'un point de vue architectural :

  • Vue . Ils utilisent Hexo sous le capot mais je crois qu'ils n'utilisent pas la fonctionnalité i18n de la bibliothèque.
    Leur flux de travail est expliqué dans https://github.com/vuejs/vuejs.org/issues/271#issuecomment -266476746. C'est encourager la communauté à bifurquer la documentation et à faire la traduction de son côté. Par exemple, vuejs-fr/vuejs.org , vuejs-ru/vuejs.org .
    C'est la solution qui demande le moins de travail de notre côté. Cependant, je le trouve inefficace. C'est aussi l'approche utilisée par Bootstrap.
  • Nuxt utilise une variété d'outils pour ce faire. J'espère que pour nous, il y a quelques détails :). Je pense que cela vaut la peine d'essayer GitLocalize .
  • Jest utilise Docusaurus pour créer la documentation. Ils utilisent également crowdin pour traduire la documentation. Je pense que crowdin est un concurrent de GitLocalize. C'est aussi quelque chose à essayer.

Aussi : https://www.transifex.com

C'est encourager la communauté à bifurquer la documentation et à faire la traduction de son côté. [...] je le trouve inefficace.

Je suis d'accord - j'ai commencé à écrire un commentaire avant que vous ne soumettiez le vôtre, à l'effet que quoi que nous fassions, le suivi des modifications doit être automatisé. Sinon, il n'y a aucun moyen simple pour les contributeurs à la traduction de se tenir au courant des modifications, et aucun moyen pour les utilisateurs des documents traduits de savoir quelles parties peuvent être obsolètes.

Idéalement, un utilisateur pourrait survoler le texte signalé comme texte obsolète pour voir l'original anglais à jour, et peut-être même soumettre une traduction mise à jour en contexte. De même, pour le texte nouvellement ajouté, il afficherait l'anglais et permettrait aux traductions d'être soumises en ligne.

Je dois supposer qu'il y a quelque chose de disponible pour supporter cela, car c'est la seule solution pratique pour maintenir à jour plusieurs traductions d'un document vivant, tout en permettant aux utilisateurs de voir l'original dans son contexte... Nous devons juste le trouver : -)

Je serais heureux de vous aider avec la traduction en français si nécessaire.

chinois ici! Travaillant également pour Hai... Plus que disposé à aider avec la doc chinoise.

Je peux aider avec la traduction portugaise.

Ma langue principale est l'espagnol, je peux aider à la traduction.

@oliviertassinari material-ui est très populaire auprès des développeurs en Chine, mais de nombreuses entreprises ne l'aiment pas. Parce qu'il utilise React! Je viens de Chine. J'ai commencé à utiliser material-ui à partir de la version 0.x. Je l'aime beaucoup. Au fait, mes amis aiment aussi material-ui. Si nécessaire, je voudrais apporter ma capacité à convertir des documents en chinois. Mais je vois actuellement que la structure officielle du document n'est pas propice au fork modifié vers d'autres langues !

En regardant l'origine du trafic sur GitHub, je pense que nous devrions nous concentrer uniquement sur l'anglais et le chinois pour commencer.

capture d ecran 2018-06-13 a 00 30 42
https://www.similarweb.com/website/github.com

J'ai comparé l'approche utilisée par Bootstrap . Ils comptent sur la communauté pour le faire. Les versions chinoises représentent environ 10 % du trafic mondial. Ce n'est pas si mal.

@medz Merci pour les commentaires. Oui, nous aurions besoin de travailler sur la structure de base de la documentation.
Un défi important est de rester à jour. Quel procédé devons-nous utiliser ?
J'ai vu un site Web s'appuyer sur Google Translate… mais les gens n'ont pas besoin de nous pour utiliser Google Translate.

@oliviertassinari La structure i18n ou la structure de répertoire du package de langue est bonne, ou la structure qui peut fournir le langage de modification de fork est également un bon choix, mais la structure du langage de modification de fork a besoin d'un nouveau nom de domaine pour être déployé. Du point de vue de l'utilisation par l'utilisateur, la structure de package ou la structure de répertoire du langage i18n est un meilleur choix.

S'il existe des documents chinois, material-ui sera plus populaire en Chine. Pour révéler un petit fait, de nombreux développeurs anglais en Chine sont très mauvais. Voyant l'anglais il y a une envie d'abandonner, ma capacité d'anglais est également très mauvaise, je crois qu'il y a beaucoup de problèmes de grammaire dans ma réponse !

😄Désolé, je comprends ce que vous entendez par erreur. Ce que vous voulez dire, c'est de tenir à jour la documentation dans d'autres langues. J'ai vu que Docusaurus utilisait Crowdin pour la traduction après avoir utilisé la structure i18n pour générer des fichiers. J'ai expérimenté une version très inhabituelle de la traduction de Crowdin ! Selon docusaurus, Crowdin peut fournir un support de traduction gratuit pour les projets open source. De cette façon, les traducteurs n'ont qu'à se joindre à la soumission des traductions du document. Crowdin identifie automatiquement les pièces qui doivent être mises à jour en fonction de la construction du fichier d'entrepôt.

Merci.

Honnêtement, je pense que dans un monde où la majorité des ressources de développement sont en anglais, essayer de maintenir plusieurs traductions des documents serait un exercice futile et pour un gain marginal.

Ça a l'air bien!

@oliviertassinari je te comprends, mais à mon avis la raison pour laquelle les autres pays ne l'utilisent pas, c'est parce que c'est en anglais. Je suis à peu près sûr qu'avec une version portugaise, par exemple, les Brésiliens l'utiliseraient davantage dans leurs projets.

@fizzvr

essayer de maintenir plusieurs traductions des documents serait un exercice futile

Ça a l'air bien!

Peut-être qu'un meilleur choix de mots aurait été "essayer de maintenir manuellement ", sinon des modifications du matériel source pourraient être manquées dans les traductions, ou les traductions pourraient être complétées par du contenu non inclus dans la langue source (ou autre).

J'ai ensuite décrit une solution idéalisée (https://github.com/mui-org/material-ui/issues/9511#issuecomment-377815552), et il semble qu'il existe des services tiers qui tentent de répondre à cela.

Nous devons en trouver un qui puisse être intégré dans le site et la structure de documentation de Material-UI sans une refonte massive, mais qui offre également une utilité suffisante pour le rendre intéressant.

@fpudo Si nous pouvons trouver la bonne solution, le nombre de langues n'est limité que par la volonté des personnes d'assumer l'effort de traduction.

Je serais heureux de vous aider avec la traduction en chinois. @ moi est nécessaire. :)

@earvinLi @medz @xiaoyu-tamu Merci pour votre patience - je pense que nous sommes enfin prêts pour vous ! https://crowdin.com/project/material-ui-docs

@earvinLi Êtes-vous heureux d'être le propriétaire des traductions chinoises ?

@mbrookes Salut Matt, ça fait un peu long. Je suis toujours prêt à aider, mais pouvez-vous demander aux deux autres bons gars s'ils veulent être le propriétaire ?

Je peux aider avec n'importe quelle traduction espagnole nécessaire!

Je fais demi-tour et me propose à nouveau de le traduire en portugais.

@opusartificis @fpudo , merci. Nous commençons avec le chinois, mais surveillez cet espace.

@earvinLi , bien sûr, merci. Pourriez-vous traduire une page ou deux pour tester les processus et me dire comment ça se passe ?

@mbrookes Tout à fait !

@earvinLi S'il vous plaît, pourriez-vous me contacter sur Gitter ? (https://gitter.im/mbrookes)

@xiaoyu-tamu Merci d'avoir commencé ! J'ai défini le top dix en fonction de l'utilisation comme "haute priorité" indiquée par la flèche vers le haut. J'ai également dépriorisé les 10 derniers fichiers et les 3 derniers répertoires.

Le numéro un (fichier de démarquage) est getting-started/installation - nous devrons également, séparément, traduire la page d'accueil, mais je devrai d'abord coder cela.

Voici la hot-list :

image

Je vais pousser une notification demandant de l'aide pour traduire les docs. Pensez-vous que vous pourriez proposer un "appel à l'action" approprié en chinois ?

Super! Heureux d'aider avec le chinois.

@akaxiaok Vous pouvez suivre nos efforts et nous aider sur https://translate.material-ui.com/project/material-ui-docs :).

Salut, y a-t-il un moyen de désactiver la traduction automatique du site Web mui ? J'aimerais voir la documentation originale en anglais mais je ne sais pas comment faire.

Salut, y a-t-il un moyen de désactiver la traduction automatique du site Web mui ? J'aimerais voir la documentation originale en anglais mais je ne sais pas comment faire.

@mbrookes Il se peut que nous devions aller de l'avant avec l'approche des sous-dossiers si nous voulons prendre en charge ce cas d'utilisation en dehors de la boîte. @marsonmao l' ajout ?lang=en était censé fonctionner 🤔, sinon, il faut changer les langues acceptées de votre navigateur :/.

@oliviertassinari Hmm a essayé une URL comme celle-ci et ne fonctionne pas : https://material-ui.com/demos/chips/?lang=en , a également essayé de modifier le paramètre de langue de mon navigateur Chrome et ne fonctionne pas non plus. J'ouvre maintenant le site Web de la doc en utilisant mon bord IE lol.

C'est juste que, cette fonction de traduction ne devrait-elle pas être contrôlée manuellement ? Je ne sais pas si tout le monde veut voir la documentation dans sa langue maternelle tout le temps ? Pour ma part, je lis la plupart du temps des documents en anglais car ils sont plus cohérents avec le code source. Je ne lis les documents Chiese que lorsque j'ai besoin d'apprendre rapidement quelque chose de nouveau. Je pense donc qu'un interrupteur manuel est une approche plus raisonnable?

@marsonmao Nous avons opté pour la solution la plus simple possible pour le faire fonctionner de bout en bout. Ce sont des commentaires comme celui-ci que nous pouvons exploiter pour améliorer la documentation. Oui je suis d'accord.

@oliviertassinari Super, alors j'espère pouvoir l'utiliser à l'avenir. Je vais utiliser IE pour ouvrir la doc pour une solution de contournement 😄 Merci également pour le travail de material ui !

@marsonmao - @oliviertassinari a raison. Si, comme vous le dites, vous préférez lire les sites Web en anglais, vous devez modifier les préférences linguistiques de votre navigateur. Je l'ai testé à nouveau avec Firefox, Safari et Chrome, et cela fonctionne comme prévu.

À l'avenir, nous pourrions ajouter l'option de remplacer la préférence de langue définie dans le navigateur, mais pour l'instant, utilisez les paramètres du navigateur.

Je peux aider avec n'importe quelle traduction portugaise. La plupart des développeurs débutants et intermédiaires au Brésil ne sont pas intéressés par l'étude de l'anglais.

@andreacornaglia @fpudo @caiobessa Merci de proposer votre aide. La traduction en portugais brésilien est désormais disponible !

Hé, je peux aussi aider avec la traduction portugaise. Je me demande simplement à quoi ressemble le processus de traduction des chaînes dans Crowdin ? Qui approuve les traductions et qui doit créer la pull request avec les nouvelles traductions, le relecteur ou l'auteur ?

Pardon! Je viens de réaliser que nous avons un bot qui envoie les modifications de traduction au référentiel, donc je suppose qu'après avoir été approuvées, les traductions sont automatiquement incluses dans une nouvelle demande d'extraction pour révision, n'est-ce pas ?

@nicolasiensen Correct ! Merci de lui avoir donné un coup de feu avec la première page :).

Je commencerai la traduction demain !!! Super cool!

Si quelqu'un pouvait suggérer une formulation pour une notification en portugais, je l'ajouterai à la documentation.

Pour le chinois, j'ai suggéré "Aide à traduire la documentation Material-UI en chinois", la traduction est revenue comme "Aide Material-UI à traduire la documentation en chinois", donc tout ce qui va dans ce sens serait bien. N'hésitez pas à être créatif - tout ce que vous pensez apportera le plus d'aide.

Voici également quelques conseils pour faciliter la traduction :

  • Le bouton de copie est votre ami ! Utilisez-le pour copier le texte source avec le formatage avant de traduire tout texte.
  • Ne traduisez pas littéralement les noms de projet, tels que Material-UI, React, etc.
  • Traduisez les commentaires et les chaînes rendues (telles que les étiquettes de bouton) dans les exemples de code.
  • Ne traduisez pas les noms de composants tels que "Bouton". (C'est bien de le traduire lorsqu'il fait référence à l'objet générique, par exemple : "vous pouvez utiliser un bouton" ; ou "Boutons" comme un titre faisant référence aux boutons en général.)
  • Consultez les raccourcis clavier, ils vous feront gagner du temps. (Icône du clavier à droite de la barre d'application lorsque vous êtes dans l'éditeur.) Ils peuvent être personnalisés à votre guise.
  • Invitez autant de personnes que vous le pouvez à travailler avec vous dessus. C'est un gros travail !
  • Si quelque chose ne semble pas fonctionner correctement, faites-le nous savoir. Il y a beaucoup de paramètres que nous pouvons modifier.

Si vous êtes un relecteur, veuillez ne pas approuver vos propres traductions, autres que celles qui sont copiées directement à partir de la source, comme les objets de démonstration, par exemple {{"demo": "pages/demos/app-bar/SimpleAppBar.js"}} qui doivent être copiés non traduits à l'aide du bouton de copie, donc peut être approuvé immédiatement.

@mbrookes merci :)

Les traductions de @mbrookes en portugais ressemblent un peu à l'espagnol. Certaines personnes pourraient aider avec les traductions en espagnol. J'ai inclus.

@fizzvr La traction sur les traductions en portugais brésilien a été pour le moins décevante, nous pourrions encore l'abandonner. Je ne connais pas non plus l'espagnol - il n'y a pas eu beaucoup d'appels pour cela. Je soupçonne que la plupart des hispanophones (européens) parlent assez couramment l'anglais.

@mbrookes Veuillez attendre le 31 décembre pour abandonner au cas où nous n'avancerions pas avec la traduction en portugais brésilien. Il devient très calme chez moi
travail à cette période de l'année et j'aurai beaucoup de temps pour y travailler.

@mbrookes @fpudo Pour autant que je sache, la traduction portugaise ne figure nulle part. Je ne pense pas que cela puisse fonctionner sans un bouton d'édition comme nous en avons pour le chinois :

        if (userLanguage === 'zh') {
          return (
            <Button component="a" href="https://translate.material-ui.com/project/material-ui-docs">
              {'将此页面翻译成中文'}
            </Button>
          );
        }

        return (
          <Button component="a" href={`${sourceCodeRootUrl}${markdownLocation}`}>
            {'Edit this page'}
          </Button>
        );

Ce serait encore mieux avec une bannière quand il manque la traduction.

@oliviertassinari ce qui a aidé au départ avec le chinois était la notification, mais j'ai demandé aux volontaires sur CrowdIn et ici une suggestion de formulation en portugais (en donnant la traduction anglaise de la notification chinoise à titre d'exemple), et je n'ai reçu aucune suggestion.

@fpudo , merci de proposer de travailler là-dessus lorsque vous êtes moins occupé. En priorité, s'il vous plaît suggérez un appel à l'action pour les notifications de docs, et voyons si nous pouvons faire bouger les choses !

Je ne sais pas si c'est l'endroit mais si vous cherchiez de l'aide pour la traduction italienne, je pourrais vous donner un coup de main

@mbrookes Les notifications ne s'adapteront pas à plusieurs langues. Je propose ce qui suit :

  1. On avance avec le #13765.
  2. Nous ajoutons toutes les langues que nous voulons éventuellement prendre en charge.
  3. Nous implémentons une solution de repli, si la traduction n'est pas disponible, nous affichons la version anglaise (1. permet cela).
  4. Nous traduisons le bouton d'édition dans les langues que nous prenons en charge

  1. Si nous nous replions, nous affichons une jolie bannière demandant de l'aide pour la traduction. (optionnel)

Les notifications ne s'adapteront pas à plusieurs langues.

Hein? Cela revient à dire que les notifications ne s'adapteront pas à plusieurs versions.

Je préfère tester les eaux avec quelques langues avant d'ouvrir le robinet pour toutes les traductions potentielles. Une notification, espérons-le, aidera à lancer l'effort de traduction en portugais, comme il l'a fait pour le chinois, puis une fois qu'il y aura suffisamment de contenu, nous passerons en direct avec le portugais avec le bouton d'édition localisé.

1/3 ne fonctionnera pas - comme je l'ai mentionné dans la discussion #13765, une fois que la synchronisation CrowdIn est activée (de façon permanente ou périodique), il n'y aura plus de traductions manquantes.

Outre la simplification du code, le PR de repli est redondant.

Hein? Cela revient à dire que les notifications ne s'adapteront pas à plusieurs versions.

@mbrookes Ce que je veux dire par là, c'est que la vitesse de traduction en chinois a considérablement diminué, je pense que cela est corrélé à la fin de l'utilisation des notifications de documentation. Même si cela peut relancer le processus, je ne pense pas que ce soit suffisant pour le maintenir. C'est pourquoi je ne pense pas qu'il puisse évoluer. En outre, il affiche un message aux personnes qui n'ont aucun intérêt pour la question. Je pense qu'il y a place à l'amélioration.

il n'y aura pas de traductions manquantes.

Mais on peut essayer de le détecter. On peut comparer l'existence et la longueur de la traduction. Si la taille entre la cible et la source est très similaire, nous pouvons conclure que rien n'a été traduit.

Vos deux premiers commentaires semblent contradictoires - si la suppression de la notification (pourquoi a-t-elle été supprimée ?) entraînait une baisse de l'activité de traduction, alors la conserver l'aurait soutenue. - au point que les traductions chinoises seraient probablement maintenant presque complètes.

Cela dit, je me demande pourquoi le bouton CTA est inefficace ?

Je suis d'accord que si nous devions lancer plusieurs traductions en parallèle (ou presque), les notifications actuelles ne seraient pas mises à l'échelle.

Je me demande si la géolocalisation IP pour ceux-ci aiderait ?

Je crois que le bouton d'édition n'est pas vraiment visible. Il n'est pas toujours clair qu'une aide est nécessaire. La géolocalisation IP peut aider.

Pour tous ceux qui souhaitent aider à la traduction, le français, l'allemand, l'espagnol, le russe et le japonais sont désormais disponibles (aux côtés du chinois et du portugais) :

https://translate.material-ui.com/

Nous pouvons fermer le problème maintenant : https://next.material-ui.com/discover-more/languages/. Merci à tous pour l'aide et les contributions ! Nous avons réalisé la majorité des travaux d'infrastructure. Nous avons maintenant besoin d'un effort continu pour maintenir les traductions à jour :).

Cette page vous a été utile?
0 / 5 - 0 notes