Project

General

Profile

Feature #16979

Feature #15085: Document our translation platform infrastructure

Feature #15086: Translation platform: Write design documentation

Clarify how to enable a new language on our translation platform

Added by intrigeri about 1 month ago. Updated about 1 month ago.

Status:
Resolved
Priority:
Normal
Assignee:
Category:
Infrastructure
Target version:
Start date:
Due date:
% Done:

100%

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

Description

  • "You need to run this script with argument `--modify`": I'm confused. Previously I'm instructed to run that script without any argument. If I have to pass --modify, let's just add it to the copy'n'pasteable command line and drop this sentence?
  • "You need to […] to actually create the missing po files and commit those files": ambiguous English grammar, this could mean either that the script with --modify will add+commit the files, or that I have to do it myself once the script has run.

I'm happy to rephrase the doc (or let u do it) once you've clarified what you meant :)

Associated revisions

Revision ff31ffcf (diff)
Added by intrigeri about 1 month ago

Improve phrasing thanks to hefee's clarifications (Closes: #16979).

This includes:

- Make instructions copy'n'paste-friendly, while taking into account
hefee's wish to encourage the reader to, well, read.
- Link to the cron.sh that one might have trouble finding otherwise.
- Various technical writing nitpicking / style guide compliance.
- Fix Markdown so that command lines are not prefixed with spaces
once rendered on our website.
- Avoid command line being partly hidden without scrolling
once rendered on our website.

History

#1 Updated by hefee about 1 month ago

  • Assignee changed from hefee to intrigeri

intrigeri wrote:

  • "You need to run this script with argument `--modify`": I'm confused. Previously I'm instructed to run that script without any argument. If I have to pass --modify, let's just add it to the copy'n'pasteable command line and drop this sentence?

My thought is, that people if they just copy&paste can't break anything and need actully to read. Otherwise they may change things that you don't want to be changed. In my ideal world people first run the command without --modify check the output and rerun it with --modify.
But i don't want to break the documentation style, if the rest is more just copy&pasteable, than I won't stop you, if you add the --modify into the command right away.

  • "You need to […] to actually create the missing po files and commit those files": ambiguous English grammar, this could mean either that the script with --modify will add+commit the files, or that I have to do it myself once the script has run.

The sentence is about what the script will do, if you run it with the --modify argument. You neither need to create the po files by hand nor commit them by hand.

I'm happy to rephrase the doc (or let u do it) once you've clarified what you meant :)

Hope this is more clear now, what I wanted to express.

#2 Updated by intrigeri about 1 month ago

Hope this is more clear now, what I wanted to express.

@hefee, yes, totally! Thank you :)

#3 Updated by intrigeri about 1 month ago

  • Status changed from Confirmed to Resolved
  • % Done changed from 0 to 100

Also available in: Atom PDF