Система управления версиями проекта Debian Documentation

Веб-страницы и большинство текстов руководств проекта документации Debian хранятся на сервере Salsa по адресу salsa.debian.org, который представляет собой версию GitLab для Debian. Для получения дополнительной информации о том, как работает этот сервис, прочтите документацию Salsa.

Всякий может загружать исходные данные с сервера Salsa, но только члены проекта документации Debian могут обновлять файлы.

Доступ к исходным данным в git

Вы можете использовать веб-интерфейс для получения доступа к файлам по одному, также просматривать изменения в каждом проекте по адресу https://salsa.debian.org/ddp-team/

Для загрузки всего руководства лучше использовать прямой доступ к серверу git. Вам нужно иметь на своей машине пакет git.

Анонимное клонирование (только для чтения) git-репозитория

Используйте эту команду для того, чтобы загрузить все файлы из одного проекта:

git clone https://salsa.debian.org/ddp-team/release-notes.git

Выполните то же для каждого проекта, локальную копию которого вы хотите получить.

Клонирование git-репозитория с правами на отправку обновлений (чтение и запись)

До получения доступа к серверу git с использованием этого метода, вам следует для начала получить права на запись. Ознакомьтесь с тем, как запросить права на обновление.

Используйте следующую команду, чтобы загрузить все файлы для одного проекта:

git clone git@salsa.debian.org:ddp-team/release-notes.git

Выполните то же для каждого проекта, локальную копию которого вы хотите получить.

Получение изменений из удалённого git-репозитория

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

git pull

Получение прав на отправку обновлений

Права на отправку обновление доступны всякому, кто желает участвовать в написании руководств. Обычно мы требуем, чтобы вы для начала прислали парочку полезных заплат.

После создания учётной записи в Salsa, запросите необходимые привилегии, нажав на ссылку Request to join в группе, либо в любом конкретном проекте по адресу https://salsa.debian.org/ddp-team/. Далее, отправьте сообщение электронной почты на адрес debian-doc@lists.debian.org, содержащее информацию о вашей работе в Debian.

Когда ваш запрос будет подтверждён, вы станете частью группы ddp-team или одного из её проектов.


Механизм автоматического обновления

Опубликованные веб-страницы текста руководств создаются на www-master.debian.org как часть обычного процесса сборки веб-сайта, который происходит каждые четыре часа.

Сценарий выполняет svn export --force svn://svn.debian.org/svn/ddp/manuals и затем make -C trunk publish.

Настроен файл сборки (makefile) для повтороной сборки каждого подкаталога (который содержит сопровождаемую документацию) и для установки файлов из каждого подкаталога в подкаталог doc/manuals/ веб-сайта. Файлы сборки для подкаталогов производны от manuals/standard.makefile.

Файлы документации создаются сценарием обновления, который можно найти в https://www.debian.org/doc/manuals/.

Файлы журналов, создаваемые сценарием обновления, могут быть найдены по адресу https://www-master.debian.org/build-logs/ddp/

Заметьте, этот процесс заново создаёт каталог /doc/manuals/. Содержание каталога /doc/ создаётся либо из webwml, либо с помощью других сценариев, например тех, которые извлекают определённые руководства из пакетов.