Skip to content

Workflow to manage volunteer translations of W3C documents

Notifications You must be signed in to change notification settings

pkannetwork/translation-management

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

In January 2017, W3C announced it had to stop the maintenance our translation database where volunteer translations of W3C specifications and documents had been tracked.

This repository serves as a tracker for the development and deployment of a new approach to the management of volunteer translations, which would offer stronger support to volunteer translators and an improved ability to W3C to promote their translations.

The main orientations of the new system would be:

  • making it based on github - all W3C groups develop their specifications on github nowadays, and anchoring the translation work on the same platform provides opportunities for better alignment with the specification process, as well as a natural platform for collaborating on the development and maintenance of translations
  • setting up some minimal level of quality reviews on translations - the volunteer translation program has in the past been abused by spammers, which among thing meant that the value of the otherwise excellent work done by most of our translators would be diluted by some less reliable work
  • having W3C automatically publish a copy of the translated documents under its own control - this is to ensure that the useful work done by translators remain available to the community even after the said translators are no longer interested or in a position to keep it available on their own site

In more details, the new workflow would be:

  • a translator signals their intent to translate by raising an issue in a well-defined github repository (see #1)
  • as an opt-in, other translators of that language get notified of that intent (and possibly, signal their intent to help with the effort) (see #1)
  • once the translator(s) finishes the translation, they bring the translated document via a pull request to a well-defined repo
  • a team of identified reviewers for that language get notified and are expected to make a high-level review of the document to ensure a minimum level of quality (e.g. avoid spam, low-quality automated translation); optionally, these reviewers can provide more detailed feedback as non-blocking requests for enhancements (see #2)
  • via a github automated check, a number of automatic validation are run on the translation (presence of a disclaimer, HTML validity, ...) (see #2)
  • once these automated checks pass and at least one reviewer validates the translation, the translation is automatically published by W3C and linked from relevant W3C pages (see #4)
  • the same repository where the translation document was brought via a pull request is used to maintain the translations as changes in the original document or mistakes in the translation get reported (see #3)

About

Workflow to manage volunteer translations of W3C documents

Resources

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 99.2%
  • Other 0.8%