search

Tresjs / tres

Declarative ThreeJS using Vue Components
https://tresjs.org
MIT License
2.07k stars 96 forks source link

Translate docs to multiple languages #540

Open alvarosabu opened 6 months ago

alvarosabu commented 6 months ago

Description

As a developer using TresJS I would like to have documentation available in my native language

This ticket is meant to keep track of the progress of multiple PRs to translate Tres docs:

Feel free to comment below if you would like to add your language and help us translate the docs.,

Suggested solution

Create a branch docs/translation-<language-unicode> and a PR similar to #534 with the following steps:

  1. Add a <language-unicode>.ts inside docs/.vitepress/config ex: zh.ts (copy the en.ts which is the original and then translate only what's needed.
  2. Remember to add the code prefix route to all the links on this file, ex link: /guide/ -> link: /zh/guide
  3. Add to config to docs/.vitepress/config/index.ts like this:
export default defineConfig({
  ...sharedConfig,
  locales: {
    root: { label: 'English', lang: 'en-US', link: '/', ...enConfig },
    es: { label: 'Español', lang: 'es-ES', link: '/es/', ...esConfig },
    /* zh: { label: '简体中文', lang: 'zh-CN', link: '/zh/', ...zhConfig }, */
  },
})
  1. Create a folder with the language code (ex: zh) inside docs/, this is where the translations will live, then start translating the files using the same structure as on the docs root, like this:

docs/advanced/extending.md --> docs/zh/advanced/extending.md

Alternative

No response

Additional context

No response

Validations

DennisSmuda commented 6 months ago

@alvarosabu I'll shoot a PR for german translations this weekend 👍

offskip-dave commented 6 months ago

@alvarosabu @DennisSmuda I was a little bit too late with the German translations, but glad to see that it is being done 👍

enpitsuLin commented 6 months ago

@alvarosabu I've also started trying to translate it into Chinese. It's time to introduce more Chinese Vue developers to this awesome library! 🎉

alvarosabu commented 6 months ago

@alvarosabu @DennisSmuda I was a little bit too late with the German translations but glad to see that it is being done 👍

You can still participate, let me know and I will add you to the doc team, the only thing I would ask if you could coordinate with @DennisSmuda inside the PR which pages to translate, one suggestion would be doing a todolist on the description and assign the pages between the contributors.

Thanks a lot for this

offskip-dave commented 6 months ago

@alvarosabu @DennisSmuda I was a little bit too late with the German translations but glad to see that it is being done 👍

You can still participate, let me know and I will add you to the doc team, the only thing I would ask if you could coordinate with @DennisSmuda inside the PR which pages to translate, one suggestion would be doing a todolist on the description and assign the pages between the contributors.

Thanks a lot for this

@alvarosabu Got it. Seems like a good approach to me.

@DennisSmuda Let me know if you need help with this.

DennisSmuda commented 6 months ago

@offskip-dave - I only have examples and directives left to do - if you wanna take on one of these from me, sure 👍

DennisSmuda commented 6 months ago

@offskip-dave I think I'm done - I'd appreciate someone to read over it though 🙏

offskip-dave commented 6 months ago

@offskip-dave I think I'm done - I'd appreciate someone to read over it though 🙏

Ok, I will do!

X-smart commented 6 months ago

I'm glad to work together with @enpitsuLin on this translation.🤗

Hopefully, Tres can help more people get their work done.

offskip-dave commented 6 months ago

@alvarosabu I know you would prefer a native speaker, but I have lived close to 10 years in Japan and I feel relatively confident in Japanese, so I think I could give a shot at Japanese translations and have a native speaker proofread it, what do you think?

Laeti-dev commented 6 months ago

@alvarosabu Hi there ! I see that @AminGtt has started working on french translation. Can I help somehow ?

AminGtt commented 6 months ago

Hey @Laeti-dev ✋ I already did some pages but didnt open a PR, I will do it tonight and then we can split what is still waiting to be done. I will also appreciate a review once everything will be done. I keep you posted a bit later in the day :)

Laeti-dev commented 6 months ago

Hello @AminGtt ! I'll have some free time this week, if you could just open a PR with your work, I could start with a proof reading and work on a page ;) Talk to you soon

alvarosabu commented 6 months ago

@alvarosabu I know you would prefer a native speaker, but I have lived close to 10 years in Japan and I feel relatively confident in Japanese, so I think I could give a shot at Japanese translations and have a native speaker proofread it, what do you think?

Absolutely! Feel free to create a PR for Japanese! I think I know who could help us. 😊

alvarosabu commented 6 months ago

Hi @Laeti-dev @AminGtt let me know if I can support you somehow, super happy to see everyone collaborating to get Tres translated to everyone. Thank you 🙏🏻

AminGtt commented 6 months ago

Hey @Laeti-dev! Sorry for not contacting you directly before but I am not able to mention you on the PR directly, I opened it the day we talked. You can found it here: https://github.com/Tresjs/tres/pull/555 Everything is detailed and should not be difficult. Ping me if you need anything, Cheers

LucaArgentieri commented 4 months ago

Italian translations WIP 👷‍♂️ #654, setup ready 👍

offskip-dave commented 4 months ago

@alvarosabu Sorry for the delay with the Japanese translations, but I think I will have them ready within the next 2 or so weeks.

alvarosabu commented 4 months ago

Hi @offskip-dave no rush at all, I'm really happy you are working on them 💚

hexianWeb commented 2 months ago

4.0 is a beneficial update. I hope the corresponding Chinese documentation can keep up with this change soon. If you need any help, I'll be happy to help🚀

alvarosabu commented 2 months ago

Hi @hexianWeb yes we will need to update all the translations soon, I'm talking with the DX of Astro for a tool that checks which pages need updating on vitepress. We might be able to use it

LucaArgentieri commented 2 months ago

@alvarosabu I finished Italian translations, I would like someone to take a look at it to check that everything is ok 👀 https://github.com/Tresjs/tres/pull/654

hexianWeb commented 2 months ago

Hi @hexianWeb yes we will need to update all the translations soon, I'm talking with the DX of Astro for a tool that checks which pages need updating on vitepress. We might be able to use it

The tool sounds very useful, Please keep me updated on its progress. Also, if there's anything I can assist with, please don't hesitate to let me know.

nazarepiedady commented 1 month ago

@alvarosabu, as I said in the past, I will translate the content to Portuguese. I already forked the repository and I will start soon.