(Marked as old as it needs to be updated.) |
|||
(5 intermediate revisions by one other user not shown) | |||
Line 1: | Line 1: | ||
{{old}} | |||
{{autolang}} | {{autolang}} | ||
{{Template:Ru_RU/SideMenu}} | |||
Начиная с версии '''Publican 2.0''', возможна автоматизированная публикация документов на сайте Fedora. | Начиная с версии '''Publican 2.0''', возможна автоматизированная публикация документов на сайте Fedora. | ||
==Требования== | ==Требования== | ||
Чтобы получить доступ к | Чтобы получить доступ к возможностям публикации документов, необходимо: | ||
* вступить в группу [https://admin.fedoraproject.org/accounts/group/view/docs-publishers docs-publishers]; | * вступить в группу [https://admin.fedoraproject.org/accounts/group/view/docs-publishers docs-publishers]; | ||
* создать локальную копию книги, загрузив ее из GIT или SVN. | * создать локальную копию книги, загрузив ее из GIT или SVN. | ||
Line 10: | Line 11: | ||
==Подготовка== | ==Подготовка== | ||
<!-- Use <ol> and <li> so we can embed <pre> inside --> | <!-- Use <ol> and <li> so we can embed <pre> inside --> | ||
{{admon/warning|На сегодняшний день (июль 2010г.) известно о проблеме Publican, не позволяющей публиковать документы, если язык системы отличается от en-US. Если используется другой язык, | {{admon/warning|На сегодняшний день (июль 2010г.) известно о проблеме Publican, не позволяющей публиковать документы, если язык системы отличается от en-US. Если используется другой язык, начните другой сеанс, выбрав en-US в качестве языка интерфейса.}} | ||
<ol><li>Создайте локальную копию репозитория git сайта docs.fedoraproject.org: | <ol><li>Создайте локальную копию репозитория git сайта docs.fedoraproject.org: | ||
<pre>git clone ssh:// | <pre>git clone ssh://ИМЯ@git.fedorahosted.org/git/docs/web.git</pre> | ||
где ''''' | где '''''ИМЯ''''' — имя пользователя FAS. | ||
{{admon/note | Большой объем загрузки | Загрузка всех файлов может занять некоторое время даже при наличии быстрого соединения.}}</li> | {{admon/note | Большой объем загрузки | Загрузка всех файлов может занять некоторое время даже при наличии быстрого соединения.}}</li> | ||
<li>Перейдите в каталог с загруженным '''web.git''' и создайте копию файла '''homepage.tmp''' с именем '''homepage.cfg''': | <li>Перейдите в каталог с загруженным '''web.git''' и создайте копию файла '''homepage.tmp''' с именем '''homepage.cfg''': | ||
Line 47: | Line 48: | ||
<li>Установите документ на сайте Fedora: | <li>Установите документ на сайте Fedora: | ||
<pre>publican install_book --site_config ПУТЬ --lang ru-RU</pre> | <pre>publican install_book --site_config ПУТЬ --lang ru-RU</pre> | ||
где ''''' | где '''''ПУТЬ''''' — путь к файлу конфигурации '''homepage.cfg''' в локальном каталоге сайта docs.fedoraproject.org на диске. Стоит отметить, что команду '''publican install_book''' можно выполнять только для одного языка.</li> | ||
<li>Перейдите в каталог с локальной версией сайта и выполните следующее: | <li>Перейдите в каталог с локальной версией сайта и выполните следующее: | ||
Line 57: | Line 58: | ||
Для удаления документа из списка опубликованных для русского языка выполните следующее: | Для удаления документа из списка опубликованных для русского языка выполните следующее: | ||
<ol><li> | <ol><li>Обновите локальную копию docs.fedoraproject.org. Перейдите в каталог с локальной копией сайта и выполните команду: | ||
<pre>git pull</pre></li> | <pre>git pull</pre></li> | ||
<li> | <li>Перейдите в каталог с локальной версией документа, который надо удалить, и выполните: | ||
<pre>publican remove_book --site_config | <pre>publican remove_book --site_config ПУТЬ --lang ru-RU</pre> | ||
где '''''ПУТЬ''''' — путь к файлу конфигурации '''homepage.cfg''' в каталоге локальной версии сайта docs.fedoraproject.org. Стоит отметить, что команду '''publican remove_book''' можно выполнять только для одного языка.</li> | |||
<li>Перейдите в локальный каталог документа и выполните: | <li>Перейдите в локальный каталог документа и выполните: | ||
<pre>git add . | <pre>git add . | ||
git commit -m " | git commit -m "ОПИСАНИЕ_ИЗМЕНЕНИЙ" | ||
git push</pre></li> | git push</pre></li> | ||
<li>Publican | <li>Publican может удалить файлы и каталоги только локально, а не в GIT. Чтобы удалить файлы из локального репозитория GIT, выполните команду | ||
<pre>for f in $(git ls-files --deleted); do git rm $f; done </pre> | <pre>for f in $(git ls-files --deleted); do git rm $f; done </pre> | ||
После чего можно применить изменения удаленно: | |||
<pre>git commit -m" | <pre>git commit -m "Removing unused files" | ||
git push</pre> | git push</pre> | ||
{{admon/warning| | {{admon/warning|Соблюдайте исключительную осторожность при вызове команды "git rm", так как неверное использование может повредить структуру сайта документации. В случае сомнений попросите о помощи.}}</li></ol> | ||
==Обновление документа== | ==Обновление документа== |
Latest revision as of 20:12, 25 March 2014
- Страницы на русском
Начиная с версии Publican 2.0, возможна автоматизированная публикация документов на сайте Fedora.
Требования
Чтобы получить доступ к возможностям публикации документов, необходимо:
- вступить в группу docs-publishers;
- создать локальную копию книги, загрузив ее из GIT или SVN.
Подготовка
- Создайте локальную копию репозитория git сайта docs.fedoraproject.org:
git clone ssh://ИМЯ@git.fedorahosted.org/git/docs/web.git
где ИМЯ — имя пользователя FAS.
- Перейдите в каталог с загруженным web.git и создайте копию файла homepage.tmp с именем homepage.cfg:
cp homepage.tmp homepage.cfg
- Отредактируйте файл homepage.cfg, добавив абсолютные пути к fedoradocs.db и каталогу public_html. Так, например, если вы загрузили web.git в каталог fedoradocs, файл homepage.cfg будет выглядеть примерно так:
# Config::Simple 4.59 # Tue May 11 13:53:03 2010 db_file: /home/jsmith/fedoradocs/web/fedoradocs.db toc_path: /home/jsmith/fedoradocs/web/public_html
- Убедитесь, что вы используете последнюю версию Publican. Для этого в режиме root выполните:
yum update publican publican-fedora
Публикация документа
- Обновите локальную копию docs.fedoraproject.org:
git pull
- Перейдите в каталог с локальной версией документа, который надо опубликовать, и выполните:
publican build --embedtoc --publish --formats epub,html,html-single,pdf --langs ru-RU
- Перейдите в каталог publish и проверьте подкаталоги документов. В частности, убедитесь, что:
- в качестве продукта указана Fedora (обратите внимание на заглавную букву);
- версия верна;
- название документа верно. Обратите внимание на заглавные буквы и пробелы. Так, например, Foo Guide не эквивалентно foo-guide
- Установите документ на сайте Fedora:
publican install_book --site_config ПУТЬ --lang ru-RU
где ПУТЬ — путь к файлу конфигурации homepage.cfg в локальном каталоге сайта docs.fedoraproject.org на диске. Стоит отметить, что команду publican install_book можно выполнять только для одного языка. - Перейдите в каталог с локальной версией сайта и выполните следующее:
git add . git commit -m "ОПИСАНИЕ_ИЗМЕНЕНИЙ" git push
Удаление документа
Для удаления документа из списка опубликованных для русского языка выполните следующее:
- Обновите локальную копию docs.fedoraproject.org. Перейдите в каталог с локальной копией сайта и выполните команду:
git pull
- Перейдите в каталог с локальной версией документа, который надо удалить, и выполните:
publican remove_book --site_config ПУТЬ --lang ru-RU
где ПУТЬ — путь к файлу конфигурации homepage.cfg в каталоге локальной версии сайта docs.fedoraproject.org. Стоит отметить, что команду publican remove_book можно выполнять только для одного языка. - Перейдите в локальный каталог документа и выполните:
git add . git commit -m "ОПИСАНИЕ_ИЗМЕНЕНИЙ" git push
- Publican может удалить файлы и каталоги только локально, а не в GIT. Чтобы удалить файлы из локального репозитория GIT, выполните команду
for f in $(git ls-files --deleted); do git rm $f; done
После чего можно применить изменения удаленно:
git commit -m "Removing unused files" git push
Обновление документа
Чтобы обновить уже опубликованный документ для конкретного языка и конкретной версии Fedora, перейдите в каталог, где хранится локальная копия документа, и выполните команду publican install_book как будто установка выполняется впервые. Publican автоматически заменит старый документ новой версией.