โปรเจ็กต์ PostgreSQL

หน้านี้มีรายละเอียดของโปรเจ็กต์การเขียนเชิงเทคนิคที่ได้รับการยอมรับสำหรับ Google Season of Docs

สรุปโปรเจ็กต์

องค์กรโอเพนซอร์ส:

PostgreSQL

นักเขียนเชิงเทคนิค

lu

ชื่อโปรเจ็กต์:

บทแนะนำเบื้องต้น

ความยาวของโปรเจ็กต์:

ระยะเวลามาตรฐาน (3 เดือน)

คำอธิบายโปรเจ็กต์

อัปเดตบทแนะนำเบื้องต้นเพื่อปรับปรุงการติดตั้งและการตั้งค่า PostgreSQL สำหรับผู้เริ่มต้น (https://www.postgresql.org/docs/current/tutorial-start.html)

1. แปลงบทพื้นฐานทางสถาปัตยกรรมให้เป็นบทนำที่ครอบคลุมเกี่ยวกับบทแนะนำ PostgreSQL (https://www.postgresql.org/docs/current/tutorial-arch.html) สิ่งที่อาจขยายความได้คือสถาปัตยกรรมไคลเอ็นต์-เซิร์ฟเวอร์, psql เป็นตัวอย่างไคลเอ็นต์ที่จะใช้ในบทแนะนำนี้, คำว่า ""คลัสเตอร์"" ในบริบท PostgreSQL, ผู้ใช้และกรรมสิทธิ์ของ DB เทียบกับ OS

2. อัปเดตบทแนะนำการติดตั้ง (https://www.postgresql.org/docs/current/tutorial-install.html)

   • โฆษณาทั้งตัวเลือกการติดตั้งจากซอร์สโค้ดและไฟล์ไบนารี เพิ่มการอ้างอิงไปยัง https://www.postgresql.org/download/ ซึ่งมีวิธีการติดตั้งแบบไบนารีขั้นต่ำ
   • ระบุช่องโหว่ในวิธีการติดตั้งแบบไบนารี (หากมี) และขยายเว็บไซต์หรือแก้ไขในเอกสารประกอบ
   • อย่าคาดหวังให้ผู้ใช้อ่านบทการติดตั้งจากแหล่งที่มาฉบับเต็มและหาทางแก้ปัญหาเอง ให้ระบุขั้นตอนหลักที่จำเป็นหลังการติดตั้ง เช่น การจัดเตรียมคลัสเตอร์และเริ่มเซิร์ฟเวอร์ (โดยอัตโนมัติ) ระบุลิงก์ไปยังบทต่างๆ ของเอกสารประกอบเพื่อดูรายละเอียดเพิ่มเติม หากมี
   • เพิ่มลิงก์ "ดูเพิ่มเติม" ไปยังแหล่งข้อมูลที่เกี่ยวข้องซึ่งขยายความเกี่ยวกับค่าเริ่มต้นและแนวทางปฏิบัติแนะนำสำหรับระบบปฏิบัติการหนึ่งๆ หากมีแหล่งข้อมูลที่ชุมชนยอมรับ

3. ปรับปรุง https://www.postgresql.org/docs/current/tutorial-createdb.html

   • ลบวิธีการ "ปรึกษาผู้ดูแลระบบ" ออกเมื่อเป็นไปได้ ให้วิธีแก้ปัญหาที่ใช้งานได้โดยสมมติว่าผู้ใช้ทำตามบทแนะนำทีละขั้นตอน

4. ปรับปรุง https://www.postgresql.org/docs/current/tutorial-accessdb.html

   • อธิบายปัญหาพื้นฐานที่เกี่ยวข้องกับการตรวจสอบสิทธิ์และตัวอย่าง pg_hba.conf ที่ไม่ซับซ้อน

ในการจัดทำเอกสารประกอบฉบับนี้ เราตั้งใจที่จะลองใช้บทแนะนำปัจจุบันใน Windows และ Ubuntu, เรียกดูฟอรัมเพื่อหาปัญหาการตั้งค่าที่พบบ่อย และปรึกษาที่ปรึกษาเพื่อให้แน่ใจว่าเราได้แนวทางปฏิบัติแนะนำที่ถูกต้องและอธิบายแนวคิดที่สำคัญที่สุดโดยไม่ทำให้เข้าใจง่ายจนเกินไป