Cette page contient les détails d'un projet de rédaction technique accepté pour la 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 (trois mois)
Project description
Mise à jour du tutoriel d'introduction pour améliorer l'expérience d'installation et de configuration de PostgreSQL pour les débutants. (https://www.postgresql.org/docs/current/tutorial-start.html)
Convertissez le chapitre sur les principes fondamentaux de l'architecture en une introduction complète aux tutoriels PostgreSQL (https://www.postgresql.org/docs/current/tutorial-arch.html). Vous pouvez développer les points suivants : l'architecture client-serveur, psql en tant qu'exemple de client à utiliser dans ce tutoriel, la terminologie ""cluster"" dans le contexte PostgreSQL, les utilisateurs de la base de données et de l'OS, et la propriété.
Mise à jour du tutoriel d'installation (https://www.postgresql.org/docs/current/tutorial-install.html).
- Annoncez les options d'installation source et binaire. Ajout d'une référence à https://www.postgresql.org/download/, qui propose des instructions d'installation binaire minimales.
- Identifiez les lacunes dans les instructions d'installation binaire, le cas échéant, et développez le site Web ou corrigez-les dans la documentation.
- Ne comptez pas que les utilisateurs lisent le chapitre sur l'installation du code source dans son intégralité et le trouvent: 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 documentation spécifiques pour en savoir plus, le cas échéant.
- Ajoutez des liens "Voir aussi" vers des ressources pertinentes qui expliquent les valeurs par défaut et les bonnes pratiques pour un OS particulier, le cas échéant.
Amélioration https://www.postgresql.org/docs/current/tutorial-createdb.html
- Dans la mesure du possible, supprimez les instructions "Consultez l'administrateur". Proposez des solutions pratiques en partant du principe que l'utilisateur a suivi le tutoriel étape par étape.
Amélioration https://www.postgresql.org/docs/current/tutorial-accessdb.html
- Expliquer les problèmes de base liés à l'authentification et les exemples triviaux 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 y rechercher des problèmes de configuration fréquents, et de consulter des mentors pour m'assurer que je maîtrise les bonnes pratiques et que les concepts les plus importants sont expliqués sans trop simplifier.