[docs] Re: ALT packaging docs

[Vitaly Ostanin]

Kirill Maslinsky пишет:

>Добрый день!
>
>  
>
>>>>Нужна возможность в (сделанном в каждой странице) подвале оставлять 
>>>>комментарии и поправки, которые будут фиксироваться в bugzilla;
>>>>  
>>>>        
>>>>
>>>Наверное, это стоит делать не ниже уровня chapter/article?
>>>
>>>      
>>>
>>Нет, у нас section в любой момент могут стать chapter.
>>    
>>
>
>Должна быть возможность оставлять комментарии и поправки на _каждой_ странице
>html, 
>

Естественно.

>вне зависимости от того, раздел какого уровня представлен на этой
>странице. Потому что если пользователь заметит ошибку на странице, 
>где такого подвала не оказалось
>

Таких страниц не будет.

> -- ему придётся как-то искать, к какому 
>разделу относится эта страница...
>
>  
>
>>>Еще хорошо бы добиться соответствия идентификатора главы и имени
>>>компонента в Bugzilla.
>>>      
>>>
>
>Нужно при этом иметь в виду, что разделы документации имеют тенденцию 
>перетасовываться, делиться и сливаться, исчезать и добавляться, а также 
>менять уровень, 
>

Это решается статическими id.

>поэтому нужно придумать какой-то способ соответственно обновлять список компонентов в багзилле.
>  
>

Багзилла должна уметь автоматом обновлять список компонентов. Собрать 
для неё этот список несложно.

>>Если уж углубляться сейчас в технические детали, я бы предложил 
>>компоненты задавать вручную, либо по корневому id публикуемой части 
>>документации (например, id книги, если публикуется какое из 
>>"Руководств"), либо придумать из головы. А имена пакетов брать из id 
>>того структурного элемента, на который строчится кляуза.
>>    
>>
>
>Вообще есть и другой способ сообщить об ошибках в документации: 
>вся документация упакована в rpm-пакеты, а на них штатным образом 
>можно повесить ошибку, как и на любой пакет в Сизифе.
>Нужно ли как-то разводить или совмещать этот способ с вешанием ошибок 
>именно на содержание документации?
>  
>

Аналогичный способ уже существует, только вместо rpm-пакетов вручную 
указанные компоненты в bugzilla - это крайне неэффективно.

Лично я, увидев опечатку, не полезу искать rpm, которому принадлежит 
страница, потом список багов на этот rpm, а потом заполнять новый баг на 
этот rpm. Глупо всё это делать каждый раз, когда все промежуточные 
действия между опечаткой и багом должен выполнять робот.

>>У меня уже есть стиль, который создаёт id всем структурным элементам 
>>(set|book|part|partintro и так далее), которые id не имеют.
>>
>>При именовании html по id во время сборки, проблем со связью документа и 
>>кляузы на него не должно быть.
>>    
>>
>
>Хорошее решение. Что-нибудь мешает использовать этот стиль при генерации 
>html-dir в наших Makeile'ах? 
>

Да, мешает моё непонимание этих Makefiles, и отсутствие свободного 
времени. Однако с последним их автором, Олегом Паращенко, уже достигнута 
договорённость, что я могу их переделать.

>Это всяко лучше, чем туманное "ch1s1", 
>а я стараюсь следить за тем, чтобы у каждого раздела был осмысленный id.
>  
>

Зачем следить? Можно указать в стиле выводить warning на структурные 
элементы без id, или останавливать сборку.

-- 
Regards, Vyt
mailto:  vyt at vzljot.ru
JID:     vyt at vzljot.ru

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 252 bytes
Desc: OpenPGP digital signature
Url : http://lists.altlinux.ru/pipermail/docs/attachments/20041116/e371168d/signature-0001.bin