Translate documentation into Portuguese
mstrlaw opened this issue · comments
Technical tasks
- Decide on a language code to use. I would propose
pt-pt, since my understanding is that you and your team are based in Portugal. The React translations have bothpt-ptandpt-bra separate translations, for portugal and brazil. - Create a new repo called
pt-pt.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 pt-pt git@github.com:single-spa/pt-pt.single-spa.js.org.git
git push pt-pt master:master- Set up the bot to automatically commit to pt-pt.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 portuguese 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.
- Translate the files
/website/versioned_docs/version-5.xdirectory. Do not translate the/docsdirectory. Also, translate each of the pages in/website/pages
@mstrlaw can you confirm that you're up for this? And that you agree that pt-pt makes the most sense for the subdomain?
If so, I'll go ahead and create an empty repo for it and give you write access to start working on it.
Hey @joeldenning
I'm up for it. I think I can bring at least someone else to assist in the translation. Pt-pt is indeed the right code. You can go ahead and create the repo 👍
I've created the repo: https://github.com/single-spa/pt-pt.single-spa.js.org
Also, I've invited you to the repo, you can accept it at https://github.com/single-spa.
Finally, I've made a few of the modifications already and checked the corresponding checkboxes above. If you could work on getting the first deployment successful in CircleCI, that would be great, and then the other checkboxes too. I've given you access to this repository as well, so I think you should be able to check the checkboxes in my message, too.
I will help to set the sync script up. the bot account (single-spa-bot) need the permission of push code, too.
Thanks @guguji5 - it looks like the bot is working for pt-pt now? I see it made a commit recently:
@joeldenning Yes, it is working for multiple languages, I fix the bug that could not create PR successfully. After detecting the result for several days, I will transfer the ownership to this account.
Thanks, guguji for your great work on the bot.
I've created js-org/js.org#3756 to add pt-pt as a subdomain of single-spa.js.org
Also created #186 to add portuguese to the translations.js file
This is now live! And linked to from https://single-spa.js.org/languages