fdp-primer: Add Weblate chapter
Based in the Wiki page
https://wiki.freebsd.org/Doc/Translation/Weblate
While here, adjust some old information in the po-translations chapter.
Details
Details
- Reviewers
ebrandi grahamperrin bcr - Group Reviewers
doceng docs - Commits
- R9:0f02d4b7944f: fdp-primer: Add Weblate chapter
See live:
The menu links from the left won't work; just check the chapters.
Diff Detail
Diff Detail
- Repository
- R9 FreeBSD doc repository
- Lint
Lint Not Applicable - Unit
Tests Not Applicable
Event Timeline
There are a very large number of changes, so older changes are hidden. Show Older Changes
| documentation/content/en/books/fdp-primer/weblate/_index.adoc | ||
|---|---|---|
| 57 | ||
| 117 | Lowercase d, here and elsewhere, for doc/documentation repository. Similarly: documentation portal. The footer of the portal does not use an uppercase P. | |
| 120 | ||
| 132 | ||
| 137 | ||
| 139 | ||
| 154 | lowercase (here and elsewhere) | |
| 167 | ||
| 172–173 | UTF-8 is not a format. | |
| 184 | ||
| 193 | Weasel words? Here and elsewhere … | |
| 193 | ||
| 194–195 | Superfluous. | |
| 198–199 | Which project? The FreeBSD Project? The phrase CI/CD may be not understood. | |
| 199 | Please: where? | |
| 203 | ||
| 214 | ||
| 221 | ||
| 233 | ||
| 235 | ||
| 236 | ||
| 251 | ||
| 264–265 | ||
| 266–267 | ||
| 326 | ||
| 327 | ||
| 329 | ||
| 329 | Does this (build the entire set again) mean rebuild the entire set? | |
| 333 | ||
| 336 | ||
| 341 | ||
| 350 | ||
| 350 | ||
| 350 | ||
| 357–359 | ||
| 360 | ||
| 360 | ||
| 362 | ||
| 393 | ||
| 395 | ||
| 403 | ||
| 404 | ||
| 406 | ||
| 406 | Rephrase this part of the sentence; it's like saying change changes or revise revisions … Maybe review changes | |
| 420 | ||
| 429 | ||
| 431 | ||
| 450 | ||
| 451 | ||
| 454 | ||
| 457 | ||
| 459 | ||
| 461 | ||
| 463 | ||
| 463 | Will this cause the ", contrib-additional" part of phrase to be visible? | |
| 465 | ||
Comment Actions
Thanks working on this!
| documentation/content/en/books/fdp-primer/weblate/_index.adoc | ||
|---|---|---|
| 64 | Since this is a sequence of steps, I would use an ordered lists instead of bullets. | |
| 131 | I'm not sure what this means. If I get it correctly, maybe we could rephrase as: If the language you want to translate into is not in Weblate... | |
| 146 | ... All translations link will be available | |
| 149 | ...that is more info... --> ...there is more info... | |
| 266–267 | I would use: To ignore that limit | |
| 276 | Some documents, like books, have many PO Gettext files.[full stop here] Always copy all of them when translating and building. | |
| 300 | en is always added by default. Maybe we can mention that. $ DOC_LANG=es make ===> documentation (all) make[1]: "[redacted]" line 56: warning: "Warning: cannot skip 'en'; adding it back" | |
| 315 | Maybe use 127.0.0.1 so there is no need to replace this example with an actual IP address? | |
Comment Actions
Thanks @grahamperrin and @fernape for reviewing.
| documentation/content/en/books/fdp-primer/weblate/_index.adoc | ||
|---|---|---|
| 146 | All translations link will always be visible. | |
| 199 | Nowhere... it's on my TODO list. | |
| 315 | rephrased this | |
| 315 | I've added another example, but localhost is the default; I want to explicitly show a different IP address from localhost or 127.0.0.1, in case people want to build in one machine and browse it from another. | |
| 463 | It will show this: https://docs.freebsd.org/en/articles/contributors/#contrib-additional | |
Comment Actions
Thanks … at a glance, one of the reportedly done things is only partially done …
| documentation/content/en/books/fdp-primer/weblate/_index.adoc | ||
|---|---|---|
| 123 | (I haven't checked the other _done_ comments … is there no way for Phabricator to incorporate suggestions without the end user remaking them manually?) | |
Comment Actions
I've read through it and found noting wrong with it.
Great work. I think this will make it more visible to people when it is part of the Primer.
Comment Actions
First of all, thanks for writing this document, Danilo.
The documentation translation workflow was presented in a working group dedicated to this topic at the FreeBSD Developer Summit that took place during BSDCAN 2019, since then we have been lacking adequate documentation on the subject.
The procedures described in these new chapters faithfully represent the process that has been followed over the last 4 years by documentation project volunteers for the online translation of FreeBSD Project documents.
In my opinion these new chapters should be incorporated as soon as possible, if anyone thinks that the text is not "perfect" please remember that they can always be improved later :)
As the saying goes: "Done is Better Than Perfect"
Brandi