documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Create skeleton framework for internationalization and localization

Open stevepiercy opened this issue 3 years ago • 7 comments

We want only content that has been thoroughly reviewed and approved in this PR. If the original content in the i18n directory is relevant, then it is fine to copy-paste. If not, then leave it out or fix it in the new skeleton framework files.

Fixes https://github.com/plone/documentation/issues/1267

Replaces https://github.com/plone/documentation/pull/1265

stevepiercy avatar Jul 12 '22 11:07 stevepiercy

@stevepiercy do you want me to provide the missing documentation on this branch or let's merge this and then provide specific PRs with the relevant docs?

erral avatar Jul 31 '22 14:07 erral

Either way is fine. Whatever is easiest for you to do the work.

stevepiercy avatar Jul 31 '22 22:07 stevepiercy

Ok, I will do it here.

erral avatar Aug 01 '22 06:08 erral

@erral please let me know when you would like me and others to review your work. I don't know if you can select me in the UI, because I am the original author and I don't think GitHub allows the author to review their own PR.

stevepiercy avatar Aug 01 '22 09:08 stevepiercy

@stevepiercy this is ready to be reviewed. I think I completed all the portions about multilinguality and so.

erral avatar Aug 06 '22 18:08 erral

Let's also get @jensens, @mauritsvanrees, and @ksuess a chance to review the technical details. I'll focus on English and MyST syntax and grammar.

stevepiercy avatar Aug 06 '22 19:08 stevepiercy

I decided to save some time and effort by making and pushing commits instead of a review using the GitHub UI. I only had time to look at glossary.md and i18n-l10n/contributing-translations.md this afternoon. I will work on the remaining files after dark.

stevepiercy avatar Aug 06 '22 21:08 stevepiercy

At long last, I have completed my review. Changes include the usual English and MyST syntax fixes, but also some enhancements, such as screenshots, labels, glossary terms, and replacing i18n with i18n-l10n.

Could I please get one more round of reviews? @mauritsvanrees @erral @jensens @ksuess

stevepiercy avatar Sep 06 '22 08:09 stevepiercy

You want to merge 111 commits with 91 changed files into the add-i18n branch. That is a tad much for a PR that claims to create a "skeleton framework". ;-) I propose to remove the add-i18n branch (can be done later) and change this PR to target 6-dev instead.

Also, is there no automated preview site anymore? I have been missing that for a while.

mauritsvanrees avatar Sep 06 '22 11:09 mauritsvanrees

@mauritsvanrees good point. The huge number of commits and file changes are the result of merging 6-dev into this branch, which in retrospect I should not have done. Oopsie.

So I think I will go ahead and merge this PR. Then take the next step, open a PR of add-i18n into 6-dev, which in turn will trigger a preview build. I'll go ahead and do that now, and that will make the review cleaner and easier.

stevepiercy avatar Sep 06 '22 11:09 stevepiercy