Project PostgreSQL

Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.

Ringkasan project

Organisasi open source:
PostgreSQL
Penulis teknis:
lu
Nama proyek:
Tutorial Pengantar
Durasi project:
Durasi standar (3 bulan)

Project description

Perbarui tutorial pengantar untuk meningkatkan kualitas penginstalan dan pengalaman penyiapan PostgreSQL bagi pemula. (https://www.postgresql.org/docs/current/tutorial-start.html)

  1. Mengonversi bab Dasar-Dasar Arsitektur menjadi pengantar komprehensif untuk tutorial PostgreSQL (https://www.postgresql.org/docs/current/tutorial-arch.html). Hal-hal yang dapat diperluas adalah arsitektur server klien, psql sebagai contoh klien yang akan digunakan dalam tutorial ini, terminologi ""cluster"" dalam konteks PostgreSQL, pengguna dan kepemilikan DB vs OS.

  2. Update tutorial Penginstalan (https://www.postgresql.org/docs/current/tutorial-install.html).

    • Iklankan opsi penginstalan sumber dan biner. Tambahkan referensi ke https://www.postgresql.org/download/ yang menawarkan petunjuk penginstalan biner minimal.
    • Identifikasi kesenjangan dalam petunjuk penginstalan biner, jika ada, dan perluas situs atau bahas dalam dokumentasi.
    • Jangan mengandalkan pengguna untuk membaca seluruh bab penginstalan sumber dan mencari tahu sendiri: uraikan langkah-langkah utama yang diperlukan setelah penginstalan, seperti melakukan inisialisasi cluster dan memulai server (otomatis). Berikan link ke bab Dokumentasi tertentu untuk detail selengkapnya jika berlaku.
    • Tambahkan link lihat juga ke referensi relevan yang menjelaskan setelan default dan praktik terbaik untuk OS tertentu, jika ada yang diakui oleh komunitas.
  3. Tingkatkan https://www.postgresql.org/docs/current/tutorial-createdb.html

    • Hapus petunjuk ""konsultasikan dengan administrator"" jika memungkinkan; berikan solusi yang bisa ditindaklanjuti berdasarkan asumsi bahwa pengguna mengikuti tutorial langkah demi langkah.
  4. Tingkatkan https://www.postgresql.org/docs/current/tutorial-accessdb.html

    • Menjelaskan masalah dasar terkait autentikasi dan contoh pg_hba.conf yang tidak penting

Untuk memberikan patch dokumentasi ini, saya ingin mencoba tutorial saat ini di Windows dan Ubuntu, menjelajahi forum untuk menemukan masalah penyiapan yang sering terjadi, dan berkonsultasi dengan mentor untuk memastikan saya mendapatkan praktik terbaik yang tepat dan konsep yang paling penting dijelaskan tanpa penyederhanaan yang berlebihan.