Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la GDOC Season of Docs.
Resumen del proyecto
- Organización de código abierto:
- El proyecto FreeBSD
- Redactor técnico:
- Larry
- Nombre del proyecto:
- Actualizaciones de los manuales de FreeBSD
- Duración del proyecto:
- Larga duración (5 meses)
Project description
Este proyecto de GSoD 2020 constará de dos capítulos de los manuales de FreeBSD:
- Pruebas: Nuevo capítulo en el Manual para desarrolladores de FreeBSD
- LDAP: Se actualizó el artículo y se fusionó en un capítulo del Manual de FreeBSD.
Pruebas: Nuevo capítulo en el Manual para desarrolladores de FreeBSD:
NOTA: Este proyecto es más exploratorio al principio. Los requisitos pueden cambiar durante la etapa de redacción.
Entre las tareas de preparación, se incluyen las siguientes: * Revisar la documentación y las notas actuales sobre los frameworks de pruebas, las prácticas, etc. de los desarrolladores para FreeBSD y otros BSD. * Documentación y notas actuales o anteriores de FreeBSD Por ejemplo: * TestSuite: https://wiki.freebsd.org/TestSuite * Página antigua ""TestingFreeBSD"": https://wiki.freebsd.org/TestingFreeBSD * Documentación y notas actuales de proyectos relacionados Por ejemplo: * http://wiki.netbsd.org/tutorials/atf/ * Documentación principal de las herramientas involucradas. Por ejemplo: * Framework de pruebas Kyua: https://github.com/jmmv/kyua/ * Framework de pruebas automatizadas (ATF): https://github.com/jmmv/atf/ * Instalar y configurar los frameworks relevantes para familiarizarse con ellos * Usar los frameworks de pruebas para ejecutar pruebas actuales * Escribir una pequeña cantidad de pruebas nuevas * (MUY importante) Consultar con los lectores (desarrolladores y verificadores de software) sobre lo que quieren ver en el capítulo.
Se determinará la organización exacta de la documentación. Sin embargo, después de leer el capítulo, el lector debería poder hacer lo siguiente como mínimo:
- Instala y configura los frameworks de prueba para probar FreeBSD.
- Escribe una prueba para el framework de pruebas.
- Ejecuta una prueba en el framework de pruebas.
Cuando sea posible, se enfatizará lo siguiente: * Maximizar la automatización para reducir el trabajo de configurar la infraestructura de pruebas, escribir pruebas y ejecutarlas. * Agregar casos de prueba cada vez que se solucione un error nuevo * Pruebas de regresión automatizadas integrales * (si corresponde) que incluya ejemplos de situaciones de prueba estándar, como pruebas de unidades, pruebas funcionales, pruebas de carga, etcétera.
Siempre que sea posible, el objetivo es no solo explicar y guiar al desarrollador a través del framework de pruebas, sino también mantener el proceso lo más simple posible para que los desarrolladores se sientan alentados a incorporar más pruebas y los desarrolladores nuevos no se desanimen a contribuir.
LDAP: Se actualizó el artículo y se fusionó en un capítulo del Manual de FreeBSD:
A diferencia del capítulo sobre pruebas, el alcance de un artículo o capítulo actualizado sobre LDAP está bien definido.
El capítulo actual del Manual de FreeBSD y el artículo actual contienen mucha información útil. Sin embargo, deben actualizarse. Se inició una nueva revisión del artículo, que se convertirá en el nuevo capítulo, pero aún debe completarse.
Entre las tareas, se incluyen las siguientes: * Revisar el capítulo y el artículo actuales del manual. * En preparación para GSoD2020, se realizó un pase inicial. * Probar cada sección del manual para confirmar qué funciona y qué se debe revisar * Como preparación para GSoD2020, se probó la configuración del servidor con las mejoras identificadas. * Otras secciones restantes * Redactar contenido nuevo y revisar el contenido actual * Se inició el contenido actualizado para la sección del servidor. Debe completarse. * Otras secciones restantes * Probar todo el contenido en sistemas FreeBSD limpios después de completar un borrador final * Esta tarea es fundamental, ya que identifica cualquier brecha.
Se espera que el artículo final o el capítulo del manual contengan las siguientes secciones:
(1) Introducción a LDAP (2) Configuración del servidor: (a) Una explicación paso a paso de una configuración básica pero funcional del servidor OpenLDAP en FreeBSD. b) Un ejemplo completo de una configuración básica pero funcional del servidor OpenLDAP, p.ej., el resultado de (2a), en FreeBSD.
""Básica, pero funcional"" incluye la configuración del servidor con contraseñas con hash, conexiones seguras a través de la red y datos de usuario simulados, pero representativos.
(Opcional, se decidirá durante GSoD2020) La configuración del servidor también puede incluir una cobertura equivalente del servidor del directorio 389 en FreeBSD. Había compatibilidad experimental con FreeBSD en el servidor de directorios 389, pero se debe confirmar su estado actual.
(3) Configuración del cliente: (a) Una explicación paso a paso de una configuración de cliente funcional en FreeBSD que se puede conectar con la conexión de servidor de ejemplo proporcionada en (2). b) Un ejemplo completo de una configuración de cliente funcional, p.ej., el resultado de (3a), en FreeBSD.
La sección de configuración del cliente incluirá subsecciones sobre lo siguiente: * Módulo de autenticación conectable (PAM), p. ej., pam_ldap, pam_mkhomedir, nss-pam-ldapd * Interruptor de servicio de nombres (NSS), p. ej., nss_ldap, p. ej., nss-pam-ldapd, p. ej., pam_ldap, pam_mkhomedir, nss-pam-ldapd * Interruptor de servicio de nombres (NSS), p. ej., nss_ldap, nss-pam-ldapd, decide el estado nss-pam-ldapd de nss-pam-ldapd para la confirmación de nss-pam-ldapd en producción. * (Opcional, se decidirá durante GSoD2020) FreeIPA: Se debe investigar el uso y la funcionalidad de FreeIPA en FreeBSD. FreeIPA abarca más que solo LDAP, por lo que se debe evaluar el alcance de la configuración de FreeIPA antes de incluirlo en este capítulo del manual.
(4) Consideraciones de seguridad * La versión actual del artículo incluye una sección sobre consideraciones de seguridad. Es posible que parte de este contenido se traslade a la sección correspondiente. Sin embargo, aún debe haber una sección dedicada a las consideraciones de seguridad a modo de referencia.
(5) Solución de problemas * Estrategias para solucionar problemas de configuración de LDAP.
(6) Apéndice de OpenSSL
Con el capítulo o artículo del manual actualizado, el lector puede tomar dos sistemas FreeBSD limpios, configurar un servidor y un cliente de LDAP, y autenticar el cliente en el servidor.
Después de leer el capítulo o artículo del manual actualizado, el lector debe tener los conocimientos necesarios para consultar otra documentación más especializada o integral, p.ej., la documentación de OpenLDAP, los RFC de LDAP y compilar o definir mejor su configuración de LDAP de FreeBSD para cumplir con sus requisitos.