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

Translate to russian #89

Open
vadimvildanov opened this issue Jul 3, 2018 · 13 comments
Open

Translate to russian #89

vadimvildanov opened this issue Jul 3, 2018 · 13 comments
Labels
enhancement New feature or request

Comments

@vadimvildanov
Copy link

Hello.

I want to translate all README into Russian, are there any rules for translation?

@trekhleb trekhleb added the enhancement New feature or request label Jul 4, 2018
@trekhleb
Copy link
Owner

trekhleb commented Jul 4, 2018

@vadimvildanov
Вадим, имя файла должно быть README.ru-RU.md, перевод желательно сделать "по максимуму" насколько это возможно: Insertion Sort → Сортировка Вставкой, AVL Tree → AVL дерево (?) и т.п. Спасибо за инициативу!

@vadimvildanov
Copy link
Author

Ок, спасибо за оперативный ответ!

@maksugr
Copy link

maksugr commented Jul 9, 2018

Речь только о переводе README?
Вижу, что на китайский (?) переведен только README, а все ссылки ведут на английскую версию. Видится, что толку в этом мало и при переводе нужно переводить все .md файлы и комментарии к коду.
Как при таком подходе предлагается организовать файловую структуру?

@vadimvildanov
Copy link
Author

vadimvildanov commented Jul 9, 2018

В данный момент сырой перевод, который я делаю своими силами таков: https://github.com/vadimvildanov/javascript-algorithms

Пока что предполагается к каждому readme.md класть readme.ru-RU.md, по поводу комментариев в коде пока сказать ничего не могу.

Ссылки буду подменять, когда буду перечитывать и править текст.

Если есть какие-либо предложения, то я весь во внимании.

@maksugr

@maksugr
Copy link

maksugr commented Jul 9, 2018

@vadimvildanov из предложений только подключиться и помочь) например, вижу, что идет работа над алгоритмами, мог бы взять на себя структуры данных)

@maksugr
Copy link

maksugr commented Jul 9, 2018

Но вопрос о переводе комментариев - актуальный, так как это важная часть объяснения.

@vadimvildanov
Copy link
Author

По поводу перевода комментариев, также дублировать index.js -> index.ru-RU.js ?

@maksugr

и еще, что нибудь надо от меня, чтобы переводить?

@maksugr
Copy link

maksugr commented Jul 10, 2018

@vadimvildanov

  1. index.js -> index.ru-RU.js не уверен, что лучшее решение. люди будут читать этот файл, но исполняться будет оригинальный => если "играться" нужно править оригинальный, что неудобно. нужно еще подумать.
  2. и еще, что нибудь надо от меня, чтобы переводить?
    не очень понял о чем ты) я пока предложил, что готов взять структуры данных и переводить .md файлы для них) ты можешь продолжать следовать своей логике и переводить все .md, кроме структур) а потом, если кто-то закончит свою часть раньше, синхронизируемся) буду коммитить в твой форк)
  3. на счет переводов комментариев в коде (и другого помимо .md) предлагаю подумать и решить позже в этом треде, пока есть над чем работать) плюс хотелось бы услышать мнение @trekhleb

@trekhleb
Copy link
Owner

@vadimvildanov, @maksugr спасибо за интерес и за предложения по переводам!

Касательно переводов README файлов, думаю тут подход прозрачный. При добавлении нового языка нужно создать новый README.xx-XX.md файл и положить его рядом с оригинальным README.md. Если переведены так же README файлы конкретного алгоритма или структуры данных, то из корневого README.xx-XX.md файла ссылки могут вести прямиком на соответствующие README.xx-XX.md в подпапках.

Что касается перевода комментариев, думаю, что дублировать сами файлы с алгоритмами не лучший вариант. Возникает многократное дублирование одного и того же кода, его необходимо поддерживать в 2-х, 3-х, 4-х местах (в зависимости от количества языков). Дублирование возникает так же в тестах.

Единственное решение, которое я вижу - это создавать детальные и самодостаточные локализованные README (в данном случае README.ru-RU.md), такие, что необходимость в дополнительном чтении комментариев в коде отпадет сама по себе.

Самодостаточность README может быть достигнута разными путями:

  • в каждом локализованном README можно создать подраздел "Как это работает" или "Объяснение алгоритма" с подробным объяснением кода,
  • если этого недостаточно, можно написать псевдокод с локализованными комментариями,
  • если псевдокода недостаточно, можно при необходимости вставить сам исходный код в README и уже там написать локализованные комментарии.

Основная цель пунктов выше - локализации не должны влиять на исходный код.

@joeberetta
Copy link

Всем привет, тоже заинтересовался в этой теме, и хотелось бы поучаствовать в локализации. Может нужна какая помощь?

@vadimvildanov
Copy link
Author

@joeberetta у меня в данный момент совершенно не хватает времени переводить, поэтому при желании можешь форкнуть мои изменения и продолжать делать.

@alexstulov
Copy link
Contributor

Сейчас есть ссылки на все переводы только с главной страницы. Что если в каждом README.md добавить аналогичные ссылки? Тогда пре переходе по ссылке в коде на английскую доку пользователь может следующим кликом перейти в доку на требуемом языке.

@trekhleb
Copy link
Owner

@kinospro да, такой вариант тоже возможен.

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

No branches or pull requests

5 participants