freedomofpress / securedrop-docs

Documentation for the SecureDrop project
https://docs.securedrop.org/
Other
22 stars 26 forks source link

Consolidate, review and update i18n and l10n docs #134

Open emkll opened 3 years ago

emkll commented 3 years ago

(this issue was raised at the 2020-01-14 engineering meeting)

Describe the change

Localization and internationalization documentation is dispersed across various sections:

Release management for i18n (https://docs.securedrop.org/en/stable/development/i18n.html#release-management) are not included in the release management section (https://docs.securedrop.org/en/stable/development/release_management.html).

A reader may also benefit ### from an overview (perhaps including a diagram) of the various systems and files and flows that are relevant to internationalization (weblate, i18n_tool, babel, .po files etc...)

gonzalo-bulnes commented 3 years ago

I have no context about what points were raised during the meeting, but from my perspective this part of the documentation is indeed not easy to digest for a few reasons:

Considering @emkll's observation that the translation docs require being reviewed, updated and extended, and the fact that it's a couple of pages in total and the topic is relatively self-contained, I think these pages could be an opportunity to give a try to:

I would expect the outcome of this to be a body of documentation that:

gonzalo-bulnes commented 3 years ago

I couldn't visualize the changes well enough to draft what a table of content could look like, so I decided to spike the idea with the actual content instead. I think things don't look too bad and I'd personally give it a go, but I let you judge if that's a direction worth exploring further.

Draft PR follows.

gonzalo-bulnes commented 3 years ago

@emkll @eloquence @rmol Heads up this issue was closed because I mentioned it in the description of #141 that was recently merged.

Translations were worked on, but not i18n / release management, so you may want to cross-check if this issue fulfilled its role already or maybe should be re-opened.

rmol commented 3 years ago

Thanks, I forgot to edit the description of #141.

gonzalo-bulnes commented 3 years ago

For reference: notes for the 2021-01-14 Tech Meeting that is mentioned in the issue description.