На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- Проект FreeBSD
- Технический писатель:
- Ларри
- Название проекта:
- Обновления руководств по FreeBSD
- Длина проекта:
- Длительный ход (5 месяцев)
Описание проекта
Этот проект GSoD2020 будет состоять из двух глав в руководствах FreeBSD:
- Тестирование: новая глава в «Справочнике разработчика FreeBSD»
- LDAP: обновленная статья объединена в главу справочника FreeBSD.
Тестирование: новая глава в «Справочнике разработчика FreeBSD»:
ПРИМЕЧАНИЕ. Вначале этот проект носит скорее исследовательский характер. Требования могут меняться на этапе написания.
Задачи подготовки включают в себя: * Просмотр текущей документации и заметок по средам, практикам и т. д. тестирования разработчиков для FreeBSD и других BSD(ов). * Текущая или более старая документация и примечания FreeBSD. Например: * TestSuite: https://wiki.freebsd.org/TestSuite * Старая страница «TestingFreeBSD»: https://wiki.freebsd.org/TestingFreeBSD * Текущая документация и примечания из связанных проектов. Например: * http://wiki.netbsd.org/tutorials/atf/ * Первичная документация по задействованным инструментам. Например: * Платформа тестирования Kyua: https://github.com/jmmv/kyua/ * Платформа автоматического тестирования (ATF): https://github.com/jmmv/atf/ * Установка и настройка соответствующих платформ для ознакомления. . * Использование фреймворков тестирования для запуска текущих тестов. * Написание небольшого количества новых тестов. * (ОЧЕНЬ важно) Консультирование читателей (разработчиков ПО и тестировщиков) о том, что они хотят видеть в главе.
Необходимо определить точную организацию документации. Однако после прочтения главы читатель должен уметь сделать как минимум следующее:
- Установите и настройте среды тестирования для тестирования FreeBSD.
- Напишите тест для среды тестирования.
- Запустите тест в среде тестирования.
Там, где это возможно, будет подчеркнуто следующее: * максимальная автоматизация для сокращения работы по настройке тестовой инфраструктуры, написанию тестов и запуску тестов. * добавление тестовых примеров всякий раз, когда исправлена новая ошибка. * комплексное автоматическое регрессионное тестирование. * (где это применимо) с примерами стандартных сценариев тестирования, таких как модульное тестирование, функциональное тестирование, нагрузочное тестирование и т. д.
Там, где это возможно, цель состоит в том, чтобы не просто объяснить и направить разработчика по системе тестирования, но и, надеюсь, сделать процесс максимально простым, чтобы разработчики поощряли проводить больше тестирования, а новые разработчики не отказывались от участия.
LDAP: обновленная статья объединена в главу справочника FreeBSD:
В отличие от главы «Тестирование», объем обновленной статьи или главы, посвященной LDAP, хорошо понятен.
Текущая глава Руководства FreeBSD и текущая статья содержат много полезной информации. Однако их необходимо обновить. Начата новая редакция статьи, призванная стать новой главой, но ее необходимо завершить.
В задачи входит: * Корректировка текущей главы руководства и текущей статьи. * При подготовке к GSoD2020 был выполнен первоначальный этап. * Тестирование каждого раздела руководства, чтобы определить, что работает, а что необходимо пересмотреть. * При подготовке к GSoD2020 конфигурация сервера была протестирована и выявлены улучшения. * Остальные разделы остались. * Написание нового контента и пересмотр текущего контента. * Начато обновление контента для раздела серверов. Его необходимо завершить. * Остальные разделы остались. * Тестирование всего контента на чистых системах FreeBSD после завершения окончательного проекта. * Эта задача имеет решающее значение, поскольку позволяет выявить любые пробелы.
Ожидается, что последняя статья или глава руководства будет содержать следующие разделы:
(1) Введение в LDAP (2) Конфигурация сервера: (a) Поясняющее описание базовой, но функциональной конфигурации сервера OpenLDAP во FreeBSD. (b) Полный пример базовой, но функциональной конфигурации сервера OpenLDAP, например, результат (2a), во FreeBSD.
«Базовый, но функциональный» включает в себя настройку сервера с хешированными паролями, безопасные соединения по сети и смоделированные, но репрезентативные пользовательские данные.
(Необязательно – будет принято решение во время GSoD2020). Конфигурация сервера может также включать эквивалентную поддержку 389 Directory Server во FreeBSD. В 389 Directory Server существовала экспериментальная поддержка FreeBSD, но ее текущий статус необходимо подтвердить.
(3) Конфигурация клиента: (a) Поясняющее описание функциональной конфигурации клиента во FreeBSD, который может подключаться с помощью примера подключения к серверу, представленного в (2). (b) Полный пример функциональной конфигурации клиента, например результат (3a), во FreeBSD.
Раздел конфигурации клиента будет включать следующие подразделы: * Подключаемый модуль аутентификации (PAM), например pam_ldap, pam_mkhomedir, nss-pam-ldapd * Переключатель службы имен (NSS), например nss_ldap, nss-pam-ldapd * (Необязательно — To будет принято решение во время GSoD2020) SSSD — статус SSSD в производстве во FreeBSD должен быть подтвержден. * (Необязательно — будет принято решение во время GSoD2020) FreeIPA — необходимо изучить использование и функциональность FreeIPA во FreeBSD. FreeIPA охватывает не только LDAP, поэтому необходимо оценить объем конфигурации FreeIPA, прежде чем включать ее в эту главу руководства.
(4) Вопросы безопасности * Текущая версия статьи включает раздел, посвященный вопросам безопасности. Часть этого контента может быть перенесена в соответствующий раздел. Однако для справочных целей по-прежнему должен существовать специальный раздел, посвященный соображениям безопасности.
(5) Устранение неполадок * Стратегии устранения неполадок конфигурации LDAP.
(6) Приложение OpenSSL
С помощью обновленной главы/статьи руководства читатель может взять две чистые системы FreeBSD, настроить сервер LDAP и клиент LDAP и аутентифицировать клиента на сервере.
После прочтения обновленной главы/статьи руководства у читателя должна быть основа, необходимая для того, чтобы взять другую, более специализированную или полную документацию, например, документацию OpenLDAP, LDAP RFC, и построить или усовершенствовать свою конфигурацию LDAP FreeBSD в соответствии со своими требованиями.