[docs] документация на www, или "взгляд сверху"

Anton Farygin rider на altlinux.com
Ср Окт 19 09:54:59 MSD 2005


Kirill Maslinsky wrote:

>Всем привет!
>
>http://heap.altlinux.ru/alt-docs
>
>Здесь -- первый вариант online-документации: те текущие два выпуска,
>над которыми я работаю непосредственно сейчас. Если уж говорить о 
>результатах работы и о содержательной стороне документации, то 
>прежде всего нужно смотреть на эти выпуски. 
>
>Конкретные замечания по тексту можно оставлять в багзилле -- смотрите
>ссылки "Сведения о документе". Общие соображения лучше обсуждать
>в рассылке.
>
>Несколько слов о том, как этот сайт связан с Кучей и другими 
>нашумевшими вопросами:
>	- Робот следит за обновлениями в Куче и пытается собрать (или пересобрать)
>	  пакеты с обновлёнными документами. 
>	- Собранные пакеты ставятся в chroot.
>	- Нужный каталог из chroot копируется на web. Получаем удобный 
>	  способ протестировать собранное (ведь тут всё идентично установленной
>	  оффлайновой документации), и одновременно -- сайт.
>	- После этого собранные пакеты идут в Сизиф, а на web они уже 
>	  доступны, пока в Сизиф не прошли.
>	
>Перспективы: 
>  
>  *	Потихоньку перетащить документацию по всем ещё актуальным дистрибутивам на
>  	этот же сайт -- проблема небольшая: только старые пакеты придётся
>  	пересобрать, потому как там альтернативы и абсолютные ссылки встречаются,
>  	чего web не терпит. Тащить старые выпуски в Кучу при этом совершенно
>  	необязательно.
>
>  * Оформить главную страницу документации так, чтобы она годилась и 
>    в главные страницы проекта (продумать структуру, компоновку и т. п.). 	
>	Начинаю понемногу писать документацию о проекте -- буду тоже собирать 
>	в пакеты и выкладывать таким же способом. 
>
>  
>
Если нужна помощь в скриптовании выкладки документации - говори. У меня 
сепаратор это умеет ;-)

Rgds,
Rider

P.S. Хотя лучше всего конечно на WIKI, что бы можно было обсуждать/изменять.




Подробная информация о списке рассылки docs