Участие в переводах DevSchacht

Многие спрашивали нас лично и в группе Telegram: «Как начать переводить? Какую статью взять? Как её прислать вам?». Мы очень давно обещали ответить на эти вопросы. Некоторые читатели и слушатели не дождались нас (и молодцы!), собрались с духом и сделали отличные переводы. Мы лишь немножко поучаствовали.

Так как же начать переводить?

Легко! Сейчас мы опишем процесс работы над переводами, который используем сами. Он уже проверен временем и по-прежнему удобен для нас.

Выбор статьи для перевода

О, это самая большая проблема, не правда ли? Мы мониторим новостные тематические каналы в Telegram, читаем Twitter, получаем рассылки на электронную почту и даже следим за RSS (да, Андрей ничем не гнушается). Вы можете поступать точно так же (наверняка, уже).

Но как выбрать ту единственную, достойную перевода, статью? А никак. Переводите то, что вам сами близко и интересно, то, что вас мотивирует. Конечно, будет ещё круче, если ваш перевод порадует не только вас, но и заинтересует других людей. Но мы ни разу не сталкивались с тем, чтобы перевод никого не заинтересовал. Тематика может быть совершенно различной, но мы в DevSchacht ориентированы на фронтенд в широком его понимании (широком? присылайте переводы, посмотрим, на сколько широк бывает фронтенд).

Для тех, кого по каким-либо причинам не устраивает предложенный способ поиска и выбора статьи для перевода, мы создаем публичный Список желаний со списком предлагаемых к переводу статей (будет обновляться!). Этот список может быть (должен быть!) не только наш, но и ваш: смело присылайте пулл-реквесты со статьями, которые вы бы хотели прочитать на русском или перевести. Если же вы начинаете перевод статьи, пожалуйста, отмечайтесь в Списке желаний, чтобы избежать одновременного перевода одной и той же статьи.

Процесс перевода

Итак, теперь статья у вас есть. Что дальше? Переводить! Тут гарантированных советов нет: делайте так, как вам удобно. Однако перед началом перевода неплохо было бы ознакомиться с руководством по переводу, это поможет избежать многих ошибок при просмотре вашей статьи перед её публикацией. Переводите сами на лету, со словарём подмышкой или с помощью гугл-переводчика в соседнем окне — выбор ваш. Главное, что на выходе должен быть качественный перевод: и с точки зрения языка, и с точки зрения технической составляющей вопроса. Кстати, для перевода сложных технических терминов можно обращаться в словарь Веб-стандартов или в нашу группу Telegram.

Также далеко не последней составляющей хорошего перевода является грамотность набранного текста: пожалуйста, прогоняйте свои тексты хотя бы через орфограф — это хороший тон автора (ведь вы становитесь автором! мы же в свою очередь надеемся, что в этом тексте ошибок нет), — и не забывайте хотя бы один раз вычитать финальный текст перевода.

Отправка и публикация

Наверняка вы знаете, что переводы мы публикуем на Medium, но перед этим перевод обязательно появляется на GitHub. Присылайте переведенную статью пулл-реквестом в указанный репозиторий, мы обсудим, поможем и вмержим. Но тут важно соблюсти некоторый формализм:

  • В папочке articles вы создаете папку со своими переводом. Название можно получить, воспользовавшись специальной функцией-помощником (ведь все мы здесь немножко программисты) или запустить npm run create-sample, где будет предложено ввести название статьи (тогда второй пункт можно пропустить - файл уже будет создан)
  • В папочку вашего перевода необходимо положить файлик README.md с текстом перевода, отформатированный в соответствии со стандартом Markdown.
  • Картинки, гифки и другие украшательства можно вставить прямыми ссылками на оригиналы, но можно и положить файлом рядом с README.md. Если у статьи нет заглавной картинки, подберите свою, подходящую по смыслу текста.
  • После заголовка необходимо указать, что это перевод, какой статьи и чьего она авторства. Ещё лучше, если вы добудете у автора оригинала разрешение на перевод (они все дружелюбные), и похвастаетесь соответствующим уточнение об этом.
  • В конце перевода после разделительной черты (--- в markdown) по желанию вы можете вставить нашу подпись (чтобы и мы, и вы продолжали нести в массы светоч знаний).

Всё это совсем не сложно, выработано временем и направленно исключительно на удобство поддержки, сохранения и распространения накопленных знаний.

Исправление опечаток

Исправьте собственные ошибки и опечатки. Проще это сделать с помощью YaSpeller:

  • установите зависимости, запустив npm i в директории подкаста (нужен установленный Node.js);
  • совершите проверку, запустив npm test;
  • исправьте ошибки из списка обнаруженных;
  • правильно набранные слова помеченные как ошибка занесите в файл .yaspellerrc;
  • после исправлений снова запустите проверку, чтобы убедиться, что ошибок больше нет.

Публикация на Medium

После того, как пулл-реквест будет вмержен, легко простым выделением скопировать перевод из веб-версии README.md (всё: и текст, и картинки), а затем вставить его в черновик публикации на Medium. Это очень умная площадка для публикаций и она практически всю вашу вставку отработает корректно, шороховатости вы обязательно заметите и поправите. Затем вы через интерфейс Medium кастомизируете адрес статьи в соответствии с названием папочки на GitHub, проставляете теги DevSchacht и любые другие по тематике вашего перевода.

Автоматическая публикация

Вы можете выполнить следующую ниже команду, которая автоматически опубликует черновик записи из md-файла на площадку DevSchacht (вы должны уже быть там как писатель). Основной тег DevSchacht уже будет проставлен, а также в конце записи будет добавлена ссылка на GitHub, поэтому нужно только изменить адрес статьи и добавить дополнительные теги. Но прежде всего нужны установленные зависимости node, то есть выполнение npm i или yarn (yarn - предпочтительнее, т.к. там поддерживается автоподолнение по tab, что удобно при указании файла).

Токен можно получить на странице настроек, блок с заголовком Integration tokens. Он указывается только при первой публикации, при последующих его можно опустить, то есть просто выполнить yarn run publish your_article.md

Всё, оформление на Medium готово!

Если вы отправляете свой первый перевод в DevSchacht, то вам необходимо списаться с нами в группе Telegramили в приватном порядке (если у вас есть все необходимые пароли и явки, но мы не прячемся), мы добавим вас в список авторов на Medium, что даст вам возможность предложить свою публикацию на площадку DevSchacht (три вертикальные точки в самом низу вашего перевода на Medium). Затем мы подтвердим, опубликуем, напишем о событии во всех социальный сетях и вуаля! Если же вы с нами не впервые, то вы сможете предлагать свою публикацию без каких-либо дополнительных обсуждений.


Вот и всё! Поверьте, сделать перевод — это не сложно, пусть здесь и написано много слов. Присылайте свои переводы или предлагайте статьи, заслуживающие, чтобы их перевели. Не забывайте, что мы открыты и вы всегда можете обратиться к нам с вопросом или просто пообщаться с нами в группе Telegram.


Слушайте наш подкаст в iTunes и SoundCloud, читайте нас на Medium, контрибьютьте на GitHub, общайтесь в группе Telegram, следите в Twitter и канале Telegram, рекомендуйте в VK и Facebook.