Project

General

Profile

Feature #15086

Feature #15085: Document our translation platform infrastructure

Translation platform: Write design documentation

Added by u almost 2 years ago. Updated 3 days ago.

Status:
In Progress
Priority:
Normal
Assignee:
Category:
-
Target version:
Start date:
Due date:
% Done:

100%

Spent time:
Feature Branch:
Type of work:
Contributors documentation
Starter:
Affected tool:
Translation Platform

Description

This includes:

  • Check the doc that's in the translate-server repo, make sure it's up-to-date and correct, and ideally move whatever can be published to tails.git.

Subtasks

Feature #16979: Clarify how to enable a new language on our translation platformResolvedintrigeri

Bug #16995: translate.lizard: cron.sh fail with 'Lock wait timeout exceeded; try restarting transaction'Resolved


Related issues

Blocks Tails - Feature #15089: Write public technical report about the Translation platform Confirmed 12/19/2017

History

#1 Updated by u over 1 year ago

  • Blueprint set to https://tails.boum.org/blueprint/translation_platform

#2 Updated by u over 1 year ago

  • Status changed from Confirmed to In Progress

#3 Updated by intrigeri about 1 year ago

  • Target version changed from Tails_3.8 to Tails_3.9

#4 Updated by u about 1 year ago

  • Target version changed from Tails_3.9 to Tails_3.11

#5 Updated by u 11 months ago

  • Target version changed from Tails_3.11 to Tails_3.12

I don't see this happening as early as 3.11, but we'll work on this together with hefee.

#6 Updated by anonym 8 months ago

  • Target version changed from Tails_3.12 to Tails_3.13

#7 Updated by u 6 months ago

  • Subject changed from Write design documentation for other projects to reuse our work to Translation platform: Write design documentation for other projects to reuse our work

#8 Updated by u 6 months ago

  • Target version changed from Tails_3.13 to Tails_3.16

I'd rather do that once this has been implemented :)

#9 Updated by u 3 months ago

  • Assignee changed from u to hefee
  • Affected tool set to Translation Platform

#10 Updated by u 3 months ago

  • Status changed from In Progress to Confirmed

#11 Updated by u 3 months ago

  • Subject changed from Translation platform: Write design documentation for other projects to reuse our work to Translation platform: Write design documentation

Some information that could go into translate-server.git for future reference:

- clean the VM because files are shattered in various & unpredictible
locations

@intrigeri wrote:

I just did what I felt was good enough for these 2 things:

- Move logs to /var/log
- Turn class parameters into constants in all cases where we've never
supported setting them to a non-default value (and have no reason
to ever do so).

ulrike: I believe this fixes:

intrigeri:

I'd like to broaden the scope a bit
to also include: "make all scripts and configuration files managed by
Puppet honor the parameters of the tails::weblate class" (currently we
pass parameters to this class, honor them in some places, but
hard-code their default value in various scripts, so if someone ever
passes non-default values for these parameters, well, things won't
work™).

- Use the remaining class parameters in templates instead of
hard-coding their default value.

The end result is definitely not perfect but improving things further
would start having a pretty high cost/benefit ratio so I don't think
it's worth the effort

#12 Updated by u 3 months ago

  • Blocks Feature #15089: Write public technical report about the Translation platform added

#13 Updated by intrigeri 2 months ago

  • Description updated (diff)

#14 Updated by u 2 months ago

@hefee: I think a good start is to merge our blueprint with all information from translate-server.git that can be made public.

#15 Updated by intrigeri about 1 month ago

  • Description updated (diff)
  • Type of work changed from Communicate to Contributors documentation

#16 Updated by hefee about 1 month ago

  • Status changed from Confirmed to Needs Validation
  • Assignee changed from hefee to u
  • Feature Branch set to hefee/15086-desgin-documentation

I updated now the blueprint and added some paragraphs about the scripts that we are running.

Additionally I scanned through the translation-server.git and removed not needed stuff and updated the remaining files.

Do you see more stuff that should end up in the blueprint?

The README.mdwn is another (older) approch to describe the scripts, what do you find more readable?

#17 Updated by CyrilBrulebois 18 days ago

  • Target version changed from Tails_3.16 to Tails_3.17

#18 Updated by intrigeri 10 days ago

  • Target version changed from Tails_3.17 to Tails_4.0

#20 Updated by u 4 days ago

I'm on it!

#21 Updated by u 3 days ago

  • Status changed from Needs Validation to In Progress
  • Assignee changed from u to hefee
  • Feature Branch deleted (hefee/15086-desgin-documentation)

Hi hefee!

I've done a first review and tried to rewrite some parts that I found hard to understand. Can you please go through the document and improve the parts that I marked with "XXX"? Then reassign to me again for review please.

Thank you!

Also, you can do this directly in the master branch. Blueprints are editable for everyone, so no need to create a branch.

#22 Updated by u 3 days ago

PS I have not deleted your branch (hefee/15086-desgin-documentation). Can you do this yourself please?

#23 Updated by u 3 days ago

Some other things I've noticed:

I've started to cleanup the translate-server.git repository with information that is either obsolete or should live in our public documentation.
There are some files left though, can you please move them to a public place, after having deleted the sections that are outdated? You might want to coordinate this with intrigeri who might have some ideas on where to store this information instead.

Concerned files:

- sysadmin.mdwn → Not sure where this contents could go?
- weblate.mdwn
- tmserver.mdwn (I think this one can be deleted)

Also, I've noticed that there is a documentation in contribute/l10n_tricks that explains how to add a new language to weblate. I've now linked to this documentation from the blueprint. But I'm not sure that l10_tricks.mdwn is the right place for this documentation. I've also not checked this documentation for accuracy. Can you please do this as part of the design documentation?

Also available in: Atom PDF