Это старая версия документа.


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

Для координации перевода официальной документации, создания и публикации готовых русскоязычных версий всех руководств, создана команда 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 нужны только для выкладывания финальных подготовленных версий руководств.