diff options
Diffstat (limited to 'documentation/content/ru/books/fdp-primer/overview')
| -rw-r--r-- | documentation/content/ru/books/fdp-primer/overview/_index.adoc | 321 | ||||
| -rw-r--r-- | documentation/content/ru/books/fdp-primer/overview/_index.po | 721 |
2 files changed, 1042 insertions, 0 deletions
diff --git a/documentation/content/ru/books/fdp-primer/overview/_index.adoc b/documentation/content/ru/books/fdp-primer/overview/_index.adoc new file mode 100644 index 0000000000..040a5a239a --- /dev/null +++ b/documentation/content/ru/books/fdp-primer/overview/_index.adoc @@ -0,0 +1,321 @@ +--- +description: 'Обзор процесса создания документации FreeBSD' +next: books/fdp-primer/tools +params: + path: /books/fdp-primer/overview/ +prev: books/fdp-primer/preface +showBookMenu: true +tags: ["overview", "FreeBSD Documentation Project", "quick start"] +title: 'Глава 1. Обзор' +weight: 2 +--- + +[[overview]] += Обзор +:doctype: book +:toc: macro +:toclevels: 1 +:icons: font +:sectnums: +:sectnumlevels: 6 +:sectnumoffset: 1 +:partnums: +:source-highlighter: rouge +:experimental: +:images-path: books/fdp-primer/ + +ifdef::env-beastie[] +ifdef::backend-html5[] +:imagesdir: ../../../../images/{images-path} +endif::[] +ifndef::book[] +include::shared/authors.adoc[] +include::shared/mirrors.adoc[] +include::shared/releases.adoc[] +include::shared/attributes/attributes-{{% lang %}}.adoc[] +include::shared/{{% lang %}}/teams.adoc[] +include::shared/{{% lang %}}/mailing-lists.adoc[] +include::shared/{{% lang %}}/urls.adoc[] +toc::[] +endif::[] +ifdef::backend-pdf,backend-epub3[] +include::../../../../../shared/asciidoctor.adoc[] +endif::[] +endif::[] + +ifndef::env-beastie[] +toc::[] +include::../../../../../shared/asciidoctor.adoc[] +endif::[] + +Добро пожаловать в Проект документации FreeBSD (FDP). Качественная документация крайне важна для успеха FreeBSD, и мы очень высоко ценим ваш вклад. + +Этот документ описывает организацию FDP, как писать и отправлять документацию, а также как эффективно использовать доступные инструменты. + +Все желающие могут внести свой вклад в FDP. Готовность помочь — единственное требование для участия. + +Это руководство показывает, как: + +* Понять роль документации и её место в экосистеме. +* Определите, какие части FreeBSD поддерживаются FDP. +* Установить необходимые инструменты и файлы документации. +* Внести изменения в документацию. +* Представить изменения для проверки и включения в документацию FreeBSD. + +[[overview-documentation-ecosystem]] +== Документация в экосистеме FreeBSD + +Все документы создаются для пользы читателей, а не их авторов или сопровождающих. Они должны адаптироваться к читателю, а не ожидать, что читатель адаптируется к ним. + +Никогда не вините читателя за: + +* невозможность легко или вообще использовать документ +* если документ показался ему непонятным +* непонимание документа или того, как его применить +* если он не нашел явный ответ или шаги, чтобы логически прийти к нему + +Вместо этого подтвердите, что документ: + +* недоступный +* запутанный +* трудно понимаемый или применимый +* неполный + +Затем создайте документ: + +* более доступный +* менее запутанный +* более ясный +* более полный + +Используйте следующие методы: + +* Примените link:https://webaim.org/intro/#principles[лучшие практики доступности], чтобы исправить выявленную проблему и любые подобные, которые обнаружите +* переработайте или уточните запутанную структуру или язык +* добавьте соответствующие примеры к части, которая трудна для понимания или применения +* заполните пробелы или добавьте недостающие промежуточные этапы + +[[overview-quick-start]] +== Быстрый старт + +Некоторые подготовительные шаги необходимо выполнить перед редактированием документации FreeBSD. Сначала подпишитесь на рассылку {freebsd-doc}. Некоторые участники команды также общаются в IRC-канале `#bsddocs` на http://www.efnet.org/[EFnet]. Эти люди могут помочь с вопросами или проблемами, связанными с документацией. + +[[freebsd-installation-process]] +=== Процесс установки FreeBSD + +[.procedure] +==== +. Установите эти пакеты. _Мета-порт_ `docproj` устанавливает все приложения, необходимые для работы с документацией FreeBSD. ++ +[source, shell] +.... +# pkg install docproj +.... ++ +. Установите локальную рабочую копию документации из репозитория FreeBSD в [.filename]#~/doc# (см. crossref:working-copy[working-copy,Рабочая копия]). ++ +[source, shell] +.... +% git clone https://git.FreeBSD.org/doc.git ~/doc +.... ++ +. Отредактируйте файлы документации, которые требуют изменений. Если файлу нужны значительные изменения, обратитесь за советом в список рассылки. ++ +Просмотрите вывод и отредактируйте файл, чтобы исправить указанные проблемы, затем повторно запустите команду для поиска оставшихся проблем. Повторяйте, пока все ошибки не будут устранены. ++ +. *_Always_* build and review the changes before submitting them. Running `make` in the `documentation` or `website` subdirectories will generate the documentation in HTML format. ++ +[source, shell] +.... +% make +.... ++ +Для сокращения времени компиляции может быть скомпилирован только один язык: ++ +[source, shell] +.... +% make DOC_LANG=en +.... ++ +Результаты сборки сохраняются в [.filename]#~/doc/documentation/public/en/articles/# и [.filename]#~/doc/documentation/public/en/books/#. ++ +. Просмотрите вывод сборки и убедитесь, что правки не содержат опечаток, проблем с версткой или ошибок. Если в процессе сборки обнаружены ошибки, отредактируйте проблемные файлы, чтобы исправить все возникшие проблемы, затем снова запустите команду сборки, пока все ошибки не будут устранены. ++ +. Добавьте все файлы с помощью `git add .`, затем просмотрите изменения с помощью `git diff`. Например: ++ +[source, shell] +.... +% git add . +% git diff --staged +.... ++ +Убедитесь, что все необходимые файлы включены, затем зафиксируйте изменение в вашей локальной ветке и создайте патч с помощью `git format-patch` ++ +[source, shell] +.... +% git commit +% git format-patch origin/main +.... ++ +Патч, созданный с помощью `git format-patch`, будет содержать идентификатор автора и адреса электронной почты, что упрощает применение разработчиками (с помощью `git am`) и правильное указание авторства. ++ +[IMPORTANT] +====== +Чтобы упростить применение патча коммиттерами в их рабочей копии дерева документации, пожалуйста, сгенерируйте файл [.filename]#.diff# из корня вашего дерева документации. +====== ++ +В приведенном выше примере были внесены изменения в раздел *bsdinstall* Руководства. ++ +. Отправьте патч или diff-файл с помощью веб-системы https://bugs.FreeBSD.org/bugzilla/enter_bug.cgi?product=Documentation[Problem Report]. При использовании веб-формы укажите в поле Summary _[patch] краткое описание проблемы_. Выберите Component `Documentation`. В поле Description введите краткое описание изменений и любые важные детали о них. Используйте кнопку btn:[Add an attachment], чтобы прикрепить патч или diff-файл. Наконец, нажмите кнопку btn:[Submit Bug], чтобы отправить ваш diff в систему отчетов об ошибках. +==== + +[[gnu-linux-installation-process]] +=== Процесс установки GNU/Linux + +[.procedure] +==== +. Установите эти пакеты в системах на основе apt, таких как Debian или Ubuntu. В других дистрибутивах GNU/Linux названия пакетов могут отличаться. В случае сомнений обратитесь к менеджеру пакетов вашего дистрибутива. ++ +[source, shell] +.... +# apt install hugo ruby-asciidoctor ruby-asciidoctor-pdf ruby-rouge git bmake +.... ++ +. Установите локальную рабочую копию документации из репозитория FreeBSD в [.filename]#~/doc# (см. crossref:working-copy[working-copy,Рабочая копия]). ++ +[source, shell] +.... +% git clone https://git.FreeBSD.org/doc.git ~/doc +.... ++ +. Отредактируйте файлы документации, которые требуют изменений. Если файлу нужны значительные изменения, обратитесь за советом в список рассылки. ++ +Просмотрите вывод и отредактируйте файлы, чтобы исправить обнаруженные проблемы, затем снова запустите команду, чтобы найти оставшиеся проблемы. Повторяйте, пока все ошибки не будут устранены. ++ +. Всегда собирайте и тестируйте изменения перед их отправкой. Запуск `bmake` в подкаталогах `documentation` или `website` сгенерирует документацию в формате HTML. ++ +[source, shell] +.... +% bmake run LOCALBASE=/usr +.... ++ +. Добавьте все файлы с помощью `git add .`, затем просмотрите изменения с помощью `git diff`. Например: ++ +[source, shell] +.... +% git add . +% git diff --staged +.... ++ +Убедитесь, что все необходимые файлы включены, затем зафиксируйте изменение в вашей локальной ветке и создайте патч с помощью `git format-patch` ++ +[source, shell] +.... +% git commit +% git format-patch origin/main +.... ++ +Патч, созданный с помощью `git format-patch`, будет содержать идентификатор автора и адреса электронной почты, что упрощает применение разработчиками (с помощью `git am`) и правильное указание авторства. ++ +[IMPORTANT] +====== +Чтобы упростить применение патча коммиттерами в их рабочей копии дерева документации, пожалуйста, сгенерируйте файл [.filename]#.diff# из корня вашего дерева документации. +====== ++ +. Отправьте патч или diff-файл с помощью веб-системы https://bugs.FreeBSD.org/bugzilla/enter_bug.cgi?product=Documentation[Problem Report]. При использовании веб-формы укажите в поле _Summary_ краткое описание проблемы. Выберите компонент `Documentation`. В поле _Description_ введите краткое описание проблемы из поля _Summary_ и добавьте _patch_ в поле _Keywords_. Используйте кнопку btn:[Add an attachment], чтобы прикрепить патч или diff-файл. Наконец, нажмите кнопку btn:[Submit Bug], чтобы отправить ваш diff в систему отчетов об ошибках. +==== + +[[mac-os-installation-process]] +=== Процесс установки macOS(R) + +[.procedure] +==== + +. Установите эти пакеты с помощью link:https://brew.sh/[Homebrew] и link:https://rubygems.org/[RubyGem]. ++ +[source, shell] +.... +$ brew install hugo ruby git bmake +.... ++ +. Добавьте Ruby в Path. ++ +[source, shell] +.... +$ echo 'export PATH="$(brew --prefix ruby)/bin:$PATH"' >> ~/.zshrc +$ echo 'export PATH="$(brew --prefix hugo)/bin:$PATH"' >> ~/.zshrc +$ echo 'export GEM_PATH="$(gem environment gemdir)"' >> ~/.zshrc +$ echo 'export PATH="${GEM_PATH}/bin:$PATH"' >> ~/.zshrc +$ source ~/.zshrc +.... +. Установите пакет rouge с помощью RubyGem. ++ +[source, shell] +.... +$ sudo gem install rouge asciidoctor asciidoctor-pdf asciidoctor-epub3 +.... ++ +. Установите локальную рабочую копию документации из репозитория FreeBSD в [.filename]#~/doc# (см. crossref:working-copy[working-copy,Рабочая копия]). ++ +[source, shell] +.... +$ git clone https://git.FreeBSD.org/doc.git ~/doc +.... ++ +. Отредактируйте файлы документации, которые требуют изменений. Если файлу нужны значительные изменения, обратитесь за советом в список рассылки. ++ +Просмотрите вывод и отредактируйте файлы, чтобы исправить обнаруженные проблемы, затем снова запустите команду, чтобы найти оставшиеся проблемы. Повторяйте, пока все ошибки не будут устранены. ++ +. Всегда собирайте и тестируйте изменения перед их отправкой. Запуск `bmake` в подкаталогах `documentation` или `website` сгенерирует документацию в формате HTML. ++ +[source, shell] +.... +$ bmake run USE_RUBYGEMS=YES RUBY_CMD=$(brew --prefix ruby)/bin/ruby +.... +. Добавьте все файлы с помощью `git add .`, затем просмотрите изменения с помощью `git diff`. Например: ++ +[source, shell] +.... +% git add . +% git diff --staged +.... ++ +Убедитесь, что все необходимые файлы включены, затем зафиксируйте изменение в вашей локальной ветке и создайте патч с помощью `git format-patch` ++ +[source, shell] +.... +% git commit +% git format-patch origin/main +.... ++ +Патч, созданный с помощью `git format-patch`, будет содержать идентификатор автора и адреса электронной почты, что упрощает применение разработчиками (с помощью `git am`) и правильное указание авторства. ++ +[IMPORTANT] +====== +Чтобы упростить применение патча коммиттерами в их рабочей копии дерева документации, пожалуйста, сгенерируйте файл [.filename]#.diff# из корня вашего дерева документации. +====== ++ +. Отправьте патч или diff-файл с помощью веб-системы https://bugs.FreeBSD.org/bugzilla/enter_bug.cgi?product=Documentation[Problem Report]. При использовании веб-формы укажите в поле _Summary_ краткое описание проблемы. Выберите компонент `Documentation`. В поле _Description_ введите краткое описание проблемы из поля _Summary_ и добавьте _patch_ в поле _Keywords_. Используйте кнопку btn:[Add an attachment], чтобы прикрепить патч или diff-файл. Наконец, нажмите кнопку btn:[Submit Bug], чтобы отправить ваш diff в систему отчетов об ошибках. +==== + +[[overview-doc]] +== Набор документации FreeBSD + +FDP отвечает за четыре категории документации FreeBSD. + +* _Руководство_: Руководство представляет собой всеобъемлющий онлайн-ресурс и справочник для пользователей FreeBSD. +* _FAQ_: В разделе Часто задаваемых вопросов (FAQ) используется формат коротких вопросов и ответов для решения вопросов, часто задаваемых в различных почтовых рассылках и форумах, посвящённых FreeBSD. Такой формат не подразумевает длинных и развёрнутых ответов. +* _Справочник_: Страницы Справочника (man-страницы) системы на английском языке обычно не создаются FDP, так как они являются частью базовой системы. Однако FDP может перефразировать части существующих руководств, чтобы сделать их понятнее или исправить неточности. +* _Веб-сайт_: Это основное представительство FreeBSD в интернете, доступное по адресу https://www.freebsd.org/[https://www.FreeBSD.org/] и на множестве зеркал по всему миру. Веб-сайт обычно становится первым знакомством нового пользователя с FreeBSD. + +Команды переводчиков отвечают за перевод Руководства и веб-сайта на разные языки. На данный момент руководства (man-страницы) не переводятся. + +Исходные тексты документации для веб-сайта FreeBSD, Handbook и FAQ доступны в репозитории документации по адресу `https://cgit.freebsd.org/doc/`. + +Исходный код страниц справочника доступен в отдельном репозитории, расположенном по адресу `https://cgit.freebsd.org/src/`. + +Документация сообщений о фиксациях доступна с помощью `git log`. Сообщения о фиксациях также архивируются по ссылке:link:{dev-commits-doc-all}. + +Веб-интерфейсы для обоих репозиториев доступны по адресам https://cgit.freebsd.org/doc/[] и https://cgit.freebsd.org/src/[]. + +Большое количество авторов участвовало в написании руководств или инструкций по FreeBSD. Некоторые из этих документов хранятся в рамках файлов FDP. В других случаях авторы предпочли лпубликовать документацию отдельно. FDP стремится предоставить ссылки на как можно большее количество такой внешней документации. diff --git a/documentation/content/ru/books/fdp-primer/overview/_index.po b/documentation/content/ru/books/fdp-primer/overview/_index.po new file mode 100644 index 0000000000..2779c0823d --- /dev/null +++ b/documentation/content/ru/books/fdp-primer/overview/_index.po @@ -0,0 +1,721 @@ +# SOME DESCRIPTIVE TITLE +# Copyright (C) YEAR The FreeBSD Project +# This file is distributed under the same license as the FreeBSD Documentation package. +# Vladlen Popolitov <vladlenpopolitov@list.ru>, 2025. +msgid "" +msgstr "" +"Project-Id-Version: FreeBSD Documentation VERSION\n" +"POT-Creation-Date: 2025-09-20 14:02+0300\n" +"PO-Revision-Date: 2025-09-05 04:45+0000\n" +"Last-Translator: Vladlen Popolitov <vladlenpopolitov@list.ru>\n" +"Language-Team: Russian <https://translate-dev.freebsd.org/projects/" +"documentation/booksfdp-primeroverview_index/ru/>\n" +"Language: ru\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Plural-Forms: nplurals=3; plural=n%10==1 && n%100!=11 ? 0 : n%10>=2 && " +"n%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2;\n" +"X-Generator: Weblate 4.17\n" + +#. type: Yaml Front Matter Hash Value: description +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:1 +#, no-wrap +msgid "Overview about the FreeBSD Documentation Process" +msgstr "Обзор процесса создания документации FreeBSD" + +#. type: Yaml Front Matter Hash Value: title +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:1 +#, no-wrap +msgid "Chapter 1. Overview" +msgstr "Глава 1. Обзор" + +#. type: Title = +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:14 +#, no-wrap +msgid "Overview" +msgstr "Обзор" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:53 +msgid "" +"Welcome to the FreeBSD Documentation Project (FDP). Quality documentation " +"is crucial to the success of FreeBSD, and we value your contributions very " +"highly." +msgstr "" +"Добро пожаловать в Проект документации FreeBSD (FDP). Качественная " +"документация крайне важна для успеха FreeBSD, и мы очень высоко ценим ваш " +"вклад." + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:55 +msgid "" +"This document describes how the FDP is organized, how to write and submit " +"documentation, and how to effectively use the available tools." +msgstr "" +"Этот документ описывает организацию FDP, как писать и отправлять " +"документацию, а также как эффективно использовать доступные инструменты." + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:58 +msgid "" +"Everyone is welcome to contribute to the FDP. Willingness to contribute is " +"the only membership requirement." +msgstr "" +"Все желающие могут внести свой вклад в FDP. Готовность помочь — единственное " +"требование для участия." + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:60 +msgid "This primer shows how to:" +msgstr "Это руководство показывает, как:" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:62 +msgid "Understand the role of documentation and its place in the ecosystem." +msgstr "Понять роль документации и её место в экосистеме." + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:63 +msgid "Identify which parts of FreeBSD are maintained by the FDP." +msgstr "Определите, какие части FreeBSD поддерживаются FDP." + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:64 +msgid "Install the required documentation tools and files." +msgstr "Установить необходимые инструменты и файлы документации." + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:65 +msgid "Make changes to the documentation." +msgstr "Внести изменения в документацию." + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:66 +msgid "" +"Submit changes back for review and inclusion in the FreeBSD documentation." +msgstr "Представить изменения для проверки и включения в документацию FreeBSD." + +#. type: Title == +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:68 +#, no-wrap +msgid "Documentation in the FreeBSD Ecosystem" +msgstr "Документация в экосистеме FreeBSD" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:72 +msgid "" +"All documents are for the benefit of their readers, not their writers or " +"caretakers. They should adapt to the reader and not expect the reader to " +"adapt to them." +msgstr "" +"Все документы создаются для пользы читателей, а не их авторов или " +"сопровождающих. Они должны адаптироваться к читателю, а не ожидать, что " +"читатель адаптируется к ним." + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:74 +msgid "Never blame the reader for:" +msgstr "Никогда не вините читателя за:" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:76 +msgid "being unable to make use of a document easily or at all" +msgstr "невозможность легко или вообще использовать документ" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:77 +msgid "finding a document confusing" +msgstr "если документ показался ему непонятным" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:78 +msgid "not understanding a document or how to apply it" +msgstr "непонимание документа или того, как его применить" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:79 +msgid "" +"not finding an explicit answer or successfully bridging gaps (or connecting " +"dots) to reason their way to one" +msgstr "если он не нашел явный ответ или шаги, чтобы логически прийти к нему" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:81 +msgid "Instead, acknowledge that the document is:" +msgstr "Вместо этого подтвердите, что документ:" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:83 +msgid "inaccessible" +msgstr "недоступный" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:84 +msgid "confusing" +msgstr "запутанный" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:85 +msgid "hard to understand or apply" +msgstr "трудно понимаемый или применимый" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:86 +msgid "incomplete" +msgstr "неполный" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:88 +msgid "Then, make the document:" +msgstr "Затем создайте документ:" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:90 +msgid "more accessible" +msgstr "более доступный" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:91 +msgid "less confusing" +msgstr "менее запутанный" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:92 +msgid "clearer" +msgstr "более ясный" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:93 +msgid "more complete" +msgstr "более полный" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:95 +msgid "Use the following methods:" +msgstr "Используйте следующие методы:" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:97 +msgid "" +"apply link:https://webaim.org/intro/#principles[accessibility best " +"practices] to correct the problem reported and any similar ones you find" +msgstr "" +"Примените link:https://webaim.org/intro/#principles[лучшие практики " +"доступности], чтобы исправить выявленную проблему и любые подобные, которые " +"обнаружите" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:98 +msgid "rework or clarify the confusing structure or language" +msgstr "переработайте или уточните запутанную структуру или язык" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:99 +msgid "add relevant examples to the part that is hard to understand or apply" +msgstr "" +"добавьте соответствующие примеры к части, которая трудна для понимания или " +"применения" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:100 +msgid "fill in the gaps or add the missing stepping stones" +msgstr "заполните пробелы или добавьте недостающие промежуточные этапы" + +#. type: Title == +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:102 +#, no-wrap +msgid "Quick Start" +msgstr "Быстрый старт" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:108 +msgid "" +"Some preparatory steps must be taken before editing the FreeBSD " +"documentation. First, subscribe to the {freebsd-doc}. Some team members " +"also interact on the `#bsddocs` IRC channel on http://www.efnet.org/" +"[EFnet]. These people can help with questions or problems involving the " +"documentation." +msgstr "" +"Некоторые подготовительные шаги необходимо выполнить перед редактированием " +"документации FreeBSD. Сначала подпишитесь на рассылку {freebsd-doc}. " +"Некоторые участники команды также общаются в IRC-канале `#bsddocs` на http://" +"www.efnet.org/[EFnet]. Эти люди могут помочь с вопросами или проблемами, " +"связанными с документацией." + +#. type: Title === +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:110 +#, no-wrap +msgid "FreeBSD installation process" +msgstr "Процесс установки FreeBSD" + +#. type: delimited block = 4 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:115 +msgid "" +"Install these packages. The `docproj` _meta-port_ installs all the " +"applications required to do useful work with the FreeBSD documentation." +msgstr "" +"Установите эти пакеты. _Мета-порт_ `docproj` устанавливает все приложения, " +"необходимые для работы с документацией FreeBSD." + +#. type: delimited block . 4 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:119 +#, no-wrap +msgid "# pkg install docproj\n" +msgstr "# pkg install docproj\n" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:122 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:196 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:278 +msgid "" +"Install a local working copy of the documentation from the FreeBSD " +"repository in [.filename]#~/doc# (see crossref:working-copy[working-copy,The " +"Working Copy])." +msgstr "" +"Установите локальную рабочую копию документации из репозитория FreeBSD в " +"[.filename]#~/doc# (см. crossref:working-copy[working-copy,Рабочая копия])." + +#. type: delimited block . 4 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:126 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:200 +#, no-wrap +msgid "% git clone https://git.FreeBSD.org/doc.git ~/doc\n" +msgstr "% git clone https://git.FreeBSD.org/doc.git ~/doc\n" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:129 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:203 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:285 +msgid "" +"Edit the documentation files that require changes. If a file needs major " +"changes, consult the mailing list for input." +msgstr "" +"Отредактируйте файлы документации, которые требуют изменений. Если файлу " +"нужны значительные изменения, обратитесь за советом в список рассылки." + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:132 +msgid "" +"Review the output and edit the file to fix any problems shown, then rerun " +"the command to find any remaining problems. Repeat until all of the errors " +"are resolved." +msgstr "" +"Просмотрите вывод и отредактируйте файл, чтобы исправить указанные проблемы, " +"затем повторно запустите команду для поиска оставшихся проблем. Повторяйте, " +"пока все ошибки не будут устранены." + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:134 +#, fuzzy +#| msgid "" +#| "*_Always_* build and review the changes before submitting them. Running " +#| "`make` in the `documentation` or `website` subdirectories will generate " +#| "the documentation in HTML format.\n" +msgid "" +"*_Always_* build and review the changes before submitting them. Running " +"`make` in the `documentation` or `website` subdirectories will generate the " +"documentation in HTML format." +msgstr "" +"*_Всегда_* собирайте и проверяйте изменения перед отправкой. Запуск команды " +"`make` в подкаталогах `documentation` или `website` сгенерирует документацию " +"в формате HTML.\n" + +#. type: delimited block . 4 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:138 +#, no-wrap +msgid "% make\n" +msgstr "% make\n" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:141 +msgid "To reduce compile time, only one language can be compiled:" +msgstr "" +"Для сокращения времени компиляции может быть скомпилирован только один язык:" + +#. type: delimited block . 4 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:145 +#, no-wrap +msgid "% make DOC_LANG=en\n" +msgstr "% make DOC_LANG=en\n" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:148 +msgid "" +"The build output is stored in [.filename]#~/doc/documentation/public/en/" +"articles/# and [.filename]#~/doc/documentation/public/en/books/#." +msgstr "" +"Результаты сборки сохраняются в [.filename]#~/doc/documentation/public/en/" +"articles/# и [.filename]#~/doc/documentation/public/en/books/#." + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:150 +msgid "" +"Review the build output and ensure the edits are free from typos, layout " +"problems, or errors. If any errors are found during the build process, edit " +"the problematic files to fix any issues that show up, then run the build " +"command again until all errors are resolved." +msgstr "" +"Просмотрите вывод сборки и убедитесь, что правки не содержат опечаток, " +"проблем с версткой или ошибок. Если в процессе сборки обнаружены ошибки, " +"отредактируйте проблемные файлы, чтобы исправить все возникшие проблемы, " +"затем снова запустите команду сборки, пока все ошибки не будут устранены." + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:152 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:215 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:296 +msgid "" +"Add all the files with `git add .`, then review the diff with `git diff`. " +"For example:" +msgstr "" +"Добавьте все файлы с помощью `git add .`, затем просмотрите изменения с " +"помощью `git diff`. Например:" + +#. type: delimited block . 4 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:157 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:220 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:301 +#, no-wrap +msgid "" +"% git add .\n" +"% git diff --staged\n" +msgstr "" +"% git add .\n" +"% git diff --staged\n" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:160 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:223 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:304 +msgid "" +"Make sure that all required files are included, then commit the change to " +"your local branch and generate a patch with `git format-patch`" +msgstr "" +"Убедитесь, что все необходимые файлы включены, затем зафиксируйте изменение " +"в вашей локальной ветке и создайте патч с помощью `git format-patch`" + +#. type: delimited block . 4 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:165 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:228 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:309 +#, no-wrap +msgid "" +"% git commit\n" +"% git format-patch origin/main\n" +msgstr "" +"% git commit\n" +"% git format-patch origin/main\n" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:169 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:232 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:313 +msgid "" +"Patch generated with `git format-patch` will include author identity and " +"email addresses, making it easier for developers to apply (with `git am`) " +"and give proper credit." +msgstr "" +"Патч, созданный с помощью `git format-patch`, будет содержать идентификатор " +"автора и адреса электронной почты, что упрощает применение разработчиками (с " +"помощью `git am`) и правильное указание авторства." + +#. type: delimited block = 6 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:174 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:237 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:318 +msgid "" +"To make it easier for committers to apply the patch on their working copy of " +"the documentation tree, please generate the [.filename]#.diff# from the base " +"of your documentation tree." +msgstr "" +"Чтобы упростить применение патча коммиттерами в их рабочей копии дерева " +"документации, пожалуйста, сгенерируйте файл [.filename]#.diff# из корня " +"вашего дерева документации." + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:177 +msgid "" +"In the example above, changes have been made to the *bsdinstall* portion of " +"the Handbook." +msgstr "" +"В приведенном выше примере были внесены изменения в раздел *bsdinstall* " +"Руководства." + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:179 +msgid "" +"Submit the patch or diff file using the web-based https://bugs.FreeBSD.org/" +"bugzilla/enter_bug.cgi?product=Documentation[Problem Report] system. If " +"using the web form, enter a Summary of _[patch] short description of " +"problem_. Select the Component `Documentation`. In the Description field, " +"enter a short description of the changes and any important details about " +"them. Use the btn:[Add an attachment] button to attach the patch or diff " +"file. Finally, use the btn:[Submit Bug] button to submit your diff to the " +"problem report system." +msgstr "" +"Отправьте патч или diff-файл с помощью веб-системы https://bugs.FreeBSD.org/" +"bugzilla/enter_bug.cgi?product=Documentation[Problem Report]. При " +"использовании веб-формы укажите в поле Summary _[patch] краткое описание " +"проблемы_. Выберите Component `Documentation`. В поле Description введите " +"краткое описание изменений и любые важные детали о них. Используйте кнопку " +"btn:[Add an attachment], чтобы прикрепить патч или diff-файл. Наконец, " +"нажмите кнопку btn:[Submit Bug], чтобы отправить ваш diff в систему отчетов " +"об ошибках." + +#. type: Title === +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:182 +#, no-wrap +msgid "GNU/Linux installation process" +msgstr "Процесс установки GNU/Linux" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:189 +msgid "" +"Install these packages in apt-based systems like Debian or Ubuntu. On other " +"GNU/Linux distributions the package names may change. Consult your " +"distribution's package manager if in doubt." +msgstr "" +"Установите эти пакеты в системах на основе apt, таких как Debian или " +"Ubuntu. В других дистрибутивах GNU/Linux названия пакетов могут " +"отличаться. В случае сомнений обратитесь к менеджеру пакетов вашего " +"дистрибутива." + +#. type: delimited block . 4 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:193 +#, no-wrap +msgid "# apt install hugo ruby-asciidoctor ruby-asciidoctor-pdf ruby-rouge git bmake\n" +msgstr "# apt install hugo ruby-asciidoctor ruby-asciidoctor-pdf ruby-rouge git bmake\n" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:206 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:288 +msgid "" +"Review the output and edit the files to fix any problems shown, then rerun " +"the command to find any remaining problems. Repeat until all of the errors " +"are resolved." +msgstr "" +"Просмотрите вывод и отредактируйте файлы, чтобы исправить обнаруженные " +"проблемы, затем снова запустите команду, чтобы найти оставшиеся проблемы. " +"Повторяйте, пока все ошибки не будут устранены." + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:208 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:290 +msgid "" +"Always build and test the changes before submitting them. Running `bmake` in " +"the `documentation` or `website` subdirectories will generate the " +"documentation in HTML format." +msgstr "" +"Всегда собирайте и тестируйте изменения перед их отправкой. Запуск `bmake` в " +"подкаталогах `documentation` или `website` сгенерирует документацию в " +"формате HTML." + +#. type: delimited block . 4 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:212 +#, no-wrap +msgid "% bmake run LOCALBASE=/usr\n" +msgstr "% bmake run LOCALBASE=/usr\n" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:245 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:326 +msgid "" +"Submit the patch or diff file using the web-based https://bugs.FreeBSD.org/" +"bugzilla/enter_bug.cgi?product=Documentation[Problem Report] system. If " +"using the web form, enter a Summary of _short description of problem_. " +"Select the Component `Documentation`. In the Description field, enter a " +"short description of the problem in the _Summary_ field and add _patch_ to " +"the _Keywords_ field. Use the btn:[Add an attachment] button to attach the " +"patch or diff file. Finally, use the btn:[Submit Bug] button to submit your " +"diff to the problem report system." +msgstr "" +"Отправьте патч или diff-файл с помощью веб-системы https://bugs.FreeBSD.org/" +"bugzilla/enter_bug.cgi?product=Documentation[Problem Report]. При " +"использовании веб-формы укажите в поле _Summary_ краткое описание проблемы. " +"Выберите компонент `Documentation`. В поле _Description_ введите краткое " +"описание проблемы из поля _Summary_ и добавьте _patch_ в поле _Keywords_. " +"Используйте кнопку btn:[Add an attachment], чтобы прикрепить патч или diff-" +"файл. Наконец, нажмите кнопку btn:[Submit Bug], чтобы отправить ваш diff в " +"систему отчетов об ошибках." + +#. type: Title === +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:248 +#, no-wrap +msgid "macOS(R) installation process" +msgstr "Процесс установки macOS(R)" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:254 +msgid "" +"Install these packages using link:https://brew.sh/[Homebrew] and " +"link:https://rubygems.org/[RubyGem]." +msgstr "" +"Установите эти пакеты с помощью link:https://brew.sh/[Homebrew] и " +"link:https://rubygems.org/[RubyGem]." + +#. type: delimited block . 4 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:258 +#, no-wrap +msgid "$ brew install hugo ruby git bmake\n" +msgstr "$ brew install hugo ruby git bmake\n" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:261 +msgid "Add Ruby to the Path." +msgstr "Добавьте Ruby в Path." + +#. type: delimited block . 4 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:269 +#, no-wrap +msgid "" +"$ echo 'export PATH=\"$(brew --prefix ruby)/bin:$PATH\"' >> ~/.zshrc\n" +"$ echo 'export PATH=\"$(brew --prefix hugo)/bin:$PATH\"' >> ~/.zshrc\n" +"$ echo 'export GEM_PATH=\"$(gem environment gemdir)\"' >> ~/.zshrc\n" +"$ echo 'export PATH=\"${GEM_PATH}/bin:$PATH\"' >> ~/.zshrc\n" +"$ source ~/.zshrc\n" +msgstr "" +"$ echo 'export PATH=\"$(brew --prefix ruby)/bin:$PATH\"' >> ~/.zshrc\n" +"$ echo 'export PATH=\"$(brew --prefix hugo)/bin:$PATH\"' >> ~/.zshrc\n" +"$ echo 'export GEM_PATH=\"$(gem environment gemdir)\"' >> ~/.zshrc\n" +"$ echo 'export PATH=\"${GEM_PATH}/bin:$PATH\"' >> ~/.zshrc\n" +"$ source ~/.zshrc\n" + +#. type: Plain text +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:271 +msgid "Install the rouge package using RubyGem." +msgstr "Установите пакет rouge с помощью RubyGem." + +#. type: delimited block . 4 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:275 +#, no-wrap +msgid "$ sudo gem install rouge asciidoctor asciidoctor-pdf asciidoctor-epub3\n" +msgstr "$ sudo gem install rouge asciidoctor asciidoctor-pdf asciidoctor-epub3\n" + +#. type: delimited block . 4 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:282 +#, no-wrap +msgid "$ git clone https://git.FreeBSD.org/doc.git ~/doc\n" +msgstr "$ git clone https://git.FreeBSD.org/doc.git ~/doc\n" + +#. type: delimited block . 4 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:294 +#, no-wrap +msgid "$ bmake run USE_RUBYGEMS=YES RUBY_CMD=$(brew --prefix ruby)/bin/ruby\n" +msgstr "$ bmake run USE_RUBYGEMS=YES RUBY_CMD=$(brew --prefix ruby)/bin/ruby\n" + +#. type: Title == +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:329 +#, no-wrap +msgid "The FreeBSD Documentation Set" +msgstr "Набор документации FreeBSD" + +#. type: delimited block = 4 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:332 +msgid "The FDP is responsible for four categories of FreeBSD documentation." +msgstr "FDP отвечает за четыре категории документации FreeBSD." + +#. type: delimited block = 4 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:334 +msgid "" +"_Handbook_: The Handbook is the comprehensive online resource and reference " +"for FreeBSD users." +msgstr "" +"_Руководство_: Руководство представляет собой всеобъемлющий онлайн-ресурс и " +"справочник для пользователей FreeBSD." + +#. type: delimited block = 4 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:335 +msgid "" +"_FAQ_: The FAQ uses a short question and answer format to address questions " +"that are frequently asked on the various mailing lists and forums devoted to " +"FreeBSD. This format does not permit long and comprehensive answers." +msgstr "" +"_FAQ_: В разделе Часто задаваемых вопросов (FAQ) используется формат " +"коротких вопросов и ответов для решения вопросов, часто задаваемых в " +"различных почтовых рассылках и форумах, посвящённых FreeBSD. Такой формат не " +"подразумевает длинных и развёрнутых ответов." + +#. type: delimited block = 4 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:336 +msgid "" +"_Manual pages_: The English language system manual pages are usually not " +"written by the FDP, as they are part of the base system. However, the FDP " +"can reword parts of existing manual pages to make them clearer or to correct " +"inaccuracies." +msgstr "" +"_Справочник_: Страницы Справочника (man-страницы) системы на английском " +"языке обычно не создаются FDP, так как они являются частью базовой системы. " +"Однако FDP может перефразировать части существующих руководств, чтобы " +"сделать их понятнее или исправить неточности." + +#. type: delimited block = 4 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:337 +msgid "" +"_Web site_: This is the main FreeBSD presence on the web, visible at https://" +"www.freebsd.org/[https://www.FreeBSD.org/] and many mirrors around the " +"world. The web site is typically a new user's first exposure to FreeBSD." +msgstr "" +"_Веб-сайт_: Это основное представительство FreeBSD в интернете, доступное по " +"адресу https://www.freebsd.org/[https://www.FreeBSD.org/] и на множестве " +"зеркал по всему миру. Веб-сайт обычно становится первым знакомством нового " +"пользователя с FreeBSD." + +#. type: delimited block = 4 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:340 +msgid "" +"Translation teams are responsible for translating the Handbook and web site " +"into different languages. Manual pages are not translated at present." +msgstr "" +"Команды переводчиков отвечают за перевод Руководства и веб-сайта на разные " +"языки. На данный момент руководства (man-страницы) не переводятся." + +#. type: delimited block = 4 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:342 +msgid "" +"Documentation source for the FreeBSD web site, Handbook, and FAQ is " +"available in the documentation repository at `https://cgit.freebsd.org/doc/`." +msgstr "" +"Исходные тексты документации для веб-сайта FreeBSD, Handbook и FAQ доступны " +"в репозитории документации по адресу `https://cgit.freebsd.org/doc/`." + +#. type: delimited block = 4 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:344 +msgid "" +"Source for manual pages is available in a separate source repository located " +"at `https://cgit.freebsd.org/src/`." +msgstr "" +"Исходный код страниц справочника доступен в отдельном репозитории, " +"расположенном по адресу `https://cgit.freebsd.org/src/`." + +#. type: delimited block = 4 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:347 +msgid "" +"Documentation commit messages are visible with `git log`. Commit messages " +"are also archived at link:{dev-commits-doc-all}." +msgstr "" +"Документация сообщений о фиксациях доступна с помощью `git log`. Сообщения " +"о фиксациях также архивируются по ссылке:link:{dev-commits-doc-all}." + +#. type: delimited block = 4 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:349 +msgid "" +"Web frontends to both of these repositories are available at https://" +"cgit.freebsd.org/doc/[] and https://cgit.freebsd.org/src/[]." +msgstr "" +"Веб-интерфейсы для обоих репозиториев доступны по адресам https://" +"cgit.freebsd.org/doc/[] и https://cgit.freebsd.org/src/[]." + +#. type: delimited block = 4 +#: documentation/content/en/books/fdp-primer/overview/_index.adoc:353 +msgid "" +"Many people have written tutorials or how-to articles about FreeBSD. Some " +"are stored as part of the FDP files. In other cases, the author has decided " +"to keep the documentation separate. The FDP endeavors to provide links to " +"as much of this external documentation as possible." +msgstr "" +"Большое количество авторов участвовало в написании руководств или инструкций " +"по FreeBSD. Некоторые из этих документов хранятся в рамках файлов FDP. В " +"других случаях авторы предпочли лпубликовать документацию отдельно. FDP " +"стремится предоставить ссылки на как можно большее количество такой внешней " +"документации." |