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

Различия

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

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

Предыдущая версия справа и слева Предыдущая версия
Следующая версия
Предыдущая версия
translate:команда_перевода_документации [2013/03/19 15:20]
translate:команда_перевода_документации [2013/04/02 17:46] (текущий)
Строка 4: Строка 4:
  
 Для вступления в команду вы должны состоять в [[lpteam>​ubuntu-l10n-ru|основной команде переводчиков Ubuntu]] и участвовать в переводе документации. Для вступления в команду вы должны состоять в [[lpteam>​ubuntu-l10n-ru|основной команде переводчиков Ubuntu]] и участвовать в переводе документации.
 +
 +Команда [[lpteam>​ubuntu-ru-doc]] нужна для управления проектом [[lpproj>​ubuntu-ru-docs]],​ т.е. для публикации необходимых материалов и скриптов для сборки русских переводов руководств и для выкладывания финальных версий переводов в различных форматах.
  
 На этой странице собраны различные инструкции и информация для членов команды перевода документации. На этой странице собраны различные инструкции и информация для членов команды перевода документации.
Строка 31: Строка 33:
 При выкладывании документов обязательно делайте так, чтобы в имени файла присутствовало название релиза Ubuntu, для которого предназначено руководство. Например **ubuntu-manual-precise-ru.pdf**. При выкладывании документов обязательно делайте так, чтобы в имени файла присутствовало название релиза Ubuntu, для которого предназначено руководство. Например **ubuntu-manual-precise-ru.pdf**.
  
-Ссылки на документы,​ выкладываемые в это пространство имён, нужно добавлять на страницы,​ посвящённые процессу сборки русской версии соответствующего руководства (список этих страниц см. [[docs|тут]]).+Ссылки на документы,​ выкладываемые в это пространство имён, нужно добавлять на страницы,​ посвящённые процессу сборки русской версии соответствующего руководства (список этих страниц см. на [[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 бранч (см. выше). 
 + 
 +===== Выкладывание релизов переводов ===== 
 + 
 +После тестирования,​ вычитки и подготовки готовых сборок переводов в различных форматах,​ их нужно выкладывать на Launchpad в [[lpproj>​ubuntu-ru-docs|проект перевода документации на русский язык]]. 
 + 
 +Для этого для начала нужно зарегистрировать ''​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. 
 + 
 +==== Публикация на сайте ==== 
 + 
 +После выкладывания релизов переводов того или иного руководства на [[lpproj>​ubuntu-ru-docs|Launchpad]],​ обязательно нужно добавить (или обновить) ссылки на загружаемые файлы на нашем ресурсе документации на страничке [[http://​help.ubuntu.ru/​doc|Официальной документации]]. Для каждого релиза создаётся отдельный подраздел по номеру версии,​ в этом подразделе на главной выкладываются ссылки на загружаемые файлы. 
 + 
 +См. страницу для precise для примера:​ 
 + 
 +  * [[http://​help.ubuntu.ru/​doc/​12.04/​главная]] 
 + 
 +HTML версии руководств могут быть выложены только администраторами сайта. Обращайтесь к [[user>​Malamut]] по всем вопросам,​ связанным с их выкладыванием. 
 + 
 +===== Публикация новостей ===== 
 + 
 +После добавления ссылок на страницу [[http://​help.ubuntu.ru/​doc|Официальной документации]] нужно написать новости о новом переводе на различные ресурсы. Для добавления новостей на некоторые нужно связаться с администрацией,​ на некоторые же можно выложить новость самостоятельно. 
 + 
 +<note important>​**Обратите внимание:​** всегда в качестве страницы загрузки указывайте либо основной адрес переводов официальной документации [[http://​help.ubuntu.ru/​doc]],​ либо страничку для конкретного релиза (например,​ [[http://​help.ubuntu.ru/​doc/​12.04/​главная]]). **Никогда** не публикуйте в новостях ссылки на файлы на Launchpad. Это связано с тем, что при выпуске новых версий переводов ссылки на Launchpad потеряют актуальность,​ в то время как адрес страницы с переводами документации на ''​help.ubuntu.ru''​ всегда остаётся неизменным. И уж тем более не добавляйте в новости ссылки на тестовые сборки,​ размещённые на team.ubuntu.ru,​ поскольку они в любой момент могут быть перезалиты или вообще удалены.</​note>​ 
 + 
 +Ресурсы,​ на которые можно добавить новость самостоятельно:​ 
 + 
 +  * [[http://​opennet.ru]] 
 +  * [[http://​linux.org.ru]] 
 + 
 +Ресурсы,​ на которые новость должен добавить администратор (связывайтесь по этому вопросу с [[user>​Malamut]]):​
  
-При создании более свежей сборки нужно просто перезаписывать существующий файл. Таким образом одно руководство - один постоянно изменяющийся файл.+  * [[http://​ubuntu.ru]] 
 +  * Twitter 
 +  * G+