Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la temporada de Documentos de Google.
Resumen del proyecto
- Organización de código abierto:
- PostgreSQL
- Escritor técnico:
- lu
- Nombre del proyecto:
- Instructivo introductorio
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
Actualiza el instructivo introductorio a fin de mejorar la experiencia de instalación y configuración de PostgreSQL para los principiantes. (https://www.postgresql.org/docs/current/tutorial-start.html)
Convierte el capítulo Aspectos básicos de la arquitectura en una introducción completa a los instructivos de PostgreSQL (https://www.postgresql.org/docs/current/tutorial-arch.html). Los aspectos posibles para ampliar son la arquitectura cliente-servidor, PSQL como ejemplo de cliente para usar en este instructivo, terminología de “clúster” en contexto de PostgreSQL, DB frente a usuarios del SO y propiedad.
Actualiza el instructivo de instalación (https://www.postgresql.org/docs/current/tutorial-install.html).
- Anuncia las opciones de instalación fuente y binaria. Se agregó una referencia a https://www.postgresql.org/download/ que ofrece instrucciones de instalación binarias mínimas.
- Identifica brechas en las instrucciones de instalación binarias, si las hubiera, y expande el sitio web o resuélvelas en la documentación.
- No dependas de que los usuarios lean el capítulo completo sobre la instalación de código fuente y lo descubran: describe los pasos principales necesarios después de la instalación, como inicializar el clúster e iniciar el servidor (automáticamente). Proporciona vínculos a capítulos de Documentación específicos para obtener más detalles cuando corresponda.
- Agrega vínculos de visualización también a recursos relevantes que amplían los valores predeterminados y las prácticas recomendadas para un SO en particular, en caso de que la comunidad reconozca alguno.
Mejora https://www.postgresql.org/docs/current/tutorial-createdb.html
- Deshazte de las instrucciones de “consulta al administrador” siempre que sea posible y proporciona soluciones prácticas basadas en la suposición de que el usuario siguió el instructivo paso a paso.
Mejora https://www.postgresql.org/docs/current/tutorial-accessdb.html
- Explicar problemas básicos relacionados con la autenticación y ejemplos triviales de pg_hba.conf
Para proporcionar este parche de documentación, tengo la intención de probar el instructivo actual en Windows y Ubuntu, explorar foros en busca de problemas de configuración frecuentes y consultar mentores para asegurarme de seguir las prácticas recomendadas y de explicar los conceptos más importantes sin simplificarlo en exceso.