docs(fr): french documentation and README.md

[antoinezanardi]

Hello all 👋 !

Here is the french version of the VTU documentation, including all vitepress pages, API and main README.

Details :

• Reworked doc/ folder and vitepress config : docs/.vitepress/config.ts was partially rewritten to provide a better support for internationalization. To add another language, you just have to copy and paste the fr/ folder and translate all the files in it. Finally, add the language in the docs/.vitepress/config.ts file under the locales field.
• The documentation is completely translated in french under the fr/ folder. Please choose Français in the Languages dropdown on the vitepress to see the results.
• The root README.md file has been translated to french and saved here : docs/fr/README.md.
• All code written in the docs were cleaned and linted.

Feel free to give me a feedback.

Have a nice day.

[netlify]

✅ Deploy Preview for vue-test-utils-docs ready!

Name	Link
🔨 Latest commit	3aa53a8
🔍 Latest deploy log	https://app.netlify.com/sites/vue-test-utils-docs/deploys/63f75fb6a0b1e10008e52cd5
😎 Deploy Preview	https://deploy-preview-1975--vue-test-utils-docs.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.

[cexbrayat]

Ho wow Antoine, thanks! That's a lot of work.

I'll review that in the next few days, and ping the rest of the team to check if everybody is OK with emerging this PR 👍

[lmiller1990]

I have minor reservations about merging translations. VTU v1 had a ton of translations - they all get out of date almost immediately, as soon as the mainline docs change.

I don't have a great solution to this problem. I also never consume docs in my non native language, so I don't know the value - is having some slightly out of date documentation in your native language more valuable than reading up to date ones in a non native language?

Happy to let others make this decision - I'm not impacted, nor am I the target audience for this PR. 🙏

[antoinezanardi]

Hi @lmiller1990, thanks for taking a look at my PR.

I totally understand you about the big work it is to maintain a doc in different languages. However, I think it has more pros than cons :
Pros :

• Not everybody understand english and more importantly technical words. It can be a relief to change the docs in your native language to understand the main concept in a explicit translation. I want to share the wonderful Vue environnement with most of the people who are interested in it, even if they don't speak Shakespeare's language.
• To my mind, it adds value to the project to have multi languages on the website.
• When translating docs, you spot some errors in the original one. I didn't want to mix them up, so I will create another PR for fixing the english docs. The more languages you'll have, the more documentation contributors will participate and fix.

Cons :

• When adding new lines in the native documentation, you have to translate it in the available other languages. To my mind, it's not a big deal. As it is 50% code (not translated), and 50% text (must be translated), a quick copy / paste on Google Translate or ChatGPT can resolve this. Maintainers must then verify that all translations are pushed each time on PR.

Anyway, it's only my point of view and I'm totally OK if you don't want add it to the current load of work.

[lmiller1990]

My main concern is more about how we maintain. Eg, I think you (or another French speaker) should not need to make a PR each time. One idea I had was we link to your fork with the docs from the main repo's docs, so you can push a commit any time you like without requiring oversight.

Just an idea. I am not against merging this here either. I will leave review/merging to you and @cexbrayat, I do not know French so I cannot really contribute. 🙏

[nazarepiedady]

@lmiller1990 could we at least add to the website the links to the translated versions?

[lmiller1990]

I think we can merge the entire translation - I was just voicing some of my concerns from the past, when had a ton of translations.

I think @cexbrayat was going to do a quick review - I don't know any french. This looks like a lot of work that should be very useful for many people - can we just merge as-is @cexbrayat?

[antoinezanardi]

If it's ok for you, I will resolve the conflicts and update the french docs with the latest changes.

I'll ping you when it's done.

[cexbrayat]

👍 Thanks Antoine

I did not have the time to review the docs, but I'll try to when you've updated them

[cexbrayat]

To integrate them, I think we need to check with the rest of the Vue team: there has been talks about it for other docs (router, pinia...), and I think there are some tools that we could leverage (ryo-chu for example)

[nazarepiedady]

@cexbrayat, to be honest, I am already translating the pinia and vue router docs
to Portuguese. I am ready to push them to the official main repositories.

They are being served in these urls: vue-router-docs, pinia-docs

[antoinezanardi]

👍 Thanks Antoine

I did not have the time to review the docs, but I'll try to when you've updated them

I've already updated the first half of the docs (from Installation to Easy to test sections). You can start the review from there.

[lmiller1990]

While we figure out the strategy around translation with the rest of the Vue core libs, how about publishing to somewhere (netlify, GH pages) and linking to that from our English docs @antoinezanardi?

[antoinezanardi]

While we figure out the strategy around translation with the rest of the Vue core libs, how about publishing to somewhere (netlify, GH pages) and linking to that from our English docs @antoinezanardi?

It's ok for me. However, is it going to be temporary ? Do you want me to create another repository with a proper URL for GitHub Pages ? Something like vue-test-utils-fr.github.io

[antoinezanardi]

All of the french docs is now fixed and up to date with the latest changes.

You can review it @cexbrayat . Thanks !

[cexbrayat]

I probably missed a ton of tiny things as it is quite big to review.

To be honest, some parts sound quite weird. Did you use Copilot or something like this to translate?

[antoinezanardi]

Thanks for your review ! I'll make the changes tomorrow.

I translated most of the docs with ChatGPT (which is really great for that) and review all the texts after that to make it more "human" friendly. I could miss some weird parts, my bad ..!

[nazarepiedady]

@antoinezanardi, I believe ....

if you want to do something do it right,
do not use robots to produce content to be consumed by
humans. I think that is disrespectful to the person that has
to read that because he will struggle with the weirdness of
what is written.

[antoinezanardi]

@nazarepiedady as I said in my previous comment, I reviewed all of the docs to be more readable for a human.

Don't think I just put all the texts in a robot that gave me a translation and I pushed it as is in 20 min. It took me a considerable effort to change non sense sentences, fixed existing errors in original code examples or translated texts by myself when the use of chatGPT was not necessary.

But, if you think I disrespect future French readers of this documentation (including myself, I translated it for my personal use, it's my native language), I would like to have your opinion of what I really produced here on this PR, not the way I did it. Please go ahead.

[nazarepiedady]

@antoinezanardi I just share what I think about the usage of
robots in some kind of work that I believe is better done by
humans. I had enough horrible experiences with the reading of
content obviously written by robots, so I have strong thoughts
about that.

I am not saying to anyone what to do, only to let the comment
clear I will edit it to adjust more.

[antoinezanardi]

@cexbrayat All the changes were applied, don't hesitate to give me your feedback about it

[antoinezanardi]

Any update on this ?

[lmiller1990]

I'm going to go ahead and merge this up. 💯

[lmiller1990]

For future ref, I think we should NOT have translations. This one can stay, though.

I'd like to adopt the same stance as VueUse: https://vueuse.org/why-no-translations.html