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

Различия

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

Ссылка на это сравнение

Следующая версия
Предыдущая версия
Следующая версия Следующая версия справа и слева
translate:команда_перевода_документации [2013/03/19 14:16]
создано
translate:команда_перевода_документации [2013/04/02 16:26]
Строка 2: Строка 2:
  
 Для координации [[docs|перевода официальной документации]],​ создания и публикации готовых русскоязычных версий всех руководств,​ создана команда [[lpteam>​ubuntu-ru-doc]]. Для координации [[docs|перевода официальной документации]],​ создания и публикации готовых русскоязычных версий всех руководств,​ создана команда [[lpteam>​ubuntu-ru-doc]].
 +
 +Для вступления в команду вы должны состоять в [[lpteam>​ubuntu-l10n-ru|основной команде переводчиков Ubuntu]] и участвовать в переводе документации.
 +
 +Команда [[lpteam>​ubuntu-ru-doc]] нужна для управления проектом [[lpproj>​ubuntu-ru-docs]],​ т.е. для публикации необходимых материалов и скриптов для сборки русских переводов руководств и для выкладывания финальных версий переводов в различных форматах.
 +
 +На этой странице собраны различные инструкции и информация для членов команды перевода документации.
 +
 +===== Основной ресурс =====
 +
 +Основным местом,​ где должны публиковаться все готовые версии руководств и куда должны выкладываться все необходимые для сборки материалы,​ является [[lpproj>​ubuntu-ru-docs|проект на Launchpad]].
 +
 +Там же существует [[lpbugs>​ubuntu-ru-docs|багтрекер]] для публикации и отслеживания сообщений об ошибках (например,​ при сборке того или иного файла).
 +
 +Подробнее про работу с этим ресурсом в последующих разделах.
 +
 +===== Сборка русских версий руководств =====
 +
 +Инструкции по сборке русских версий руководств находятся на основной странице [[docs|перевода документации]]. Их нужно поддерживать в актуальном состоянии,​ дабы любой желающий мог присоединиться к тестированию и исправлению ошибок.
 +
 +Все необходимые для сборки русских версий руководств дополнительные материалы должны выкладываться в Bazaar ветки на [[lpcode>​ubuntu-ru-docs|страницу проекта перевода документации]].
 +
 +Дабы не делать кучу отдельных веток, все файлы для русских версий всех руководств для одного релиза Ubuntu находятся в одной ветке, разложенные по папкам с именами руководств.
 +
 +Подробнее про работу с Bazaar см. ниже.
 +
 +===== Выкладывание тестовых сборок руководств =====
 +
 +В процессе вычитки и отладки необходимо постоянно формировать промежуточные сборки руководств в различных форматах. **Их не нужно выкладывать на Launchpad**. Для промежуточных сборок существует специальное пространство имён на этом ресурсе - **translate:​docs**,​ в которое можно попасть через [[?​do=media|Media Manager]].
 +
 +При выкладывании документов обязательно делайте так, чтобы в имени файла присутствовало название релиза Ubuntu, для которого предназначено руководство. Например **ubuntu-manual-precise-ru.pdf**.
 +
 +Ссылки на документы,​ выкладываемые в это пространство имён, нужно добавлять на страницы,​ посвящённые процессу сборки русской версии соответствующего руководства (список этих страниц см. на [[docs|основной странице]]).
 +
 +При создании более свежей сборки нужно просто перезаписывать существующий файл. Таким образом одно руководство для конкретной версии Ubuntu - один постоянно изменяющийся файл.
 +
 +===== Работа с Bazaar =====
 +
 +В целом, основные моменты описаны тут:
 +
 +  * https://​help.launchpad.net/​Code/​QuickStart
 +  * http://​doc.bazaar.canonical.com/​latest/​en/​mini-tutorial/​index.html
 +
 +Загружаем в профиль на [[lp>​|Launchpad]] свой публичный SSH ключ. Ставим утилиту **bzr**, далее один раз указываем ей свой логин и свое имя:
 +
 +<code bash>
 +bzr lp-login malamut
 +bzr whoami "Vadim Nevorotin <​malamut@ubuntu.com>"​
 +</​code>​
 +
 +Теперь можем начинать работу.
 +
 +==== Создание новых веток ====
 +
 +Для каждой версии Ubuntu у нас своя ветка. Для создания новой ветки в [[lpbugs>​ubuntu-ru-docs|проекте на Launchpad]] нужно сначала создать локальную ветку, а потом загрузить её на сервер.
 +
 +В нашем проекте сохраняем только различные патчи и модификации для официальных проектов. Т.е. копировать что-либо из кода основных версий руководств не надо.
 +
 +Каждая ветка должна иметь имя соответствующей редакции Ubuntu. Внутри корневого каталога должны быть подкаталоги по именам проектов документации с необходимыми файлами. В каждом подкаталоге должен быть файл ''​README''​ с описанием того, что нужно делать для модифицирования основной ветки с использованием представленных файлов.
 +
 +В качестве примера см. ветку для ''​precise'':​
 +
 +  * FIXME
 +
 +Итак, создаёте на вашем компьютере каталог с указанной структурой и с именем соответствующей версии Ubuntu. Далее создаёте bzr-ветку командой (в качестве примера используем ''​precise''​):​
 +
 +<code bash>
 +bzr init precise
 +</​code>​
 +
 +Затем переходите в каталог ветки и добавляете в неё все файлы:
 +
 +<code bash>
 +cd precise/
 +bzr add *
 +</​code>​
 +
 +И делаете первый коммит:​
 +
 +<code bash>
 +bzr commit -m "First commit in precise"​
 +</​code>​
 +
 +Всё, ветка готова для загрузки на [[lp>​|Launchpad]]. Для загрузки выполняете примерно такую команду:​
 +
 +<code bash>
 +bzr push lp:​~ubuntu-ru-doc/​ubuntu-ru-docs/​precise
 +</​code>​
 +
 +После выполнения этой команды на странице [[lpcode>​ubuntu-ru-docs|кода проекта переводов документации]] появится новая ветка. Осталось лишь привязать её к соответствующей серии (см. ниже).
 +
 +===== Работа с 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 нужны только для выкладывания финальных подготовленных версий руководств и должны создаваться только по ходу их появления.
 +
 +Для создания новой серии на [[lpproj>​ubuntu-ru-docs|главной странице проекта]] нужно просто нажать //"​Register a series"//​. Обязательно нужно что-то написать в ''​Summary'',​ например,​ "​Документация для Ubuntu 13.04 "​Raring Ringtail""​.
 +
 +После создания новой серии сразу же создаём **current** milestone (см. выше объяснение зачем это надо). Дату ему не указываем,​ но снова не забываем про ''​Summary''​. Туда можно написать что-то по типу "​Milestone для сбора багов и прочей текущей работы над переводами документации для 13.04"​.
 +
 +Не забываем прилинковывать к серии соответствующий Bazaar бранч (см. выше).
 +
 +===== Выкладывание релизов переводов =====
  
 FIXME FIXME
 +