[devel] полиси -- в incoming/docs!

[devel] полиси -- в incoming/docs!

[Kirill Maslinsky]

Здравствуйте, господа!

Имею честь сообщить, что репозиторий исходных текстов проекта 
ALT Docs Team (известный также под именем ``Куча'') открыт 
в тестовом режиме. 

Предлагаю в качестве первых документов для помещения в Кучу 
взять разнообразные полиси ALT, поэтому обращаюсь в первую 
очередь к авторам таких полиси. После чего можно будет 
централизованно опубликовать все полиси, например, на 
сайте docs.altlinux.ru.

Для того, чтобы поместить документ в Кучу, нужно (всего лишь) сопроводить 
его паспортом (основная информация о документе, файл в десяток полей)
и сведениями об условиях распространения и запаковать в тарболл. 
Подробное описание, как это сделать, оно же пример: 
ftp://ftp.altlinux.org/pub/docs/adt_policy.tar.gz

Формат документа может быть _любой_.

Для того, чтобы получить доступ на запись в incoming/docs, нужно 
сообщить на joindocs@ о своём желании. Если у вас уже есть доступ 
к incoming/Sisyphus, то единственное, что от Вас потребуется -- 
название Вашей учётной записи in_{псевдоним}. 
Все подробности см. в полиси проекта Docs по указанному ftp://

Прошу участвовать!

-- 
Kirill Maslinsky
ALT Linux Documentation Team

[devel] Re: полиси -- в incoming/docs!

[Michael Shigorin]

[-- Attachment #1: Type: text/plain, Size: 724 bytes --]

On Tue, Feb 08, 2005 at 10:31:13AM +0300, Kirill Maslinsky wrote:
> Предлагаю в качестве первых документов для помещения в Кучу 
> взять разнообразные полиси ALT, поэтому обращаюсь в первую 
> очередь к авторам таких полиси. После чего можно будет 
> централизованно опубликовать все полиси, например, на 
> сайте docs.altlinux.ru.

Попробую добраться до XMMS packaging policy и apache tips.

> ftp://ftp.altlinux.org/pub/docs/adt_policy.tar.gz

Эээ... боюсь, не только я "обрадовался" тому, что в этом примере
содержимое не инкапсулировано в _один_ каталог adt_policy/ 

Мож это лучше пофиксить на старте?

-- 
 ---- WBR, Michael Shigorin <mike@altlinux.ru>
  ------ Linux.Kiev http://www.linux.kiev.ua/

[-- Attachment #2: Type: application/pgp-signature, Size: 189 bytes --]

[devel] Re: полиси -- в incoming/docs!

[Michael Shigorin]

On Tue, Feb 08, 2005 at 10:31:13AM +0300, Kirill Maslinsky wrote:
> Подробное описание, как это сделать, оно же пример: 

Эээ... предлагаю:

--- Language: ru
+++ Locale: ru_RU.KOI8-R

(здесь locale может быть более ёмким понятием -- например,
документ о трёхъязычной раскладке, который когда-то писал,
был бы засунут как ru_UA.* сообразно применимости)

-- 
 ---- WBR, Michael Shigorin <mike@altlinux.ru>
  ------ Linux.Kiev http://www.linux.kiev.ua/

Re: [devel] Re: полиси -- в incoming/docs!

[Kirill Maslinsky]

Доброе утро!

> > Подробное описание, как это сделать, оно же пример: 
> 
> Эээ... предлагаю:
> 
> --- Language: ru
> +++ Locale: ru_RU.KOI8-R
> 
> (здесь locale может быть более ёмким понятием -- например,
> документ о трёхъязычной раскладке, который когда-то писал,
> был бы засунут как ru_UA.* сообразно применимости)

А нужно ли так усложнять? Поле Language: вводилось для того, 
чтобы иметь возможность подбирать документацию на разных 
языках. И обычно документ написан на одном языке, даже если
он про какой-то другой язык. Русскоязычный учебник украинского, 
например, это документ на русском языке, пусть и с украинскими
примерами. А что касается указания кодировки -- то зачем? 
Если человеку понадобился документ из Кучи, так он разберётся, 
в какой кодировке этот документ. А для паспорта документа 
у нас кодировка пока фиксированная. 

-- 
Kirill Maslinsky
ALT Linux Documentation Team

Re: [devel] Re: полиси -- в incoming/docs!

[Kirill Maslinsky]

Доброе утро!

> Попробую добраться до XMMS packaging policy и apache tips.

Ждём!

> > ftp://ftp.altlinux.org/pub/docs/adt_policy.tar.gz
> 
> Эээ... боюсь, не только я "обрадовался" тому, что в этом примере
> содержимое не инкапсулировано в _один_ каталог adt_policy/ 
> 
> Мож это лучше пофиксить на старте?

Исправлено вместе с полиси, залита новая версия по тому же адресу.

-- 
Kirill Maslinsky
ALT Linux Documentation Team

[devel] Re: полиси -- в incoming/docs!

[Michael Shigorin]

On Thu, Feb 10, 2005 at 09:52:30AM +0300, Kirill Maslinsky wrote:
> > > Подробное описание, как это сделать, оно же пример: 
> > Эээ... предлагаю:
> > --- Language: ru
> > +++ Locale: ru_RU.KOI8-R
> > (здесь locale может быть более ёмким понятием -- например,
> > документ о трёхъязычной раскладке, который когда-то писал,
> > был бы засунут как ru_UA.* сообразно применимости)
> А нужно ли так усложнять?

Подумав -- нет.  _Возможно_, _когда-нибудь_, _если_ возникнет
такая необходимость -- можно добавить опциональное. :)

> А для паспорта документа у нас кодировка пока фиксированная. 

Какая, кстати? (если не сказать -- боюсь, будут разночтения)

-- 
 ---- WBR, Michael Shigorin <mike@altlinux.ru>
  ------ Linux.Kiev http://www.linux.kiev.ua/

Re: [devel] Re: полиси -- в incoming/docs!

[Kirill Maslinsky]

Доброе утро!

> > А для паспорта документа у нас кодировка пока фиксированная. 
> 
> Какая, кстати? (если не сказать -- боюсь, будут разночтения)

Миша, Вы такой активный участник наших обсуждений, что Вам, 
как никому другому, нужно прочитать adt_policy до конца. ;)
(там среди прочего указано, какая кодировка). 
И, кстати, жду от Вас письма на joindocs@ а потом Ваших полиси --
ведь упаковать их совсем не долго. 

PS no offrence :)

-- 
Kirill Maslinsky
ALT Linux Documentation Team

[devel] Re: полиси -- в incoming/docs!

[Michael Shigorin]

On Thu, Feb 10, 2005 at 09:53:41AM +0300, Kirill Maslinsky wrote:
> > Попробую добраться до XMMS packaging policy и apache tips.
> Ждём!

Так... где логично обсуждать "policy vs notes" -- здесь (ибо
может быть интересно/полезно другим $MAINTAINER) или в docs@?

Дело в том, что у меня по факту про xmms рассказано, как
упаковывать дополнения -- т.е. для разработчика (и неплохо бы
добавить отдельный документ для _пользователя_ об особенностях
сборки), а вот про apache -- наоборот, имеющиеся макросы,
добавляемые apache-devel, нигде не освещены, зато заметки для
администратора уже в каком-то минимальном виде зафиксированы.

При этом оба документа в итоге укладываются в README.ALT
соответствующих пакетов.

Т.е. планируется выравнивать, но -- маємо те, що маємо (c)

-- 
 ---- WBR, Michael Shigorin <mike@altlinux.ru>
  ------ Linux.Kiev http://www.linux.kiev.ua/

[devel] Re: полиси -- в incoming/docs!

[Michael Shigorin]

[-- Attachment #1: Type: text/plain, Size: 775 bytes --]

On Thu, Feb 10, 2005 at 10:50:15AM +0300, Kirill Maslinsky wrote:
> > > А для паспорта документа у нас кодировка пока фиксированная. 
> > Какая, кстати? (если не сказать -- боюсь, будут разночтения)
> Миша, Вы такой активный участник наших обсуждений, что Вам, 
> как никому другому, нужно прочитать adt_policy до конца. ;)

Ahem. :)  Читал, но, видимо, давно.  С тех пор диагоналил
"так-что-изменилось".

> (там среди прочего указано, какая кодировка). 

Я-то как дурень grep KOI :)

> И, кстати, жду от Вас письма на joindocs@ а потом Ваших полиси
> -- ведь упаковать их совсем не долго. 

Ну так уже. :)

> PS no offrence :)

"Just kiddin'" (TM) :)

-- 
 ---- WBR, Michael Shigorin <mike@altlinux.ru>
  ------ Linux.Kiev http://www.linux.kiev.ua/

[-- Attachment #2: Type: application/pgp-signature, Size: 189 bytes --]

Re: [devel] Re: полиси -- в incoming/docs!

[Kirill Maslinsky]

Привет!

> > > Попробую добраться до XMMS packaging policy и apache tips.
> > Ждём!
> 
> Так... где логично обсуждать "policy vs notes" -- здесь (ибо
> может быть интересно/полезно другим $MAINTAINER) или в docs@?
Технические подробности -- лучше в docs@, содержательные -- 
здесь. 

> Дело в том, что у меня по факту про xmms рассказано, как
> упаковывать дополнения -- т.е. для разработчика (и неплохо бы
> добавить отдельный документ для _пользователя_ об особенностях
> сборки), а вот про apache -- наоборот, имеющиеся макросы,
> добавляемые apache-devel, нигде не освещены, зато заметки для
> администратора уже в каком-то минимальном виде зафиксированы.

Предложение выкладывать в Кучу в первую очередь разные полиси 
выросло из идеи сделать выпуск документации для разработчика _и_
пользователя Сизифа. Эти полиси необходимы для включения в сообщество, 
а знают об их расположении только посвящённые, которым уже 
надоело повторять ссылки на рассылки. Первая попытка сделать
такой выпуск -- пакет alt-docs-devel.

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

Так что кладите, Миша, кладите ;)

> При этом оба документа в итоге укладываются в README.ALT
> соответствующих пакетов.

И это совершенно не противоречит тому, чтобы они появились в Куче. 

-- 
Kirill Maslinsky
ALT Linux Documentation Team

Re: [devel] полиси -- в incoming/docs!

[Mikhail Zabaluev]

[-- Attachment #1: Type: text/plain, Size: 944 bytes --]

В Втр, 08/02/2005 в 10:31 +0300, Kirill Maslinsky пишет:
> Предлагаю в качестве первых документов для помещения в Кучу 
> взять разнообразные полиси ALT, поэтому обращаюсь в первую 
> очередь к авторам таких полиси. После чего можно будет 
> централизованно опубликовать все полиси, например, на 
> сайте docs.altlinux.ru.
> 
> Для того, чтобы поместить документ в Кучу, нужно (всего лишь) сопроводить 
> его паспортом (основная информация о документе, файл в десяток полей)

Хм... я когда-то осторожно высказывался насчет OMF... Still no?

> и сведениями об условиях распространения и запаковать в тарболл. 
> Подробное описание, как это сделать, оно же пример: 
> ftp://ftp.altlinux.org/pub/docs/adt_policy.tar.gz
> 
> Формат документа может быть _любой_.

Я нахожу несколько ироничным, что _это_ policy выполнено в виде
текстового файла с "гиперссылками" вида @Формат документа@,
когда у нас уже давно в ходу DocBook.


[-- Attachment #2: Эта часть сообщения подписана цифровой подписью --]
[-- Type: application/pgp-signature, Size: 189 bytes --]

[devel] Re: полиси -- в incoming/docs!

[Michael Shigorin]

[-- Attachment #1: Type: text/plain, Size: 950 bytes --]

On Fri, Feb 11, 2005 at 02:36:16AM +0300, Mikhail Zabaluev wrote:
> > и сведениями об условиях распространения и запаковать в тарболл. 
> > Подробное описание, как это сделать, оно же пример: 
> > ftp://ftp.altlinux.org/pub/docs/adt_policy.tar.gz
> > Формат документа может быть _любой_.
> Я нахожу несколько ироничным, что _это_ policy выполнено в виде
> текстового файла с "гиперссылками" вида @Формат документа@,
> когда у нас уже давно в ходу DocBook.

Тёзка, читайте обсуждение в docs@ за последних пару месяцев.

_Править_ по мелочи сконвертированное в DB я, например, скорее
возьмусь, а вот _писать_ /это/ -- увольте, спасибо.

"видеть не могу этот XML" (c) vyt@ (после медовой недели с, iirc)

PS: тем не менее, читая полиси, не мог отделаться от мысли о том,
что конвертор в Официальный Формат всё-таки пока отсутствует.

-- 
 ---- WBR, Michael Shigorin <mike@altlinux.ru>
  ------ Linux.Kiev http://www.linux.kiev.ua/

[-- Attachment #2: Type: application/pgp-signature, Size: 189 bytes --]

[devel] apache notes -- comments wanted

[Michael Shigorin]

On Thu, Feb 10, 2005 at 12:46:29PM +0300, Kirill Maslinsky wrote:
> > Так... где логично обсуждать "policy vs notes" -- здесь (ибо
> > может быть интересно/полезно другим $MAINTAINER) или в docs@?
> Технические подробности -- лучше в docs@, содержательные --
> здесь. 

OK.

2 devel: кто пользуется/собирает -- если не сильно лень, гляньте
ftp://ftp.altlinux.ru/pub/docs/apache_policy.tar.gz, там скорее
всего много notes забыто.

Про web packaging policy просто так думать не брошу, но Большое и
Светлое сейчас не светит, потому что соответствующих пакетов
будет по пальцам одной руки (без правок исходного кода в довольно
большом масштабе по количеству -- на эту провокацию сообщества я
тихо созреваю, но далеко не готов).  Поэтому пока вспоминайте,
что ещё приходится рутинно делать в хозяйстве, и вешайте баги.

Опять же в связи с ростом количества httpd в сизифе надо бы
/var/www (как минимум) выносить в *-common.

Да, и прежде чем пинать -- проверьте, что apache из Daedalus
необходимое ещё не включает ;-)

> Так что кладите, Миша, кладите ;)

Так положил ;-)

-- 
 ---- WBR, Michael Shigorin <mike@altlinux.ru>
  ------ Linux.Kiev http://www.linux.kiev.ua/

Re: [devel] полиси -- в incoming/docs!

[Kirill Maslinsky]

Добрый день!

> > Для того, чтобы поместить документ в Кучу, нужно (всего лишь) сопроводить 
> > его паспортом (основная информация о документе, файл в десяток полей)
> 
> Хм... я когда-то осторожно высказывался насчет OMF... Still no?

Хм, а Вы можете предложить, как именно OMF может 
пригодиться нашему проекту (или наш проект -- OMF'у)?

-- 
Kirill Maslinsky
ALT Linux Documentation Team

[devel] Re: OMF docs (was: полиси -- в incoming/docs!)

[Vitaly Ostanin]

[-- Attachment #1: Type: text/plain, Size: 361 bytes --]

Mikhail Zabaluev пишет:

<skipped/>

>>Для того, чтобы поместить документ в Кучу, нужно (всего лишь) сопроводить
>>его паспортом (основная информация о документе, файл в десяток полей)
>
> Хм... я когда-то осторожно высказывался насчет OMF... Still no?

Поделитесь ссылкой, пожалуйста.

<skipped/>

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

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 256 bytes --]

Re: [devel] Re: полиси -- в incoming/docs!

[Kirill Maslinsky]

Добрый день!

> > Я нахожу несколько ироничным, что _это_ policy выполнено в виде
> > текстового файла с "гиперссылками" вида @Формат документа@,
> > когда у нас уже давно в ходу DocBook.

Знаете, мне так писать удобнее. Особенно потому, что текст полиси
пока ещё далеко не устоялся, и я его переписываю много и основательно. 
На разметку в docbbok в процессе ушло бы очень много лишних сил и 
времени, даже с наиудобнейшим emacs-mode-psgml.
В конце концов, Кучу мы для того и организовали, чтобы авторы
могли писать, как им нравится.

Что касается гиперссылок... ну Вы же поняли, что это гиперссылки. 
Значит по крайней мере одно качество у этого формата есть -- прозрачность 
для читателя.

> PS: тем не менее, читая полиси, не мог отделаться от мысли о том,
> что конвертор в Официальный Формат всё-таки пока отсутствует.

Вот договоримся, что такое Официальный формат, будет и конвертер.
Вообще дискуссию о форматах предлагаю вести по существу и в docs@.

-- 
Kirill Maslinsky
ALT Linux Documentation Team

Re: [devel] Re: OMF docs (was: полиси -- в incoming/docs!)

[Yuri N. Sedunov]

[-- Attachment #1: Type: text/plain, Size: 531 bytes --]

В Птн, 11/02/2005 в 16:21 +0300, Vitaly Ostanin пишет:
> Mikhail Zabaluev пишет:
> 
> <skipped/>
> 
> >>Для того, чтобы поместить документ в Кучу, нужно (всего лишь) сопроводить
> >>его паспортом (основная информация о документе, файл в десяток полей)
> >
> > Хм... я когда-то осторожно высказывался насчет OMF... Still no?
> 
> Поделитесь ссылкой, пожалуйста.

По большому секрету, первая ссылка на
http://scrollkeeper.sourceforge.net
это
http://metalab.unc.edu/osrt/omf/

--
Yuri N. Sedunov
02/11/05 16:28:41

[-- Attachment #2: Эта часть сообщения подписана цифровой подписью --]
[-- Type: application/pgp-signature, Size: 189 bytes --]

[devel] OMF docs (was: полиси -- в incoming/docs!)

[Mikhail Zabaluev]

[-- Attachment #1: Type: text/plain, Size: 672 bytes --]

В Птн, 11/02/2005 в 16:19 +0300, Kirill Maslinsky пишет:
> > Хм... я когда-то осторожно высказывался насчет OMF... Still no?
> 
> Хм, а Вы можете предложить, как именно OMF может 
> пригодиться нашему проекту (или наш проект -- OMF'у)?

Это готовый стандарт каталогизации документов, основанный на XML.
Более того, в дистрибутиве есть средства работы с OMF, это scrollkeeper
и (больше заточенный под документацию GNOME) yelp.

Теоретически, на этом даже можно построить структуру всего ALT Docs,
вместо создания древовидных DocBook-документов (впрочем, преимущества и
недостатки здесь пока мной не исследованы), так как это сделано в GNOME.

P.S. В docs@ ?

[-- Attachment #2: Эта часть сообщения подписана цифровой подписью --]
[-- Type: application/pgp-signature, Size: 189 bytes --]

Re: [devel] OMF docs (was: полиси -- в incoming/docs!)

[Kirill Maslinsky]

Добрый день!

> > Хм, а Вы можете предложить, как именно OMF может 
> > пригодиться нашему проекту (или наш проект -- OMF'у)?
> 
> Это готовый стандарт каталогизации документов, основанный на XML.
> Более того, в дистрибутиве есть средства работы с OMF, это scrollkeeper
> и (больше заточенный под документацию GNOME) yelp.
> 
> Теоретически, на этом даже можно построить структуру всего ALT Docs,
> вместо создания древовидных DocBook-документов (впрочем, преимущества и
> недостатки здесь пока мной не исследованы), так как это сделано в GNOME.

В ALT Docs мыслится три уровня готовности документов: Куча--Модуль--Выпуск, 
к ним (и к их авторам/споровождающим) разный уровень требований, на 
каком именно уровне Вы предлагаете использовать OMF и для решения 
какой задачи? Пока описание слишком абстрактное, и непонятно, как 
OMF можно применить на практике. 

Что касается древовидных DocBook документов, то мы от них уже почти 
наверняка отказываемся в пользу независимых модулей, которые 
можно объединять в какие угодно структуры на уровне выпуска. 

> P.S. В docs@ ?

Если у Вас действительно есть конкретные предложения -- давайте 
продолжим в docs@.

-- 
Kirill Maslinsky
ALT Linux Documentation Team