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.