[docs] О документации в сизифе и не в сизифе

[Kirill Maslinsky]

On Tue, Sep 02, 2008 at 11:41:19AM +0300, Artem Zolochevskiy wrote:
> 2 сентября 2008 г. 11:30 пользователь Mikhail Gusarov
> <dottedmag на altlinux.org> написал:
> > Привет.
> >
> > По поводу https://bugzilla.altlinux.org/show_bug.cgi?id=16984 - хочу
> > узнать позицию тех, кто занимается документацией, о наличии документов,
> > которые нельзя пакетировать.
> >
> > Я считаю, что вся документация, которая относится к устройству Сизифа,
> > как проекта (не как технологической платформы), в дистрибутивы/бранчи
> > попадать не должна вообще, ибо мгновенно протухает и доставляет потом
> > кучу головной боли. А учитывая, гм, "понимание" релиз-менеджеров, и в
> > Сизиф поэтому эту документацию упаковывать опасно.
> >
> 
> Моё мнение:
> - в бранчи/дистрибутивы, ничего описывающее сизиф, конечно, попадать не должно
> - в сам же Сизиф -- я ещё не определился.
>  * с одной стороны это верно, что быстро теряется актуальность
>      (но ведь можно наладить относительную автоматизацию обновления
> пакета, до соответствия версии на wiki)
>  * с другой -- иметь документацию только online, портит жизнь тем, кто
> не всю жизнь online
>      (тут я не знаю, насколько это актуальная проблема)

Мне не очень нравится идея документации, которую нельзя паковать. 

	Если документация имеет свойство быстро устаревать, то можно
	ввести полиси вешать в ней баннер (как в вики) с указанием на это 
	свойство и с адресом в Сети, где должна быть актуальная версия.
	Адрес в сети, естественно, не должен обладать свойством 
	"быстро устаревать". Это поможет уберечься от отрицательного 
	воздействия устаревших копий таких документов не только в 
	пакетах, но и в любых других местах (зеркала etc)

Я согласен с позицией, что документацию по Сизифу как проекту не следует включать 
в пользовательские дистрибутивы. 
	
	Поскольку релиз-менеджеры оных дистрибутивов обычно "не в теме", можно
	предусмотреть технические средства предотвращения попадания
	соотв. пакетов документации в дистрибутивы -- например,
	выставить конфликт на что-нибуддь дистрибутивное или зависимость
	на что-то принципиально недистрибутивное. 

	(Кстати, это может быть и более общей задачей: пакеты, которые
	не должны попасть в дистрибутив)

-- 
Kirill Maslinsky
ALT Linux Team