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

Проект документации Debian хранит свои веб-страницы и большую часть руководств в службе 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/ веб-сайта. Файлы Makefile подкаталогов наследуются из manuals/standard.makefile.

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

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

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