En esta página, se incluyen 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
- Redactor técnico:
- lu
- Nombre del proyecto:
- Instructivo introductorio
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
Se actualizó el instructivo introductorio para mejorar la experiencia de instalación y configuración de PostgreSQL para principiantes. (https://www.postgresql.org/docs/current/tutorial-start.html)
Convierte el capítulo Fundamentos de la arquitectura en una introducción integral a los instructivos de PostgreSQL (https://www.postgresql.org/docs/current/tutorial-arch.html). Entre los temas que puedes ampliar, se incluyen la arquitectura cliente-servidor, psql como ejemplo de cliente que se usará en este instructivo, la terminología ""clúster"" en el contexto de PostgreSQL, los usuarios y la propiedad de la BD en comparación con los del SO.
Actualiza el instructivo de instalación (https://www.postgresql.org/docs/current/tutorial-install.html).
- Anuncia las opciones de instalación de origen y binaria. Agrega una referencia a https://www.postgresql.org/download/, que ofrece instrucciones mínimas de instalación de objetos binarios.
- Identifica brechas en las instrucciones de instalación de objetos binarios, si corresponde, y expande el sitio web o abórdalas en la documentación.
- No supongas que los usuarios leerán todo el capítulo de instalación de fuentes y lo resolverán. Describe los pasos principales que se requieren después de la instalación, como inicializar el clúster y (auto)iniciar el servidor. Proporciona vínculos a capítulos específicos de la documentación para obtener más detalles cuando corresponda.
- Agrega vínculos de ver también a recursos relevantes que expandan los valores predeterminados y las prácticas recomendadas para un SO en particular, si la comunidad reconoce alguno.
Mejora https://www.postgresql.org/docs/current/tutorial-createdb.html
- Elimina las instrucciones de "consultar al administrador" siempre que sea posible y proporciona soluciones prácticas en función de 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 de pg_hba.conf triviales
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 frecuentes de configuración y consultar a mentores para asegurarme de seguir las prácticas recomendadas correctas y de explicar los conceptos más importantes sin simplificar demasiado.