Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per Google Season of Docs.
Riepilogo del progetto
- Organizzazione open source:
- PostgreSQL
- Technical writer:
- lu
- Nome progetto:
- Tutorial introduttivo
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Aggiorna il tutorial introduttivo per migliorare l'esperienza di installazione e configurazione di PostgreSQL per principianti. (https://www.postgresql.org/docs/current/tutorial-start.html)
Converti il capitolo Architectural Fundamentals in un'introduzione esaustiva ai tutorial PostgreSQL (https://www.postgresql.org/docs/current/tutorial-arch.html). Le possibili opzioni di espansione sono l'architettura client-server, psql come esempio di client da usare in questo tutorial, la terminologia "cluster" nel contesto PostgreSQL, gli utenti del database o del sistema operativo e la proprietà.
Aggiorna il tutorial sull'installazione (https://www.postgresql.org/docs/current/tutorial-install.html).
- Pubblicizza le opzioni di installazione di origine e binaria. Aggiungi riferimento a https://www.postgresql.org/download/ che offre istruzioni minime per l'installazione binaria.
- Identifica eventuali lacune nelle istruzioni per l'installazione binaria, quindi espandi il sito web o risolvile nella documentazione.
- Non fare affidamento sul fatto che gli utenti leggano e capiscano l'intero capitolo sull'installazione del codice sorgente: descrivi i passaggi principali richiesti dopo l'installazione, come l'inizializzazione del cluster e l'avvio (automatico) del server. Fornisci link a capitoli specifici della Documentazione per maggiori dettagli, ove applicabile.
- Aggiungi link vedi anche alle risorse pertinenti che spiegano i valori predefiniti e le best practice per un particolare sistema operativo, se ce ne sono riconosciuti dalla community.
Migliora https://www.postgresql.org/docs/current/tutorial-createdb.html
- Non utilizzare le istruzioni di "consultare l'amministratore" ove possibile; fornisci soluzioni attuabili basandoti sul presupposto che l'utente ha seguito il tutorial passo passo.
Migliora https://www.postgresql.org/docs/current/tutorial-accessdb.html
- Spiega i problemi di base relativi all'autenticazione e gli esempi banali di pg_hba.conf
Per fornire questa patch della documentazione, intendo provare il tutorial attuale su Windows e Ubuntu, sfogliare i forum per problemi di configurazione frequenti e consultare i mentori per assicurarmi di ottenere le best practice giuste e i concetti più importanti vengono spiegati senza semplificazioni eccessive.