From Fedora Project Wiki
This page is a draft only
It is still under construction and content may change. Do not rely on the information on this page.


Начиная с версии Publican 2.0, возможна автоматизированная публикация документов на сайте Fedora.

Требования

Чтобы получить доступ к функциям публикации документов, необходимо:

  • вступить в группу docs-publishers;
  • создать локальную копию книги, загрузив ее из GIT или SVN.

Подготовка

На сегодняшний день (июль 2010г.) известно о проблеме Publican, не позволяющей публиковать документы, если язык системы отличается от en-US. Если используется другой язык, перезапустите сеанс, выбрав en-US в качестве языка интерфейса.


  1. Создайте локальную копию репозитория git сайта docs.fedoraproject.org: 
    git clone ssh://USERNAME@git.fedorahosted.org/git/docs/web.git

    где USERNAME -- имя пользователя FAS.

    Большой объем загрузки
    Загрузка всех файлов может занять некоторое время даже при наличии быстрого соединения.
  2. Перейдите в каталог с загруженным web.git и создайте копию файла homepage.tmp с именем homepage.cfg: 
    cp homepage.tmp homepage.cfg
  3. Отредактируйте файл 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
  4. Убедитесь, что вы используете последнюю версию Publican. Для этого в режиме root выполните: 
    yum update publican publican-fedora

Публикация документа

Publican теперь поддерживает структуру каталогов и базу данных SQLite для управления сайтом и его содержимым. Не рекомендуется добавлять и удалять каталоги вручную как это делалось раньше.
Если вы хотите опубликовать черновик документа, следуйте инструкциям на странице подготовки черновой документации.
  1. Обновите локальную копию docs.fedoraproject.org: 
    git pull
  2. Перейдите в каталог с локальной версией документа, который надо опубликовать, и выполните: 
    publican build --embedtoc --publish --formats epub,html,html-single,pdf --langs ru-RU
  3. Перейдите в каталог publish и проверьте подкаталоги документов. В частности, убедитесь, что:
    • в качестве продукта указана Fedora (обратите внимание на заглавную букву);
    • версия верна;
    • название документа верно. Обратите внимание на заглавные буквы и пробелы. Так, например, Foo Guide не эквивалентно foo-guide
  4. Установите документ на сайте Fedora: 
    publican install_book --site_config ПУТЬ --lang ru-RU
    где PATH — путь к файлу конфигурации homepage.cfg в локальном каталоге сайта docs.fedoraproject.org на диске. Стоит отметить, что команду publican install_book можно выполнять только для одного языка.
  5. Перейдите в каталог с локальной версией сайта и выполните следующее: 
    git add .
git commit -m "ОПИСАНИЕ_ИЗМЕНЕНИЙ"
git push

Удаление документа

Для удаления документа из списка опубликованных для русского языка выполните следующее:

  1. Обновите локальную копию docs.fedoraproject.org. Перейдите в каталог с локальной копией сайта и выполните команду: 
    git pull
  2. Перейдите в каталог с локальной версией документа, который надо удалить, и выполните: 
    publican remove_book --site_config ПУТЬ --lang ru-RU
    где ПУТЬ — путь к файлу конфигурации homepage.cfg в каталоге локальной версии сайта docs.fedoraproject.org. Стоит отметить, что команду publican remove_book можно выполнять только для одного языка.
  3. Перейдите в локальный каталог документа и выполните: 
    git add .
git commit -m "ОПИСАНИЕ_ИЗМЕНЕНИЙ"
git push
  4. Publican может удалить файлы и каталоги только локально, а не в GIT. Чтобы удалить файлы из локального репозитория GIT, выполните команду 
    for f in $(git ls-files --deleted); do git rm $f; done

    После чего можно применить изменения удаленно: 

    git commit -m "Removing unused files"
git push
    Соблюдайте исключительную осторожность при вызове команды "git rm", так как неверное использование может повредить структуру сайта документации. В случае сомнений попросите о помощи.

Обновление документа

Чтобы обновить уже опубликованный документ для конкретного языка и конкретной версии Fedora, перейдите в каталог, где хранится локальная копия документа, и выполните команду publican install_book как будто установка выполняется впервые. Publican автоматически заменит старый документ новой версией.

Retrieved from "https://fedoraproject.org/w/index.php?title=Publishing_a_document_with_Publican/ru&oldid=190478"