Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consolidate, review and update i18n and l10n docs #134

Open
emkll opened this issue Jan 15, 2021 · 5 comments · Fixed by #141
Open

Consolidate, review and update i18n and l10n docs #134

emkll opened this issue Jan 15, 2021 · 5 comments · Fixed by #141

Comments

@emkll
Copy link
Contributor

emkll commented Jan 15, 2021

(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
Copy link
Contributor

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:

  • it touches on multiple aspects of the internationalization and localization work (I'll say the "translation work" going forward)
  • it is not that easy to understand what those are without browsing multiple pages
  • some of the content is relevant to different people (regular translator, occasional translator, developer, release manager?)
  • some of the content is relevant at different times (initial setup as a translator, development time, release time, first contact with SecureDrop...)
  • it feels dispersed across multiple sections (I have a similar feeling, but I'm not sure that having multiple sections is a problem in itself.)

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:

  • Splitting the existing content by topic and after Divio's documentation system (tutorial, reference, how-to, explanation)
  • Consolidating the resulting "documents" in a section of their own so they can be consumed individually, but are organized as a whole.

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

  • is easier to consume for different people with different purposes (studying, working)
  • is easier to maintain (more modular, clearer goals for each piece of content)

@gonzalo-bulnes
Copy link
Contributor

gonzalo-bulnes commented Jan 27, 2021

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
Copy link
Contributor

@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 rmol reopened this Apr 7, 2021
@rmol
Copy link
Contributor

rmol commented Apr 7, 2021

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

@gonzalo-bulnes
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants