Skip to content
This repository has been archived by the owner on Jan 16, 2022. It is now read-only.

Сборка документации для веб-сайта #66

Open
gko opened this issue Feb 13, 2015 · 14 comments
Open

Сборка документации для веб-сайта #66

gko opened this issue Feb 13, 2015 · 14 comments
Assignees

Comments

@gko
Copy link
Contributor

gko commented Feb 13, 2015

Надо каждую неделю генерить из наших док веб сайт и складывать в github pages, а также делать дифф между нашими доками и оригинальными доками

@gko gko self-assigned this Feb 13, 2015
@Olegas
Copy link
Contributor

Olegas commented Feb 13, 2015

Я вот не понимаю что такое diff между нашими и оригинальными.
Конечно же он будет - ведь наши доки будут на русском.
Или ты предлагаешь хранить и исходники тоже?

@gko
Copy link
Contributor Author

gko commented Feb 13, 2015

Это diff между оригиналом, с которого мы переводили и текущим оригиналом.

@Olegas
Copy link
Contributor

Olegas commented Feb 13, 2015

Значит у нас должен лежать оригинал в репе?

@gko
Copy link
Contributor Author

gko commented Feb 13, 2015

Мне кажется тут несколько вариантов:

  1. Приложить оригинал в пулл-реквест.
  2. Дать ссылку на версию оригинала в тикете или комментарии пулл реквеста.
  3. Сделать сейчас форк и отслеживать изменения относительно него, и если перевод отмечен как актуальный обновлять в форке оригинал на актуальный.

@Olegas
Copy link
Contributor

Olegas commented Feb 13, 2015

Кстати, посмотри плз на #19.
Я там сделал структуру как на оригинальном репе, но на wiki ты пишешь что доки складываются в public.
Они туда складываются в виде каком? В md или в собранyом html?
У меня в PR сейчас доки лежат в такой же структуре, как в оригинальном репе.

@Olegas
Copy link
Contributor

Olegas commented Feb 13, 2015

По поводу оригиналов - мне кажется что если начинать перевод, изменяя оригинал, то сразу видно что переводится. Опять же для этого нам надо смержить #19

@Olegas
Copy link
Contributor

Olegas commented Feb 13, 2015

Мне видится такой порядок работы

  1. Переводы делаем в md, в master
  2. Регулярно собираем результат в html (Makefile!), комитим в gh-pages

@gko
Copy link
Contributor Author

gko commented Feb 13, 2015

по поводу сборки согласен. Попробую настроить на выхах.

@vtambourine
Copy link

Форк оригинала не нужен. Достаточно иметь связь каждого текста с коммитом оригинального репозитория, с которого этот текст был переведен. Дальше, как мне кажется, удобно завести простого робота, который бы на каждый пуш в англоязычные доки сверял бы пофайлово, есть ли дифф между новым коммитом и коммитов, с которого есть перевод. Если дифф есть, то можно завести таск на обновление перевода.

Как-то так.

@Olegas
Copy link
Contributor

Olegas commented Feb 13, 2015

Вот да, мне тоже что-то подобное представлялось!

@gko
Copy link
Contributor Author

gko commented Feb 13, 2015

@vtambourine @Olegas ок, я попробую на каком-нибудь тестовом переводе сделать подобное.

@vtambourine
Copy link

А как этот вопрос решается в головном репозитории? Я не особо слежу за его тасками по локализации. Там уже есть какие-нибудь инструменты?

@gko
Copy link
Contributor Author

gko commented Feb 13, 2015

@vtambourine вроде вот тулзы для этого. Они вызываются в makefile

@Olegas
Copy link
Contributor

Olegas commented Feb 13, 2015

Так и есть. Я их в #19 к нам затащил

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants