หน้านี้มีรายละเอียดของโปรเจ็กต์การเขียนเชิงเทคนิคที่ได้รับการยอมรับสำหรับ Google Season of Docs
สรุปโปรเจ็กต์
- องค์กรโอเพนซอร์ส
- Cloud Native Computing Foundation (CNCF)
- นักเขียนเชิงเทคนิค
- Syam Sundar K
- ชื่อโปรเจ็กต์:
- ตัวอย่าง Kubectl เพิ่มเติมและดีขึ้น
- ระยะเวลาของโปรเจ็กต์
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
วัตถุประสงค์ของโปรเจ็กต์นี้คือเพื่อปรับปรุงชีตเคล็ดลับและเอกสารอ้างอิง kubectl ที่มีอยู่
เป้าหมายสูงสุดของโปรเจ็กต์นี้คือ • สร้างตัวอย่าง kubectl เพิ่มเติมและดีขึ้น • เพิ่มตัวอย่าง kubectl ลงในเคล็ดลับ kubectl • ปรับโครงสร้างเอกสาร kubectl ให้เป็นประโยชน์สูงสุด
เป้าหมายที่ 1 - ตัวอย่างสำหรับ kubectl
จะทํางานอย่างใกล้ชิดกับกลุ่มความสนใจพิเศษของ CLI เพื่อรับบริบทของตัวอย่างประเภทใดที่ผู้ใช้ kubernetes ต้องการมากที่สุดและบันทึกไว้ ซึ่งอาจทำได้ตั้งแต่การปรับปรุงคําสั่ง kubectl ที่มีอยู่ในชีตเคล็ดลับ ไปจนถึงการเพิ่มคําสั่งใหม่ลงในชีตเคล็ดลับ
เป้าหมายที่ 2 - เพิ่มความเป็นประโยชน์ของเอกสาร
หากต้องการเพิ่มประโยชน์ของเอกสาร คุณสามารถทำสิ่งต่อไปนี้ได้:
• ขจัดความยุ่งยากสำหรับผู้เริ่มต้น • จัดเรียงคำสั่ง kubectl ใหม่ตามลำดับเพื่อให้แน่ใจว่ามีความต่อเนื่องในลำดับเชิงตรรกะ
ลดความยุ่งยากสําหรับผู้เริ่มต้นด้วยคําอธิบายคําสั่ง / กรณีการใช้งานที่ดีขึ้น เรื่องนี้อาจดูเป็นเรื่องง่าย แต่ก็มีอิทธิพลต่อผู้เริ่มต้นให้เรียนรู้ต่อหรือเลิกเรียนไปได้อย่างมาก ตัวอย่างเช่น เมื่อเริ่มต้นใช้งาน Kubernetes ผ่าน kubectl ฉันไม่แน่ใจเกี่ยวกับความแตกต่างระหว่างพ็อดกับการใช้งาน ตอนแรกเราติดตั้งใช้งานบริการแบ็กเอนด์ที่เขียนด้วย nodejs หลังจากผ่านไป 2-3 ชั่วโมง เราต้องการปิดระบบ จึงลองลบพ็อด แต่เนื่องจากพ็อดมีความสามารถในการซ่อมแซมตัวเอง ระบบจึงสร้างพ็อดขึ้นมาอีกครั้ง ฉันรู้สึกสับสนกับสิ่งที่เกิดขึ้นและสงสัยว่าทำไมถึงมีการสร้างผลงานใหม่ขึ้นมาแต่ไม่ถูกลบ หลังจากค้นหาข้อมูลบนเว็บ 2-3 ครั้ง เราพบว่าการลบพ็อดไม่เหมือนกับการลบการนําส่ง สำหรับคนฝึกสายตาแล้ว สิ่งนี้อาจดูเรียบง่าย แต่ก็เป็นคำอธิบายที่ชัดเจนซึ่งขจัดความกำกวมเหล่านี้ ซึ่งช่วยแยกแยะเอกสารที่ดีออกจากเอกสารที่ยอดเยี่ยมได้
จัดเรียงคำสั่ง kubectl ใหม่ตามลำดับเพื่อให้มีความต่อเนื่องในโฟลว์เชิงตรรกะ หากคุณเป็นคนหนึ่งเช่นเราที่เชื่อมั่นในเรื่องการเล่าเรื่อง คุณอาจสงสัยว่าจะนำองค์ประกอบการเล่าเรื่องมาใส่ในสเปรดชีตที่มีรายการคำสั่งในเทอร์มินัลได้อย่างไร เราขอบอกว่าทำได้ ทุกอย่างที่เราเรียนรู้มีลำดับที่สมเหตุสมผลเสมอ ไม่ว่าจะเป็นจุดเริ่มต้นและจุดสิ้นสุด Kubectl เป็นเครื่องมือบรรทัดคำสั่งที่ต้องใช้การเรียนรู้ แน่นอนว่าการเรียนรู้นั้นสอดคล้องกับการเรียนรู้ Kubernetes เอง เนื่องจากเกือบทุกคนเริ่มต้นเส้นทางการใช้งาน kubernetes ผ่าน kubectl (ยกเว้นผู้ใช้ UI บนเว็บ) และเนื่องจากช่วงการเรียนรู้ของ kubectl เชื่อมโยงกับช่วงการเรียนรู้ของ kubernetes อย่างใกล้ชิด เอกสารจึงปรับปรุงให้ดียิ่งขึ้นได้อย่างมากเพียงเปลี่ยนลําดับคําสั่งเหล่านี้และเพิ่มองค์ประกอบการเล่าเรื่องเข้าไป ตัวอย่างเช่น คุณสามารถอธิบายฟีเจอร์อย่างการปรับขนาด Pod แนวนอนได้หลังจากอธิบายทรัพยากรด้วยตัวอย่างและภาพประกอบจากโลกแห่งความเป็นจริง
เป้าหมาย III - การปรับปรุงความสามารถในการใช้งานเอกสาร:
การย้ายข้อมูลเว็บไซต์ Kubernetes ไปยัง Docsy Hugo เมื่อเร็วๆ นี้ยอดเยี่ยมมากและเป็นการเปลี่ยนแปลงครั้งใหญ่ในมุมมองเอกสาร แม้ว่าการย้ายข้อมูลจะสำเร็จ แต่ยังมีช่องว่างสำหรับการปรับปรุงอีกมากมายในพื้นที่ทำงานของเอกสาร
การเปลี่ยนแปลงที่เราแนะนํามีดังนี้
• แผงด้านซ้ายจะเลื่อนไปยังส่วนที่ใช้งานอยู่บนเอกสารหลักโดยอัตโนมัติ - การทำงานนี้มีประโยชน์ในการติดตามส่วนปัจจุบัน ส่วนที่กำลังจะเกิดขึ้น และที่ผ่านมา • คัดลอกไปยังคลิปบอร์ด - คำสั่งบางรายการอาจยาว ฟังก์ชันการคัดลอกจึงมีประโยชน์เมื่อใช้คำสั่งประเภทนี้ • การจัดรูปแบบเนื้อหาของไฟล์เอกสาร - หลังจากการโยกย้าย เนื้อหาในหน้าเว็บบางหน้าไม่ได้มีการจัดรูปแบบอย่างเหมาะสม เช่น ส่วนประเภททรัพยากรในภาพรวม kubectl ซึ่งจะทำให้ประสบการณ์ของผู้ใช้แย่ลง
นี่คือการเปลี่ยนแปลงที่ช่วยปรับปรุงประสบการณ์ของผู้ใช้ในเว็บไซต์ Kubernetes และยังเพิ่มประสิทธิภาพการทำงานของผู้ใช้ได้อีกด้วย