Progetto PostgreSQL
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
Questa pagina contiene i dettagli di un progetto di documentazione tecnica accettato per la stagione della documentazione di Google.
Riepilogo del progetto
- Organizzazione open source:
- PostgreSQL
- Technical Writer:
- lu
- Nome del progetto:
- Tutorial introduttivo
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Aggiornamento del tutorial introduttivo per migliorare l'esperienza di installazione e configurazione di PostgreSQL per i principianti.
(https://www.postgresql.org/docs/current/tutorial-start.html)
Converti il capitolo Fondamenti dell'architettura in un'introduzione completa ai tutorial di PostgreSQL (https://www.postgresql.org/docs/current/tutorial-arch.html). È possibile approfondire l'architettura client-server, psql come esempio di client da utilizzare in questo tutorial, la terminologia ""cluster"" nel contesto di PostgreSQL, la proprietà e gli utenti del DB rispetto al sistema operativo.
Aggiorna il tutorial sull'installazione (https://www.postgresql.org/docs/current/tutorial-install.html).
- Pubblicizza le opzioni di installazione sia di origine che binaria. Aggiungi il riferimento a https://www.postgresql.org/download/ che offre istruzioni minime per l'installazione binaria.
- Identifica eventuali lacune nelle istruzioni di installazione binaria ed espandi il sito web o risolvile nella documentazione.
- Non fare affidamento sul fatto che gli utenti leggano l'intero capitolo sull'installazione del codice sorgente e lo capiscano: illustra i passaggi principali richiesti dopo l'installazione, ad esempio l'inizializzazione del cluster e l'avvio (automatico) del server. Fornisci link a capitoli specifici della documentazione per ulteriori dettagli, se applicabili.
- Aggiungi link "Guarda anche" a risorse pertinenti che illustrano le impostazioni predefinite e le best practice per un determinato sistema operativo, se riconosciute dalla community.
Migliora https://www.postgresql.org/docs/current/tutorial-createdb.html
- Elimina le istruzioni ""Rivolgiti all'amministratore"", se possibile, e fornisci soluzioni attuabili in base al presupposto che l'utente abbia seguito il tutorial passo passo.
Migliora https://www.postgresql.org/docs/current/tutorial-accessdb.html
- Spiega i problemi di base relativi all'autenticazione ed esempi banali di pg_hba.conf
Per fornire questa patch di documentazione, ho intenzione di provare l'attuale tutorial su Windows e Ubuntu, sfogliare i forum per i problemi di configurazione frequenti e consultare i mentori per assicurarmi di seguire le best practice corrette e di spiegare i concetti più importanti senza una eccessiva semplificazione.
Salvo quanto diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2025-07-25 UTC.
[null,null,["Ultimo aggiornamento 2025-07-25 UTC."],[[["\u003cp\u003eThis project aims to update the PostgreSQL introductory tutorial, focusing on improving the installation and setup process for beginners.\u003c/p\u003e\n"],["\u003cp\u003eThe project will revamp the tutorial's structure, providing a comprehensive introduction to PostgreSQL concepts like client-server architecture and database clusters.\u003c/p\u003e\n"],["\u003cp\u003eInstallation instructions will be enhanced to cover both source and binary options, addressing common setup challenges faced by new users.\u003c/p\u003e\n"],["\u003cp\u003eThe tutorial will empower users to independently create and access databases, simplifying instructions and providing solutions for typical authentication issues.\u003c/p\u003e\n"],["\u003cp\u003eThe project involves practical testing, community feedback analysis, and expert consultation to ensure clarity, accuracy, and relevance of the updated tutorial.\u003c/p\u003e\n"]]],["The project involves updating the PostgreSQL introductory tutorial for beginners. Key actions include converting the Architectural Fundamentals chapter into a comprehensive introduction, updating the Installation tutorial to cover both source and binary options, and outlining post-installation steps like initializing the cluster and starting the server. It also involves improving the create and access database tutorials by providing actionable solutions and explaining authentication basics, while aiming to minimize reliance on administrator consultation. The writer will test the tutorial on Windows and Ubuntu, and consult mentors.\n"],null,["# PostgreSQL project\n\nThis page contains the details of a technical writing project accepted for\nGoogle Season of Docs.\n\nProject summary\n---------------\n\nOpen source organization:\n: PostgreSQL\n\nTechnical writer:\n: lu\n\nProject name:\n: Introductory Tutorial\n\nProject length:\n: Standard length (3 months)\n\nProject description\n-------------------\n\nUpdate introductory tutorial to improve PostgreSQL installation and setup experience for beginners.\n(\u003chttps://www.postgresql.org/docs/current/tutorial-start.html\u003e)\n\n1. Convert the Architectural Fundamentals chapter into a comprehensive introduction to PostgreSQL tutorials (\u003chttps://www.postgresql.org/docs/current/tutorial-arch.html\u003e). Possible things to expand on are client-server architecture, psql as a client example to be used in this tutorial, \"\"cluster\"\" terminology in PostgreSQL context, DB vs OS users and ownership.\n\n2. Update Installation tutorial (\u003chttps://www.postgresql.org/docs/current/tutorial-install.html\u003e).\n\n - Advertise both source and binary install options. Add reference to \u003chttps://www.postgresql.org/download/\u003e that offers minimal binary install instructions.\n - Identify gaps in binary install instructions, if any, and either expand the website or address them in documentation.\n - Do not rely on users reading the full source-install chapter and figuring it out: outline the main steps required after the install, such as initializing the cluster and (auto)starting the server. Provide links to specific Documentation chapters for more details where applicable.\n - Add see-also links to relevant resources that expand on defaults and best practices for a particular OS, if there are any recognized by the community.\n3. Improve \u003chttps://www.postgresql.org/docs/current/tutorial-createdb.html\u003e\n\n - Get rid of \"\"consult the administrator\"\" instructions wherever possible; provide actionable solutions based on the assumption that the user followed the tutorial step-by-step.\n4. Improve \u003chttps://www.postgresql.org/docs/current/tutorial-accessdb.html\u003e\n\n - Explain basic issues related to authentication and trivial pg_hba.conf examples\n\nTo provide this documentation patch, I intend to try out the current tutorial on Windows and Ubuntu, browse forums for frequent setup issues, and consult mentors to ensure I get the best practices right and the most important concepts are explained without oversimplification."]]
