โปรเจ็กต์ PostgreSQL

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

ข้อมูลสรุปของโปรเจ็กต์

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

PostgreSQL

ผู้เขียนด้านเทคนิค:

ลู

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

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

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

ระยะเวลามาตรฐาน (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 กับผู้ใช้ระบบปฏิบัติการ และการเป็นเจ้าของ

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, เรียกดูฟอรัมสำหรับปัญหาในการตั้งค่าที่เกิดขึ้นบ่อย และปรึกษาที่ปรึกษาเพื่อให้แน่ใจว่าฉันได้รับแนวทางปฏิบัติที่ดีที่สุดและอธิบายแนวคิดที่สำคัญที่สุดโดยไม่อธิบายให้เข้าใจได้ง่ายเกินไป