Bug 10704 - пакету необходима документация
Summary: пакету необходима документация
Status: ASSIGNED
Alias: None
Product: Sisyphus
Classification: Development
Component: comfort (show other bugs)
Version: unstable
Hardware: all Linux
: P2 normal
Assignee: Mikhail Yakshin
QA Contact: qa-sisyphus
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2007-01-24 11:55 MSK by kirill
Modified: 2010-10-30 22:43 MSD (History)
0 users

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description kirill 2007-01-24 11:55:12 MSK 
Стоит добавить README с общим описанием проекта, можно для 
начала целиком взять письмо http://lists.altlinux.org/pipermail/sisyphus/2007-January/091917.html
(Единственно: там надо пометить те места, которые пока только в проекте)

В README стоит сделать в конце раздел Ссылки, где собрать ссылки на материалы по разработке 
Сизифа. Чтобы зацепившись за пакет comfort можно было понять, откуда уши растут. 
Что приходит на ум для этих ссылок: 
 * sisyphus.ru
 * wiki.sisyphus.ru
 * wiki.sisyphus.ru/devel
 * wiki.sisyphus.ru/devel/git
 * wiki.sisyphus.ru/devel/gear

Стоит включить в документацию пример файла .sisyphusrc, по возможности полный
и самодокументированный (можно для начала вырезать соответствующую часть упомянутого 
письма)

Стоит включить пример файл с примером настройки хостов incoming.alt и git.alt

Ну и man'ы, конечно...
Comment 1 kirill 2008-04-02 15:12:44 MSD 
ping

Если пакет уже неактуален, то может быть закрыть?
Comment 2 Mikhail Yakshin 2008-04-03 17:57:29 MSD 
Пакет актуален и в работоспособном состоянии. Смысла закрывать не вижу -
надеюсь, что руки все-таки дойдут.
Comment 3 Michael Shigorin 2010-10-30 22:43:14 MSD 
wontfix?