Локализация документации #17

Activity

1. Olegas

   added

   question

   on Feb 9, 2015
2. gko commented on Feb 9, 2015

   

   gko

   on Feb 9, 2015

   Contributor

   More actions

   предлагаю это обсудить на встрече(см. #16). У них документация вся вроде по версиям идет — то есть с новым релизом появляются новые доки. Можно завести json с переводом и оригиналом для каждого раздела и сделать таску которая будет сравнивать оригинал с текущими доками на сайте и показывать для каких методов описание изменилось.
3. Olegas commented on Feb 9, 2015

   

   Olegas

   on Feb 9, 2015

   ContributorAuthor

   More actions

   Можно попробовать автоматизировать через webhooks, добавленные на основной реп iojs. Ловить комиты с правкой документации и автоматом генерировать issue в этом репе.
4. isRuslan commented on Feb 10, 2015

   

   isRuslan

   on Feb 10, 2015

   Contributor

   More actions

   Ссылка по теме: nodejs/iojs.org#33
   Думаю, лучшее что можем сделать это перевод документации.
   С генерацией, автоматизацией и хуками повременим.
5. nkt commented on Feb 10, 2015

   

   nkt

   on Feb 10, 2015

   More actions

   Мне кажется надо форкнуть основные доки, а переводы выделить в ru папку, на пример. Затем подтягивать изменения, и актуализировать перевод.
6. Olegas commented on Feb 11, 2015

   

   Olegas

   on Feb 11, 2015

   ContributorAuthor

   More actions

   Как форкнуть доки, если мы - не форк основного репа?
   Или сделать отдельный для документации?
   Что даст форк? Упростим получение патчей к исходникам?
7. nkt commented on Feb 11, 2015

   

   nkt

   on Feb 11, 2015

   More actions

   Конечно. Вроде перевод доков рельсов так делают. Следить за изменениями всегда проще, когда их накатываешь сам 😉

   То есть я предлагаю сделать так: форкаем, переводим. Как только перевод полностью готов - обновляем из оригинала и опять полностью переводим изменения. Никакого рассинхрона быть не должно.
8. YurySolovyov commented on Feb 11, 2015

   

   YurySolovyov

   on Feb 11, 2015

   Contributor

   More actions

   Хорошо было бы глянуть что делают другие группы
9. gko commented on Feb 11, 2015

   

   gko

   on Feb 11, 2015

   Contributor

   More actions

   Другие пока переводят сайт и выкладывают в виде mdшек, а затем постят в твиттер, что перевели какой-то раздел.
   Я предлагаю сделать переводы и одновременно сделать таску, которая бы собирала сайт, который мы будем постить раз в неделю на github pages, при этом там над каждым разделом сделать ссылку «original», чтобы коммюнити могло сразу увидеть и написать, что перевод неправильный.
   А также таску, которая бы делала форк последних док и сравнивала оригиналы с нашими.
10. Olegas commented on Feb 11, 2015

    

    Olegas

    on Feb 11, 2015

    ContributorAuthor

    More actions

    Можно без таски. Можно сделать вебхук и повесить его на основной реп iojs. Хук отловит пуши, проанализирует их, и напишет таски в этот реп на перевод нового.
    Я могу заняться этим.
11. gko commented on Feb 11, 2015

    

    gko

    on Feb 11, 2015

    Contributor

    More actions

    в любом случае завтра пообщаемся на эту тему. Я могу заняться настройкой этой фигулины.
12. Olegas commented on Feb 12, 2015

    

    Olegas

    on Feb 12, 2015

    ContributorAuthor

    More actions

    Подготовил PR #19
    Структура такая

    /doc
      /api
        *.md - документация
        .docs - SHA комита из iojs/io.js, с которого скопирована документация
      /api_assets - css, js
      template.html - шаблон
    /tools
      /doc - утилиты для сборки json/html
        README.md - интересное про структуру документации
    /out
      /doc
        /api - здесь появится документация после сборки
    Makefile - используем make чтобы собрать документацию
    

    Если ок - давайте мержить. Попробуйте кто-нибудь собрать )