Add documentation translation to Spanish
codesandtags opened this issue · comments
Hi Single SPA community,
In the company where I work, we started using single SPA for some micro-frontend projects, I think it's a great framework for micro front-end composition/routing, however, there is not documentation for LATAM.
I would like to know, how to translate the content in Spanish, in order to have more coverage in this region.
Thanks in advance for your time and your answer.
Hi @codesandtags, sure I'd love to have a spanish translation of the website. Do you know of any other people who can help with the translations? I generally prefer having at least two translators instead of one.
Here are the things that need to be done. If you can confirm that there is another person who is interested in helping maintain the translations, we can proceed.
Technical tasks
- Decide on a language code to use. I would propose
es - Create a new repo called
es.single-spa.js.org. Manually initialize it to be the same git tree as single-spa.js.org. Do not do this by forking the repo -- a fork has a separate git tree. You can do this by initializing to empty repo (no readme, no gitignore) and then adding that as a remote to your local copy ofsingle-spa.js.org:
cd single-spa.js.org
git remote add es git@github.com:single-spa/es.single-spa.js.org.git
git push es master:master- Set up the bot to automatically commit to es.single-spa.js.org whenever a PR is merged into single-spa.js.org. When a merge conflict happens, a pull request is created instead of a commit to master. We're currently doing this with https://github.com/guguji5/sync-fork-repo, but i don't think it is yet set up to handle more repos besides the
zh-hansrepo. @guguji5 can you clarify? Perhaps should we transfer that repository into https://github.com/single-spa so that it's owned and managed by you, the single-spa core team, and other translators. - Update docusaurus config to correct domain
- Update CircleCI badge in readme to correct url
- Enable builds in CircleCI. Add the GITHUB_TOKEN env variable
- Modify
/website/static/CNAMEin to be the correct domain. - Force HTTPS in the repository settings in Github. This takes a day or so after the CNAME is set for the SSL cert to be set up.
- Create a pull request to the js.org repo, adding the subdomain. Should be similar to this: js-org/js.org#3747
- Add Spanish to translations.js, so that it appears in the list at https://single-spa.js.org/languages
Organizational tasks
- Find at least one other person besides @mstrlaw who can help with the translations.
- Evaluate time commitment of maintaining the translations.
- Translators watch the Github repository for all activity
- Translate the files
/website/versioned_docs/version-5.xdirectory. Do not translate the/docsdirectory. Also, translate each of the pages in/website/pages
Hi @joeldenning ,
I'm glad to read your answer, I have a couple of friends who would have really happy to help with the translation.
By the way, our native language is Spanish (Colombia), so I think we could do a good job. In the meantime, we could get more people from other countries to contribute to those tasks.
At the beginning @crorodriguezro and me could start working in the translation.
Cheers!
Edwin
Great - I will start working on some of the tasks later today and will give you and @crorodriguezro access to the new repo.
One thing - I believe that es is the best country code for this? We probably don't need to differentiate between es-es, es-mx, es-co, etc?
That's right!
Only es is enough, we don't need to differentiate the countries.
Hi @joeldenning ,
I'm glad to read your answer, I have a couple of friends who would have really happy to help with the translation.
By the way, our native language is Spanish (Colombia), so I think we could do a good job. In the meantime, we could get more people from other countries to contribute to those tasks.At the beginning @crorodriguezro and me could start working in the translation.
Cheers!
Edwin
@joeldenning , Just to confirm @diegohoyos also can help us 💪🏼.
I have created the repository at https://github.com/single-spa/es.single-spa.js.org.
@codesandtags, @crorodriguezro, @diegohoyos could you do the following?
- Accept the invitation to the repo. You should have received an email with a link. Alternatively you can go to https://github.com/single-spa/es.single-spa.js.org or https://github.com/single-spa and there should be a yellow banner at the top letting you accept the invitation.
- Please join
#translationsin the single-spa slack - Watch the Github repository for all activity:
I pull requested js.org to add the new domain - see js-org/js.org#4601
This pull request adds Spanish to the list of translations: #319
Also @codesandtags, @crorodriguezro, @diegohoyos could you please join the single-spa slack?
And @guguji5 could you set up single-spa-bot?
Thanks @joeldenning! We are already there.
@joeldenning currently, the bot help to sync the pt-pt and zh-hans repos. I am glad to transfer it to single-spa, but I don't know how to transfer across github account, today I will do a research and try.
Hi @codesandtags , Could you apply the message(name, code and reviewers of the Spanish repo) needed by the bot, more detail is here
The bot for Spanish is ready, the sync job runs in my private server currently, later I will use github action instead of it.
Thanks everyone! I am closing this issue since everything is set up. Am looking forward to seeing more pull requests to es.single-spa.js.org
I have checked that the bot for es is running as expected.
Hi @joeldenning
Please could you give access to @carmudgeon to the spanish repo, I was talking with him and he is willing to help us to keep translating the documentation.
Done. Welcome @carmudgeon!