Cette page contient les détails d'un projet de rédaction technique accepté pour Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- PostgreSQL
- Rédacteur technique:
- lu
- Nom du projet:
- Tutoriel d'introduction
- Durée du projet:
- Durée standard (3 mois)
Project description
Mettez à jour le tutoriel d'introduction pour améliorer l'installation et la configuration de PostgreSQL pour les débutants. (https://www.postgresql.org/docs/current/tutorial-start.html)
Transformez le chapitre sur les principes de base de l'architecture en une introduction complète aux tutoriels PostgreSQL (https://www.postgresql.org/docs/current/tutorial-arch.html). Il est possible de développer l'architecture client-serveur, psql comme exemple de client à utiliser dans ce tutoriel, la terminologie "cluster" dans le contexte PostgreSQL, les utilisateurs de base de données par rapport au système d'exploitation et les droits de propriété.
le tutoriel d'installation des mises à jour (https://www.postgresql.org/docs/current/tutorial-install.html).
- Annoncez les options d'installation source et binaire. Ajoutez une référence à l'adresse https://www.postgresql.org/download/, qui propose un minimum d'instructions d'installation du binaire.
- Identifiez les lacunes dans les instructions d’installation du binaire, le cas échéant, et développez le site Web ou corrigez-les dans la documentation.
- Ne comptez pas sur la lecture et l'identification de l'intégralité du chapitre sur l'installation du code source par les utilisateurs: décrivez les principales étapes requises après l'installation, telles que l'initialisation du cluster et le démarrage (automatique) du serveur. Fournissez des liens vers des chapitres de la documentation spécifiques pour plus de détails, le cas échéant.
- Ajoutez des liens "Voir également" vers des ressources pertinentes qui développent les paramètres par défaut et les bonnes pratiques pour un système d'exploitation particulier, si la communauté les reconnaît.
Améliorer https://www.postgresql.org/docs/current/tutorial-createdb.html
- Dans la mesure du possible, supprimez les instructions de type "Consultez l'administrateur". Fournissez des solutions exploitables en partant du principe que l'utilisateur a suivi le tutoriel étape par étape.
Améliorer https://www.postgresql.org/docs/current/tutorial-accessdb.html
- Expliquer les problèmes de base liés à l'authentification et des exemples simples de pg_hba.conf
Pour fournir ce correctif de documentation, j'ai l'intention d'essayer le tutoriel actuel sur Windows et Ubuntu, de parcourir les forums pour connaître les problèmes de configuration fréquents et de consulter des mentors pour s'assurer que j'applique les bonnes pratiques et que les concepts les plus importants sont expliqués sans trop simplifier la procédure.