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

[docs] Set up Crowdin for MUI X docs #4948

Closed
2 tasks done
m4theushw opened this issue May 20, 2022 · 3 comments
Closed
2 tasks done

[docs] Set up Crowdin for MUI X docs #4948

m4theushw opened this issue May 20, 2022 · 3 comments
Labels
docs Improvements or additions to the documentation

Comments

@m4theushw
Copy link
Member

Duplicates

  • I have searched the existing issues

Latest version

  • I have tested the latest version

Summary 💡

The button to edit the page (or translate the page) is redirecting to the MUI Core dashboard: https://translate.mui.com/project/material-ui-docs/

image

We should set up the repo in Crowndin and update the page to redirect to the correct dashboard when on a MUI X page. This may require a contribution in the core repo too. Apart from adding the Crowndin GitHub Action, the crowndin.yml must also be created. Docs: https://support.crowdin.com/github-crowdin-action/

Examples 🌈

No response

Motivation 🔦

Allow the community to send translations.

Order ID 💳 (optional)

No response

@m4theushw m4theushw added the docs Improvements or additions to the documentation label May 20, 2022
@oliviertassinari
Copy link
Member

oliviertassinari commented May 20, 2022

The translation on MUI Core are kind of broken. I believe that the root cause is that the community is not translating the docs fast enough to catch up with our changes there.

On MUI X, I believe we will face a couple of challenges too, some of our API pages are custom made (not using a shared infra with the main repo), not designed with internationalization in mind.

I think that the important question we need to answer is: "Is is worth translating the documentation?" I don't think that we have ever taken the problem seriously, so never attempted to solve the problem properly. It would likely take 12 months of continuous investment to see if the ROI is positive or negative.

@m4theushw
Copy link
Member Author

m4theushw commented May 20, 2022

I missed the motivation to have opened this issue. It was because of mui/material-ui#32399 (comment)

Also agree that the ROI is debatable. We need to see how many users use the translated docs in Portuguese or Chinese.

@cherniavskii
Copy link
Member

This issue is no longer relevant since we disabled translated docs in #6560

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation
Projects
None yet
Development

No branches or pull requests

3 participants