Команда перевода документации

Для координации перевода официальной документации, создания и публикации готовых русскоязычных версий всех руководств, создана команда ubuntu-ru-doc.

Для вступления в команду вы должны состоять в основной команде переводчиков Ubuntu и участвовать в переводе документации.

Команда ubuntu-ru-doc нужна для управления проектом ubuntu-ru-docs, т.е. для публикации необходимых материалов и скриптов для сборки русских переводов руководств и для выкладывания финальных версий переводов в различных форматах.

На этой странице собраны различные инструкции и информация для членов команды перевода документации.

Основной ресурс

Основным местом, где должны публиковаться все готовые версии руководств и куда должны выкладываться все необходимые для сборки материалы, является проект на Launchpad.

Там же существует багтрекер для публикации и отслеживания сообщений об ошибках (например, при сборке того или иного файла).

Подробнее про работу с этим ресурсом в последующих разделах.

Сборка русских версий руководств

Инструкции по сборке русских версий руководств находятся на основной странице перевода документации. Их нужно поддерживать в актуальном состоянии, дабы любой желающий мог присоединиться к тестированию и исправлению ошибок.

Все необходимые для сборки русских версий руководств дополнительные материалы должны выкладываться в Bazaar ветки на страницу проекта перевода документации.

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

Подробнее про работу с Bazaar см. ниже.

Выкладывание тестовых сборок руководств

В процессе вычитки и отладки необходимо постоянно формировать промежуточные сборки руководств в различных форматах. Их не нужно выкладывать на Launchpad. Для промежуточных сборок существует специальное пространство имён на этом ресурсе - translate:docs, в которое можно попасть через Media Manager.

При выкладывании документов обязательно делайте так, чтобы в имени файла присутствовало название релиза Ubuntu, для которого предназначено руководство. Например ubuntu-manual-precise-ru.pdf.

Ссылки на документы, выкладываемые в это пространство имён, нужно добавлять на страницы, посвящённые процессу сборки русской версии соответствующего руководства (список этих страниц см. на основной странице).

При создании более свежей сборки нужно просто перезаписывать существующий файл. Таким образом одно руководство для конкретной версии Ubuntu - один постоянно изменяющийся файл.

Работа с Bazaar

В целом, основные моменты описаны тут:

Загружаем в профиль на Launchpad свой публичный SSH ключ. Ставим утилиту bzr, далее один раз указываем ей свой логин и свое имя:

bzr lp-login malamut
bzr whoami "Vadim Nevorotin <malamut@ubuntu.com>"

Теперь можем начинать работу.

Создание новых веток

Для каждой версии Ubuntu у нас своя ветка. Для создания новой ветки в проекте на Launchpad нужно сначала создать локальную ветку, а потом загрузить её на сервер.

В нашем проекте сохраняем только различные патчи и модификации для официальных проектов. Т.е. копировать что-либо из кода основных версий руководств не надо.

Каждая ветка должна иметь имя соответствующей редакции Ubuntu. Внутри корневого каталога должны быть подкаталоги по именам проектов документации с необходимыми файлами. В каждом подкаталоге должен быть файл README с описанием того, что нужно делать для модифицирования основной ветки с использованием представленных файлов.

В качестве примера см. ветку для precise:

  • FIXME

Итак, создаёте на вашем компьютере каталог с указанной структурой и с именем соответствующей версии Ubuntu. Далее создаёте bzr-ветку командой (в качестве примера используем precise):

bzr init precise

Затем переходите в каталог ветки и добавляете в неё все файлы:

cd precise/
bzr add *

И делаете первый коммит:

bzr commit -m "First commit in precise"

Всё, ветка готова для загрузки на Launchpad. Для загрузки выполняете примерно такую команду:

bzr push lp:~ubuntu-ru-doc/ubuntu-ru-docs/precise

После выполнения этой команды на странице кода проекта переводов документации появится новая ветка. Осталось лишь привязать её к соответствующей серии (см. ниже).

Работа с Series and Milestones на Launchpad, подготовка релизов переводов

Series - это глобальные этапы разработки, в нашем случае каждый релиз Ubuntu - одна серия. Именоваться они должны по кодовым именам соответствующих версий Ubuntu. Например, для Ubuntu 12.04 LTS «Precise Pangolin» серия должна называться precise.

Milestones - это этапы разработки в рамках одной серии. В нашем случае в рамках каждой серии всегда должен быть один специальный всегда активный milestone с именем серии и приставкой current (например, precise-current) для того, чтобы прилинковывать к нему все баги для данной серии. Кроме этого после подготовки финальной версии перевода для каждого из руководств нужно создавать отдельный неактивный milestone с именем вида «руководство-кодовое имя-версия перевода». Например, serverguide-precise-r1. Версии перевода нумеруются от 1 с приставкой r (r1, r2, r3 и т.д.)

Таким образом все баги (и блюпринты при наличии) всегда будут прилинковываться к current milestone, остальные же milestones нужны только для выкладывания финальных подготовленных версий руководств и должны создаваться только по ходу их появления.

Для создания новой серии на главной странице проекта нужно просто нажать «Register a series». Обязательно нужно что-то написать в Summary, например, «Документация для Ubuntu 13.04 «Raring Ringtail»».

После создания новой серии сразу же создаём current milestone (см. выше объяснение зачем это надо). Дату ему не указываем, но снова не забываем про Summary. Туда можно написать что-то по типу «Milestone для сбора багов и прочей текущей работы над переводами документации для 13.04».

Не забываем прилинковывать к серии соответствующий Bazaar бранч (см. выше).

Выкладывание релизов переводов

После тестирования, вычитки и подготовки готовых сборок переводов в различных форматах, их нужно выкладывать на Launchpad в проект перевода документации на русский язык.

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

Для каждого типа руководства нужно создавать отдельный milestone в соответствующей серии с номером релиза перевода (если в будущем перевод обновиться - номер увеличится). Например, serverguide-precise-r1. Обратите внимание: имена milestones должны быть уникальны в рамках проекта. И от них зависят различные пути для скачивания файлов. Поэтому давайте сразу же правильные имена. Подробнее про именование см. выше.

При создании milestone указывайте текущую дату в качестве «Date Targeted». Не забывайте про Summary. Например, «Перевод Ubuntu Server Guide на русский язык, первая финальная версия.».

Затем нужно перейти во вновь созданный milestone и нажать на «Create release». В качестве даты указываем текущую дату (дату релиза перевода), не забываем про «Release notes» и, при выкладывании обновлённых версий переводов, про «Changelog». Не устанавливайте галочку «Keep the precise-current milestone active»! Если её поставить, то milestone останется активным и к нему можно будет прикреплять баги и блюпринты. Поскольку мы уже сделали релиз, то нам это не надо. Для багов существует отдельный current milestone.

После создания релиза к нему, наконец, можно приложить файлы для загрузки. Для этого на странице соответствующего milestone нужно нажать «Add download file». PDF и ePub версии выкладываются напрямую, скомпилированная HTML - в архиве (если вообще такая будет создаваться).

В качестве «Description» указывайте что-то по типу «Ubuntu Server Guide 12.04 на русском (PDF)». Обязательно меняйте «File content type» на «Installer file». Кроме этого, по возможности подписывайте выкладываемые файлы своим PGP ключом из профиля. Подробнее про процесс подписи можно почитать на самом Launchpad.

Публикация на сайте

После выкладывания релизов переводов того или иного руководства на Launchpad, обязательно нужно добавить (или обновить) ссылки на загружаемые файлы на нашем ресурсе документации на страничке Официальной документации. Для каждого релиза создаётся отдельный подраздел по номеру версии, в этом подразделе на главной выкладываются ссылки на загружаемые файлы.

См. страницу для precise для примера:

HTML версии руководств могут быть выложены только администраторами сайта. Обращайтесь к по всем вопросам, связанным с их выкладыванием.

Публикация новостей

После добавления ссылок на страницу Официальной документации нужно написать новости о новом переводе на различные ресурсы. Для добавления новостей на некоторые нужно связаться с администрацией, на некоторые же можно выложить новость самостоятельно.

Обратите внимание: всегда в качестве страницы загрузки указывайте либо основной адрес переводов официальной документации http://help.ubuntu.ru/doc, либо страничку для конкретного релиза (например, http://help.ubuntu.ru/doc/12.04/главная). Никогда не публикуйте в новостях ссылки на файлы на Launchpad. Это связано с тем, что при выпуске новых версий переводов ссылки на Launchpad потеряют актуальность, в то время как адрес страницы с переводами документации на help.ubuntu.ru всегда остаётся неизменным. И уж тем более не добавляйте в новости ссылки на тестовые сборки, размещённые на team.ubuntu.ru, поскольку они в любой момент могут быть перезалиты или вообще удалены.

Ресурсы, на которые можно добавить новость самостоятельно:

Ресурсы, на которые новость должен добавить администратор (связывайтесь по этому вопросу с ):