weblate icon indicating copy to clipboard operation
weblate copied to clipboard

Add translating tutorial to the documentation

Open nijel opened this issue 3 years ago • 8 comments

Having something like Wrblate tutorial on the LSTN website as part of our documentation would be great. It could be probably added to https://docs.weblate.org/en/latest/user/basic.html.

Originally posted by @allie-tatarian in https://github.com/WeblateOrg/weblate/discussions/5771#discussioncomment-769597

CC @orangesunny

nijel avatar Jun 11 '21 07:06 nijel

This issue seems to be a good fit for newbie contributors. You are welcome to contribute to Weblate! Don't hesitate to ask any questions you would have while implementing this.

You can learn about how to get started in our contributors documentation.

github-actions[bot] avatar Jun 11 '21 08:06 github-actions[bot]

Has anyone asked for it? Is it meant to be simple, or focus on what is important. Both?

comradekingu avatar Jun 12 '21 06:06 comradekingu

I've seen few projects having something like this on their wiki, so apparently it's something missing in our docs

nijel avatar Jun 13 '21 12:06 nijel

They do, yes. I have helped fix some. Not convinced they get read or do a lot of good if they are. If effort is to be put into translating this, then it ought to make sense.

I would want something that gets new users up to speed and avoids the common misconceptions. Basically what I want is useful translators, and people reading documentation is a good place to start. Something like this with images and a lot of links:

Navigate to something you want to contribute to.[]

The basic functionality is one field with a source string, and then an open field below (or next to) it to put your translation in. This depends on the editor you pick. []

If your translation works, but isn't perfect, mark it as "Needs work".[] If you are unsure your translation works, you can make that a suggestion[], for someone else to implement.

What you want to arrive at is a natural representation of what a string does, in your own language. The particular nature and conventions used in the source string are not important.

If the quality isn't there in the original string, you should always fix it. A lot of source strings can be edited directly[], and/or you can leave suggestions just like any other language, or at the very least point out the error in a comment[].

If direct editing is not possible, you will most often find a link to the source code repository next to the string,[] and if not, in the "Info" field of the project.[]

You can keep an eye out for errors in languages you know by adding them as secondary languages.[] That will often help you piece together a translation in your language.

Always go over what you have translated, and make sure errors [] are fixed, or dismissed.[]

comradekingu avatar Jun 13 '21 17:06 comradekingu

Would https://github.com/WeblateOrg/weblate/blob/main/docs/user/translating.rst be the place?

comradekingu avatar Jun 28 '21 03:06 comradekingu

Would https://github.com/WeblateOrg/weblate/blob/main/docs/user/translating.rst be the place?

I feel this article is too complex to include the new part. I see two options on where to place this:

  1. In the basics, as @nijel suggested in the first comment here ⬆️
  2. A new article called "Quick start guide"

What do you think, @comradekingu?

orangesunny avatar Jun 28 '21 08:06 orangesunny

I think the current translating.rst is a middleground a bit short of complete basics and useful speedups. Adding what I don't think anyone reaching the documentation to read it needs, doesn't help simplify anything if it is a document not called "translating". Adding redundant pages in the documentation takes away from a use that is known to exist.

I am more inclined to add my hints to the document, but some short basics could be included too for the visual representation of how advanced concepts work. Could cut it down the current offering a bit too maybe.

comradekingu avatar Jun 30 '21 19:06 comradekingu

I also created a little "How To" for translators who are new to "our" implementation and the way we work with "iLP" (our iLocIT implementation of Weblate). See https://www.ilocit.de/en/ilp-translator

ilocit avatar Sep 29 '21 06:09 ilocit