diff --git a/ru/docproj/current.sgml b/ru/docproj/current.sgml index 145bd3b2f7..093f52cbe0 100644 --- a/ru/docproj/current.sgml +++ b/ru/docproj/current.sgml @@ -1,261 +1,224 @@ - - + + %includes; ]> &header;

Здесь приведён список проектов, которые находятся в работе (или активно обсуждаются в списке рассылки freebsd-doc). Также сюда включены некоторые проекты, которые еще не обсуждались, но воплотить их было бы хорошей идеей. У каждого проекта есть человек для контактов (если он известен).

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

- -

Любые упущения в этом списке - полностью моя вина (Ник Клэйтон (Nik - Clayton) <nik@FreeBSD.ORG>), - простите меня те, чей проект я забыл упомянуть.

+ конкретный проект, и он поможет вам стать его участником. Если у вас + есть какие-либо идеи относительно новых проектов, пожалуйста, отправьте + письмо по адресу + FreeBSD-doc@FreeBSD.org.

Открытые сообщения об ошибках в документации

Текущие сообщения об ошибках в документации отслеживаются с помощью базы данных GNATS. Вы можете просмотреть открытые сообщения об ошибках в документации.

+ +

3-е печатное издание Руководства FreeBSD

- -

FreeBSD для пользователей Linux

+

Ответственный: Murray Stokely <murray@FreeBSD.org>

-

Ответственный: Annelise Anderson - < - andrsn@andrsn.stanford.edu>

+

Описание: Началась работа по подготовке Руководства FreeBSD + к публикации. Обратитесь к полному списку + задач за информацией о том, чем вы можете помочь.

-

Описание: Пользователи, переходящие от Linux к FreeBSD, могут - столкнуться с некоторыми различиями между системами (различные - командные процессоры, используемые по умолчанию, конфигурирование - системы при загрузке и тд.). Annelise координирует разработку пособий и - разделов FAQ, которые будут освещать эти вопросы.

+ +

2-е печатное издание Руководства FreeBSD

-

Список текущих вопросов находится по адресу - http://freebsd.stanford.edu/FreeBSD/linux.html.

+

Ответственный: Murray Stokely <murray@FreeBSD.org>

+

Описание: Этот проект завершен. Второе издание Руководства + FreeBSD доступно на FreeBSD Mall. В окончательной + редакции 653 страниц, номер ISBN 1571763031. Спасибо всем, кто помогал. + Прочтите полный анонс здесь.

- -

Исправления в файлах FOO.TXT

+

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

-

Ответственный: Doug - <studded@dal.net>

+ +

FreeBSD для пользователей Linux

-

Описание: Здесь под файлами "FOO.TXT" понимаются файлы типа README, - INSTALL.TXT, ABOUT.TXT и прочие, которые вы получаете вместе с FreeBSD. - Doug (и другие) займётся ими, проверив на их верность, соответствие друг - другу и лёгкость для понимания. Весьма нужная работа.

+

Ответственный: FreeBSD-doc + <FreeBSD-doc@FreeBSD.org>

+

Описание: Пользователи, переходящие от Linux к FreeBSD, могут + столкнуться с некоторыми различиями между системами (различные + командные процессоры, используемые по умолчанию, конфигурирование + системы при загрузке и т.д.).

Написание разделов в Руководстве и/или FAQ

Ответственный: Никто

Описание: Части FAQ и Руководства имеют пустые разделы. Их требуется заполнить. Если вы использовали какие-либо из этих документов и нашли их неполными, пожалуйста, найдите время для описания вашего опыта в качестве возможной замены.

Кроме того, если вы сделали что-то, что не описано в FAQ или Руководстве, просто напишите новый раздел. Затем пошлите его так, как описано выше.

Написание некоторых новых документов

Новый уровень SCSI для FreeBSD (CAM)

Ответственный: <doc@FreeBSD.org>, <scsi@FreeBSD.org>

Описание: Посмотрите первый вариант Архитектура и реализация подсистемы SCSI во FreeBSD.

- -

Написание некоторых новых пособий

+ +

Написание некоторых глав для Руководства Разработчика

Ответственный: <doc@FreeBSD.org>

Описание:

+

Написание страниц Справочника по ядру

Ответственный: - <doc@FreeBSD.org>

+ Tom Rhodes <trhodes@FreeBSD.org>

Описание: Документирование функций ядра, раздел 9

Скрипты CGI

Ответственный: <doc@FreeBSD.org>, Wolfram Schneider <wosch@FreeBSD.org>

-

Описание:

- - -

Вот несколько советов по написанию модуля для работы с портами

- -

Каждая строка в файле /usr/ports/INDEX выглядит примерно как

- - 
-   xfig-3.2.2|/usr/ports/graphics/xfig|/usr/X11R6|A drawing program for X11|/usr/ports/graphics/xfig/pkg/DESCR|ports@FreeBSD.ORG|graphics x11|XFree86-3.3.2 Xaw3d-1.3 jpeg-6b xpm-3.4k|XFree86-3.3.2 Xaw3d-1.3 jpeg-6b netpbm-94.3.1 tiff-3.4 transfig-3.2 xpm-3.4k
-
- -

Она имеет следующий формат

- - 
-   distribution-name|port-path|installation-prefix|comment| \
-       description-file|maintainer|categories|build deps|run deps
-
- -

Приведенная выше строка из файла INDEX преобразуется в безымянный - hash-объект

- - 
-$port = {
-	DISTRIBUTION_NAME   => 'xfig-3.2.2',
-	PORT_PATH	    => '/usr/ports/graphics/xfig',
-	INSTALLATION_PREFIX => '/usr/X11R6',
-	COMMENT 	    => 'A drawing program for X11',
-	DESCRIPTION_FILE    => '/usr/ports/graphics/xfig/pkg/DESCR',
-	MAINTAINER	    => 'ports@FreeBSD.ORG',
-	CATEGORIES	    => ['graphics', 'x11'],
-	BUILD_DEPS	    => ['XFree86-3.3.2', 'Xaw3d-1.3', 'jpeg-6b',
-				'xpm-3.4k'],
-	RUN_DEPS	    => ['XFree86-3.3.2',  'Xaw3d-1.3', 'jpeg-6b',
-				'netpbm-94.3.1', 'tiff-3.4', 'transfig-3.2',
-				'xpm-3.4k']
-};
-
- -

Сейчас нам нужны некоторые функции

- - - -

В завершение

-

Модификация cgi-скриптов url.cgi, ports.cgi, pds.cgi и скрипта - portindex с использованием этого модуля.

- -

Обратитесь к Nik Clayton <nik@FreeBSD.ORG> чтобы получить - первую версию - модуля для работы с портами.

+

Описание: Изменение CGI скриптов url.cgi, ports.cgi, + pds.cgi и скрипта portindex с использованием Perl модулей FreeBSD::Ports + modules. Эти модули также нуждаются в тестировании.

Многонациональные скрипты Web

Ответственный: <doc@FreeBSD.org>

Описание:

Наши основные страницы веб-сервера написаны на (американском) английском. Проект FreeBSD Translations Projects занимается переводом страниц веб-сервера, Руководства и FAQ на другие языки.

Мы должны перевести скрипты cgi, а также и скрипты для построения веб-страниц. Скрипты должны поддерживать несколько языков, а не только один. Большинство скриптов написано на языке perl.

Переводы документации FreeBSD

Ответственный: <doc@FreeBSD.org>

Перевод документации FreeBSD (страницы веб, FAQ, Руководство, страницы справочника) на другие языки. Обратитесь к проектам перевода FreeBSD

Усовершенствования средств поиска

-

Ответственный: <doc@FreeBSD.org>

+

Ответственный:Eric Anderson <anderson@centtech.com>

При поиске по веб-серверу выводимый текст включает имя файла, который были найден, например, FAQ34.html.

Будет более удобно, если в результат поиска будет включен и запрашиваемый текст, что позволит пользователю увидеть, насколько результат поиска соответствует запросу.

+ +

Документирование параметров настройки FreeBSD.

+

Ответственный:Tom Rhodes <trhodes@FreeBSD.org>

+ +

Многие параметры настройки FreeBSD не документированы. Каждый знает, + насколько сложным может быть использование недокументированной системы, + поэтому и был организован этот проект. Основная его цель это создание + инструмента, способного генерировать страницу справочника с параметрами + настройки. Следовательно, нам потребуется создать этот список из + исходного кода.

+

Домашняя страница проекта FreeBSD Documentation Project &footer diff --git a/ru/docproj/doc-set.sgml b/ru/docproj/doc-set.sgml index f2e6df097a..7b39ae1b19 100644 --- a/ru/docproj/doc-set.sgml +++ b/ru/docproj/doc-set.sgml @@ -1,66 +1,53 @@ + + - - + + %includes; ]> - - - - &header; -

Документация по FreeBSD разбивается на четыре основных категории:

+

Документация по FreeBSD разбивается на три основных категории:

  1. Страницы Справочника

    На самом деле Проект не придает им большое значение, так как они являются частью операционной системы. Исключением является Японская команда, которая занимается их переводом. Нет причин, по которым другие добровольцы не могли бы начать перевод страниц Справочника на другие языки.

    Нельзя сказать, что страницы Справочника не важны, вовсе нет. Просто они очень сильно связаны со специфическими подсистемами FreeBSD, и в большинстве случаев лучше всех для написания страниц Справочника по некоторой части FreeBSD подходит тот, кто эту часть реализовывал.

    2. -

  2. FAQ

    - -

    Он поддерживается в рамках проекта. Он предназначен для - вопросов (в краткой форме вопрос/ответ), которые задаются или - будут задаваться в различных списках рассылки и телеконференциях, - посвященных FreeBSD. Формат не позволяет помещать распространенные - и подробные ответы.

    3. +

  3. Книги

    -

  4. Руководство

    +

    В проекте имеется большое количество документации, достигшей + "книжной длины", или стремящейся к ней. Сюда включены + FreeBSD FAQ и Руководство FreeBSD.

    -

    Оно поддерживается проектом. Вопросы, требующие более детального - обсуждения, раскрываются в Руководстве.

    5. +

  5. Статьи

    -

  6. Учебники

    - -

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

    - -

    Некоторые из учебников помещены на веб-сервере FreeBSD. Для - эти учебников авторы посылают свои изменения одному из коммиттеров, - а коммиттер делает изменения. Другие учебники помещены на - веб-пространство автора, и автор может делать изменения как и - когда ему заблагорассудится. Иногда это осознанное решение - автора, иногда это исторический прецедент.

    7. +

    В FreeBSD есть масса информации, доступной в более коротком + формате статьи, аналогично учебникам или HOWTO других + проектов.

-

FreeBSD Documentation Project Home &footer diff --git a/ru/docproj/docproj.sgml b/ru/docproj/docproj.sgml index b4d6f0d06b..1f9b928a63 100644 --- a/ru/docproj/docproj.sgml +++ b/ru/docproj/docproj.sgml @@ -1,85 +1,89 @@ - + + - - + + %includes; ]> - - - - &header;

Обзор

Изучение и понимание новой и сложной операционной системы всегда является трудной задачей, вне зависимости от того, насколько хорош пользовательский интерфейс. В этом аспекте FreeBSD ничем не отличается от других операционных систем.

-

Хотя имеется достаточное количество книг по BSD Unix (и об Unix +

Хотя имеется достаточное количество книг по BSD Unix (и об &unix; вообще), FreeBSD имеет свои уникальные особенности, приемы работы и различные хитрости.

Кроме того, FreeBSD может быть первым опытом работы с Unix-подобными операционными системами для многих ее пользователей, поэтому наличие высококачественной, аккуратно составленной документации имеет очень высокое значение.

Проект The FreeBSD Documentation Project имеет цель заполнить этот пробел. Это осуществляется двумя способами:

  1. Участники Проекта пишут документации и предоставляют ее для включения во FreeBSD Documentation Set.

  2. Участники Проекта обсуждают и упорядочивают формат и организацию FreeBSD Documentation Set.

Текущие проекты

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

Кто мы и как к нам присоединиться

Эта страница описывает, кто осуществляет Проект Документирования, и как вы можете к нему присоединиться.

The FreeBSD Documentation Set

Эта страница описывает компоненты Комплекта Документации FreeBSD, и то, какую работу с ним проделывает Проект Документирования.

SGML и Documentation Project

Для документации проект пытается использовать SGML. Эта страница описывает, как это достигается, и отправляет заинтересовавшегося читателя к более подробным ресурсам SGML.

Посылка документации

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

Перевод

Переводы документации FreeBSD, страниц веб, Руководства, страниц Справочника и FAQ.

&footer diff --git a/ru/docproj/handbook3.sgml b/ru/docproj/handbook3.sgml index 3c42d6f9c5..65338557ce 100644 --- a/ru/docproj/handbook3.sgml +++ b/ru/docproj/handbook3.sgml @@ -1,271 +1,271 @@ - + %developers; %includes; Выполнено"> Выполняется"> Не начато"> ]> &header;

Руководство FreeBSD, 3-е издание

3-е издание Руководства FreeBSD будет издано в виде двух томов, каждый - из который будет иметь объёи не менее 400 страниц. Том I (Руководство + из который будет иметь объём не менее 400 страниц. Том I (Руководство пользователя) будет посвящено основам, а Том II (Руководство администратора) будет посвящено системному администрированию и более сложным вопросам.

Если вам хочется принять участие в выпуске этого издания, пожалуйста, пошлите письмо на адрес списка рассылки -doc. Спасибо!

- +
Задача Ответственный Последнее изменение Status
Добавить атрибуты типа в URL, указывающие на локальный хост, для того, чтобы они могли быть исключены при выдаче на печать. &a.murray; 18 мая 2003 &done;
Добавить разметку <colspecs> в таблицы при необходимости для улучшения выдачи на печать. &a.murray; 18 мая 2003 &inprogress;
Удалить все алфавитно-цифровые картинки &a.murray; 18 мая 2003 &done;
Обновить главу с использованием современных версий GNOME &a.marcus; 18 мая 2003 &done;
Исправить перекрёстные ссылки для улучшения выдачи на печать. &a.murray; 18 мая 2003 &inprogress;
Стандартизовать написание технических терминов &a.trhodes; 18 мая 2003 &inprogress;
Обеспечить правильную разметку для имён файлов, команд, приложений, имён хостов и так далее &a.blackend; 18 мая 2003 &inprogress;
Обновить приложение с авторами, внёсшими свой вклад. &a.chern; 18 мая 2003 ¬started;
Обновить главу о PPP/SLIP &a.trhodes; 18 мая 2003 &done;
Откорректировать раздел об IPSec &a.hmp; 18 мая 2003 &inprogress;
Добавить простые иллюстрации к началу каждой части.   18 мая 2003 ¬started;
Добавить пиктограммы для сносок типа Замечание, Предостережение, Предупреждение и Совет. &a.hrs; 18 мая 2003 &inprogress;
Дизайн обложки.   18 мая 2003 ¬started;
Обновить содержимое вводной главы для работы с версиями после 5.0.   18 мая 2003 ¬started;
Улучшить вид титульных элементов &a.murray; 18 мая 2003 &done;
Поиск в книге грамматических ошибок. Все! 18 мая 2003 &inprogress;
Написание автоматизированной проверки орфографии для всего Руководства. Черн (Chern) написал несколько скриптов Tcl и опубликовал их в doc@ во время работы над вторым изданием. Это может стать отправной точкой. 18 мая 2003 ¬started;
Удостовериться в том, что во всех заголовках соблюдён правильный регистр &a.ceri; 18 мая 2003 &done;
Удалить ненужные разделы вопросов и ответов в пользу более формального текста. (смотрите окончание главы о портах/пакаджах) &a.trhodes; 18 мая 2003 &inprogress;
Добавить больше информации об ACPI. &a.brueffer; 18 мая 2003 ¬started;
Добавить информацию о Kerberos5 и соответствующим образом исправить информацию о Kerberos4. &a.trhodes; 18 мая 2003 &done;
Обновить введение. &a.murray; 18 мая 2003 &inprogress;
Написать Предисловие.   18 мая 2003 ¬started;
Обновить библиографию новыми изданиями и тому подобным. &a.ceri; 18 мая 2003 ¬started;
Расставить больше индексов по всей книге. Реорганизовать некоторые имеющиеся индексы. Обратите внимание на функциональность "make indexcheck" для помощи в поиске областей книги, где индексных меток недостаточно.   18 мая 2003 ¬started;
Написать введение в главу о последовательных коммуникациях (отметьте наличие большого комментария "XXX - Write me!"). Для этого может быть изменён имеющийся общий обзор.   19 мая 2003 ¬started;
Требуется написание раздела о мини-картриджах в главе о дисках.   22 мая 2003 ¬started;
Добавить информацию о конфигурации сети в главу об установке. &a.trhodes; 18 мая 2003¬started;&done;
Добавить некоторую документацию об утилите cron(8). &a.trhodes; 18 мая 2003 &done;
Выдать всё на печать. &a.murray;   ¬started;
diff --git a/ru/docproj/sgml.sgml b/ru/docproj/sgml.sgml index 9cd199ca10..4413c1ba20 100644 --- a/ru/docproj/sgml.sgml +++ b/ru/docproj/sgml.sgml @@ -1,178 +1,182 @@ + + - - + + %includes; ]> - - - - &header;

The Documentation Project пытается использовать SGML в качестве стандартного средства для написания документации.

Сокращение SGML означает Standard Generalised Markup Language (Стандартный Формализованный Язык Разметки).

По сути (и да простят нас SGML-пуристы, присутствующие среди аудитории, к которой мы обращаемся) SGML является языком для написания других языков.

Скорее всего, вы уже работали с SGML, не подозревая об этом. HTML, язык, на котором пишутся страницы веба, имеет формальное описание. Это описание написано на SGML. Когда вы пишете в HTML, вы не пишете на SGML (per se), но используете язык, заданный при помощи SGML.

Существует много, очень много языков разметки, которые заданы с помощью SGML. HTML - один из них. Другой называется "LinuxDoc". Как вы уже, наверное, догадались, он был создан группой, документирующей Linux, для написания документации, и используется во FreeBSD Documentation Project.

Другим языком разметки, заданным с помощью SGML, является "DocBook". Этот язык был разработан специально для написания технической - документации, и поэтому в нем имеется множество тэгов (это нечто, + документации, и поэтому в нем имеется множество тегов (это нечто, находящееся внутри <...>) для описания всего, что связано с технической документацией.

Например, вот так может выглядеть короткий параграф в HTML - (не обращайте внимания на содержимое, смотрите на тэги):

+ (не обращайте внимания на содержимое, смотрите на теги):

Пароли хранятся в /etc/passwd.	Чтобы отредактировать этот
       файл, вы должны использовать vipw.  Однако, если вам
       нужно только добавить в систему нового пользователя, вы можете
       воспользоваться утилитой adduser.

 ]]>

Тот же параграф, оформленный в стандарте DocBook, выглядит как

Пароли хранятся в /etc/passwd.  Чтобы
       отредактировать этот файл, вы должны использовать
       vipw.	Однако, если вам нужно только добавить в
       систему нового пользователя, вы можете воспользоваться утилитой
       adduser.
 ]]>

Как вы можете видеть, DocBook более 'выразителен', чем HTML. В примере с HTML задается вывод имени файла шрифтом 'пишущей машинки'. В примере с DocBook вывод имени файла задается именно как 'имя файла', конкретное представление имени файла не оговаривается.

Имеется несколько плюсов использования этой более выразительной формы разметки:

-

Если вы знакомы с Microsoft Word, это похоже на таблицы стилей, только +

Если вы знакомы с Microsoft® Word, это похоже на таблицы стилей, только гораздо более мощные.

Конечно же, эти возможности достигаются определенной ценой;

На данный момент Проект все еще использует LinuxDoc для Руководства и FAQ. Это положение меняется, в частности, идет процесс преобразования документации в формат DocBook.

Что, если вы не знаете LinuxDoc/DocBook? Можете ли вы предоставлять нам документацию?

Да, можете. Однозначно. Любая документация лучше, чем ее отсутствие. Если у вас есть документация, которую вы хотите нам предоставить, и она размечена не в формате LinuxDoc или DocBook, ничего страшного.

Пошлите нам документацию обычным образом. Кто-нибудь из Проекта рассмотрит документацию, которую вы послали, разметит ее за вас и включит в систему. С некоторой вероятностью обратно вам будет выслан размеченный текст. Это весьма полезно, так как вы сможете сравнить документацию "до и после", обычный текст и размеченный, и, может быть, узнаете что-то новое о процессе разметки.

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

Хотите знать больше о SGML и DocBook?

Сначала вы должны прочесть Documentation Project Primer. Этот документ является подробным описанием всего, что вам нужно знать для работы с документации FreeBSD.

Это большой документ, разделенный на много меньших файлов. Вы можете также просматривать его в виде одного большого файла.

http://www.oasis-open.org/cover/sgml-xml.html

Страница SGML/XML. Содержит бесчисленное множество ссылок на информацию о SGML.

http://www-tei.uic.edu/orgs/tei/sgml/teip3sg/index.html
+ href="http://www-sul.stanford.edu/tools/tutorials/html2.0/gentle.html">http://www-sul.stanford.edu/tools/tutorials/html2.0/gentle.html

"Gentle Introduction to SGML". Рекомендуемое чтение для всех, кто хочет изучить SGML более подробно с уровня начинающего.

http://www.oasis-open.org/docbook/

DocBook DTD поддерживается OASIS. Эти страницы предназначены для пользователей, которые чувствуют себя уверенно с SGML и хотят изучить DocBook.

FreeBSD Documentation Project Home &footer; diff --git a/ru/docproj/submitting.sgml b/ru/docproj/submitting.sgml index 4e008c3ed5..8b01e4b3b5 100644 --- a/ru/docproj/submitting.sgml +++ b/ru/docproj/submitting.sgml @@ -1,146 +1,146 @@ + + - - + + %includes; ]> - - - - &header;

Я написал некоторое количество документации. Как вам её послать?

Во-первых, спасибо, что вы нашли время и сделали это.

Вы должны сделать вашу документацию доступной для предварительного просмотра. Если это возможно, поместите её на FTP или веб-сервер.

После этого пошлите сообщение в список рассылки -doc с кратким описанием документации и ссылкой на её местоположение, а также просьбой поделиться отзывами.

Если по каким-то причинам вы не можете поместить документацию на какой-либо FTP или веб-сервер, то пошлите её непосредственно в список рассылки -doc. Если вы собираетесь поступить именно так, то присылайте документы в формате обычного текста.

Скорее всего, вы ещё понадобится сделать cc: этого запроса на комментарии в другие подходящие списки рассылки. Например, что-либо, относящееся к использованию CVSup для синхронизации дерева исходных текстов, будет интересно подписчикам списков рассылки FreeBSD-current и FreeBSD-stable.

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

Чтобы сделать это, заархивируйте её в один tar-файл. Если ваша - документация состоит из трех файлов, + документация состоит из трех файлов, one, two, и three, + и вы хотите получить их в виде doc.tar, сделайте следующее:

     % tar cf doc.tar one two three

Затем выполните сжатие tar-файла:

     % gzip -9 doc.tar

в результате чего появится doc.tar.gz.

И, наконец, перекодируйте файл в вид, который подходит для передачи через любую программу электронной почты.

     % uuencode doc.tar.gz doc.tar.gz > doc.uue

Теперь дайте знать о нём группе Проекта Документирования. Правильным способом сделать это является использование программы send-pr, которая должна иметься на вашей машине.

Вы делаете это для того, чтобы ваше послание могло быть отслежено. Когда вы оформляете PR (Problem Report - сообщение о проблеме), ему назначается уникальный номер. Один из коммиттеров может затем направить PR себе, и установить с вами связь по поводу включения новой документации в систему.

send-pr сама по себе очень проста. Все, что она делает - это посылка электронной почты, оформленной особым образом, на определенный адрес. Когда вы запускаете send-pr, вы оказываетесь в текстовом редакторе (вероятнее всего, vi или emacs) с бланком для заполнения и некоторыми инструкциями по заполнению.

Удостоверьтесь, что пункт "Category" установлен в "docs", а в строчке "Class" фигурирует только лишь "change-request". Вы должны включить в это PR ранее созданный файл .uue.

Когда вы завершите работу с редактором, PR будет послано по электронной почте туда, куда нужно. Вскоре вы получите подтверждающее сообщение, вкратце говорящее, какой номер был назначен PR, и этот номер может быть использован для отслеживания его судьбы.

-

Как альтернативу вы можете использовать веб-интерфейс по адресу - http://www.freebsd.org/send-pr.html.

-

Я сделал некоторые изменения и исправления в существующей документации, как вам их послать?

Мы снова благодарим вас за то, что вы потратили на это время.

Прежде всего вам нужно сгенерировать особый файл, называемый diff. В этом diff-файле содержатся только изменения, которые вы внесли. Это облегчает персоне, выполняющей внесение изменений в систему, просмотр ваших изменений, что означает ненужность траты массы времени на объяснения, что конкретно было изменено (хотя вы должны будете объяснить, почему эти изменения так необходимы).

Чтобы сделать 'diff', вы должны:

  1. Сделать копию файла, который собираетесь менять. Если вы - изменяете + изменяете foo.sgml, выполните

             % cp foo.sgml foo.sgml.old

  2. Затем внесите ваши изменения в foo.sgml

             % vi foo.sgml
         ... клац клац клац ...
 
         ... тестируем изменения, ищем опечатки, и тому подобное ...

  3. Делаем diff. Команда, это делающая:

    -        % diff -c foo.sgml.old foo.sgml > foo.diff
+        % diff -ru foo.sgml.old foo.sgml > foo.diff

    Здесь выполняется просмотр отличий между двумя файлами и запись - этих отличий в файл + этих отличий в файл foo.diff.

-

После этого вы можете послать После этого вы можете послать foo.diff обратно в адрес проекта. Пошлите PR так, как это было описано выше, включив в тело письма - файл + файл foo.diff.

Проект Документирования FreeBSD &footer diff --git a/ru/docproj/translations.sgml b/ru/docproj/translations.sgml index 4ec4efd070..eb496071d6 100644 --- a/ru/docproj/translations.sgml +++ b/ru/docproj/translations.sgml @@ -1,213 +1,335 @@ - - + + %includes; ]> &header; - -

The FreeBSD Chinese Documentation Project

+ +

Бразильско-португальский Проект Документирования FreeBSD

+ + Web: http://doc.fugspbr.org/
+ + E-Mail: lioux@FreeBSD.org
+ +
+
Имеющиеся списки рассылки
+ +
Перейдите по следующей ссылке + http://www2.fugspbr.org/mailman/listinfo/doc/ + за инструкциями по подписке на список рассылки бразильско-португальской + группы перевода.
+ Или отправьте письмо на + doc-request@fugspbr.org + со словом "subscribe" в теме письма.
+ Создавать новые сообщения могут участники списка рассылки doc@fugspbr.org +
+ +
Имеющиеся документы
+ +
FAQ
+ +
Документы, находящиеся в работе
+ +
Пример проекта + документирования FreeBSD для новых участников
+ +
Руководство FreeBSD
+
+ + +

Болгарский Проект Документирования FreeBSD

+ Web: http://fdp-bg.sourceforge.net/
+ E-Mail: doc-proj@FreeBSD-bg.org
+ +
+
Имеющиеся списки рассылки
+ +
Перейдите по следующей ссылке URL + http://www.FreeBSD-bg.org/showtopic?art=maillist + за инструкциями по подписке на список рассылки болгарской + группы перевода.
+ Или, отправьте письмо на + majordomo@FreeBSD-bg.org + с текстом "subscribe doc-proj" в теле письма.
+ Создавать новые сообщения могут участники списка рассылки doc-proj@FreeBSD-bg.org
+ +
Имеющиеся документы
+ +
Пример + проекта документирования FreeBSD для новых участников
+ +
Документы, находящиеся в работе
+ +
Руководство FreeBSD
+ +
Сайт FreeBSD
+
+ + +

Китайский Проект Документирования FreeBSD

Web: -
E-Mail: foxfair@FreeBSD.org
Имеющиеся списки рассылки
Пошлите письмо со строчкой "subscribe freebsd-chinese-doc" на адрес majordomo@freebsd.sinica.edu.tw.
Посылка сообщений разрешена участникам по адресу freebsd-chinese-doc@freebsd.sinica.edu.tw
Имеющиеся документы
- FAQ
+ FAQ
Документы, находящиеся в работе
Руководство
+ +

Датский Проект Документирования FreeBSD

+ E-Mail: asmodai@FreeBSD.org
+ +
+
Документы, находящиеся в работе
+
Руководство
+
+ -

The FreeBSD Estonian Documentation Project

+

Эстонский Проект Документирования FreeBSD

- Web: - http://www.matti.ee/~vallo/
+ Web: + http://www.bsd.ee/tolge.php
Имеющиеся документы
-
Раздел - userppp Руководства FreeBSD
+
+ Руководство FreeBSD
-

The FreeBSD French Documentation Project

+

Французский Проект Документирования FreeBSD

Web: http://www.freebsd-fr.org
Имеющиеся списки рассылки
Пошлите письмо со строчкой "SUB freebsd-questions" на адрес listserver@freebsd-fr.org, чтобы подписаться на франкоязычный список рассылки, посвящённый вопросам пользователей.
Пошлите письмо со строчкой "SUB annonces" на адрес listserver@freebsd-fr.org, чтобы подписаться на франкоязычный список рассылки с анонсами.
Имеющиеся документы
-
FAQ
+
FAQ
-
Некоторые - пособия
+
Некоторые + пособия
-
Really - Quick Newsletters
+
Really + Quick Newsletters
-
PicoBSD
+
PicoBSD
Документы, находящиеся в работе
-
Руководство
+
Руководство
Дерево CVS
-
CVS - web
+
CVS web
Пошлите письмо со строчкой "SUB cvs" на адрес listserver@freebsd-fr.org для того, чтобы подписаться на список рассылки French CVS update.
-

The FreeBSD German Documentation Project

+

Немецкий Проект Документирования FreeBSD

Web: http://www.de.FreeBSD.org/de/uebersetzung.html
E-Mail: de-bsd-translators@de.FreeBSD.org
Документы, находящиеся в работе
-
Handbook, - FAQ, WWW
+
+ Руководство, + FAQ, + Web +
- -

Итальянский Проект Документирования FreeBSD

+ +

Итальянский Проект Документирования FreeBSD

- Web: http://www.gufi.org/
- E-Mail: info@gufi.org
+ Web: http://www.gufi.org/
+ E-Mail: info@gufi.org
-
-
Документы, находящиеся в работе
-
Handbook
-
+
+
Документы, находящиеся в работе
+
Руководство
+
-

The FreeBSD Japanese Documentation Project

+

Японский Проект Документирования FreeBSD

Web: http://www.jp.FreeBSD.org/doc-jp/
E-Mail: doc-jp@jp.FreeBSD.org
Имеющиеся документы
- Руководство, - FAQ, - Web, + Руководство, + FAQ, + Web, FreeBSD NewsLetter Issue #2
Документы, находящиеся в работе
FreeBSD Tutorials
-

The FreeBSD Korean Documentation Project

+

Корейский Проект Документирования FreeBSD

Web: http://www.kr.FreeBSD.org/projects/doc-kr/
E-Mail: doc@kr.FreeBSD.org
Документы, находящиеся в работе
-
Handbook
+
Руководство
+
+ + +

Польский Проект Документирования FreeBSD

+ Web: http://tlumaczenie.freebsd.pl
+ E-Mail: ni@merkury.pol.lublin.pl
+ +
+
Имеющиеся документы
+
Некоторые учебники
+
Документы, находящиеся в работе
+
Учебники FreeBSD
+
Руководство
+
FDP-Primer
+
+ + +

Румынский Проект Документирования FreeBSD

+ + Web: http://www.rofug.ro/projects/ro-l10n/
+ + E-Mail: ady@rofug.ro
+ +
+
Имеющиеся списки рассылки
+ +
Для подписки на список рассылки ro-l10n обратитесь к вебсайту + проекта или отправьте письмо на + listar@rofug.ro + с телом "subscribe ro-l10n".
+ Создавать новые сообщения могут только участники списка + рассылки ro-l10n. +
+ +
Документы, находящиеся в работе
+ +
Руководство
-

The FreeBSD Russian Documentation Project

+

Русский Проект Документирования FreeBSD

Web: http://www.FreeBSD.org.ua
E-Mail: ru-freebsd-doc@FreeBSD.ru
Имеющиеся документы
-
FAQ
-
WWW
+
FAQ
+
WWW
Q&A
Porter's handbook
QA
Документы, находящиеся в работе
-
Handbook
+
Руководство
-

The FreeBSD Spanish Documentation Project

+

Испанский Проект Документирования FreeBSD

Web: http://www.es.FreeBSD.org/es/
E-Mail: jesusr@es.FreeBSD.org
Имеющиеся документы
-
FAQ
+
FAQ
Документы, находящиеся в работе
-
Handbook
+
Руководство

FreeBSD Documentation Project Home &footer diff --git a/ru/docproj/who.sgml b/ru/docproj/who.sgml index 643d09e390..32295d0105 100644 --- a/ru/docproj/who.sgml +++ b/ru/docproj/who.sgml @@ -1,36 +1,46 @@ + + - - + + + %includes; ]> - - - - &header;

Проект представляет собой слабо связанную группу людей; единственное, что у нас имеется общего - это подписка на список рассылки FreeBSD-doc@FreeBSD.ORG.

Некоторые из нас могут вносить изменения непосредственно в дерево - документации FreeBSD. Полный список людей с такими ``привилегиями'' - находится в Руководстве.

+ документации FreeBSD. Вы можете увидеть полный список + разработчиков FreeBSD с коммит привилегиями, как и список + главных коммиттеров проекта документирования FreeBSD.

-

Другие не имеют таких прав, но они пишут и посылают нам документацию независимо от - этого. Один из коммиттеров затем включит ее в наш пакет +

Другие не имеют таких прав, но они пишут и присылают нам + документацию независимо от этого. Как только она + будет отправлена в соответствии со страницей посылка документации, один из + коммиттеров просмотрит ее и включит в наш пакет документации.

Если вы хотите помочь проекту документирования (и я страстно надеюсь на это), все, что вам нужно сделать - это подписаться на список рассылки и поучаствовать в обсуждениях. Как только вы это сделаете, можете считать себя участником проекта.

FreeBSD Documentation Project Home &footer