หน้านี้มีรายละเอียดของโปรเจ็กต์การเขียนเชิงเทคนิคที่ได้รับการยอมรับสำหรับ Google Season of Docs
สรุปโปรเจ็กต์
- องค์กรโอเพนซอร์ส:
- Jenkins X
- นักเขียนเชิงเทคนิค
- Nitin
- ชื่อโปรเจ็กต์:
- การจัดระเบียบเว็บไซต์เอกสารประกอบและตารางความสามารถของ Jenkins X ที่มีอยู่ใหม่
- ความยาวของโปรเจ็กต์:
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
วัตถุประสงค์หลักของโปรเจ็กต์นี้คือการเปลี่ยนโครงสร้างภายในเอกสารของ Jenkins X ที่มีอยู่ในขณะที่แก้ไขปัญหาที่เกี่ยวข้องกับเอกสาร และจัดเตรียมเมทริกซ์ความสามารถของ Jenkins X ที่อัปเดตใหม่พร้อมกับเอกสารประกอบผู้ใช้เกี่ยวกับการใช้ Jenkins X กับผู้ให้บริการระบบคลาวด์ขององค์กร นอกจากนี้ โปรเจ็กต์นี้ยังเกี่ยวข้องกับการพัฒนาโครงสร้างพื้นฐานสภาวะแวดล้อมเวอร์ชันตัวอย่างของ Jenkins X โดยอิงตาม OpenShift ซึ่งทำงานร่วมกับ Daniel
ปัญหาบางส่วนที่เราจะดำเนินการแก้ไขเป็นส่วนหนึ่งของการปรับโครงสร้างเอกสารประกอบ Jenkins X ที่มีอยู่ ได้แก่
- การบูตในทรัพยากร EKS: ปัญหา
- ห้องนิรภัยไม่สำเร็จใน EKS ด้วยปัญหาการบูต
- เอกสาร envars สําหรับการบูต jx: ปัญหา
- เอกสารประกอบที่จําเป็นสําหรับการตั้งค่าห้องนิรภัย: ปัญหา
- การอัปเกรดการบูตจากเครื่องไปยังห้องนิรภัยไม่สำเร็จ: ปัญหา
- ความคิดเห็นเกี่ยวกับเอกสารประกอบความสัมพันธ์ของ "create" กับ "install jx" กับ "boot" กับ "import": ปัญหา
- เอกสารประกอบของ Helm อยู่กระจัดกระจาย: ปัญหา
- ปรับปรุงเอกสารว่าเหตุใดจึงไม่ใช้ Nexus แทน ChartMuseum, Monocular และ Docker Registry
- เปลี่ยน Docker Registry ไม่ได้เมื่อใช้การเปิดเครื่อง + GKE: ปัญหา
- การเปลี่ยนโดเมนจาก nip.io เป็นโดเมนที่กำหนดเองไม่สำเร็จ: ปัญหา
สำหรับตารางเปรียบเทียบความสามารถของ Jenkins X งานที่เกี่ยวข้อง (ตามที่ระบุไว้ด้านล่าง) สำหรับบริการ Kubernetes สำหรับองค์กรที่ให้บริการโดยผู้ให้บริการระบบคลาวด์แต่ละราย ได้แก่ Google Cloud (GKE), Amazon Web Services (AWS EKS) และ Azure Cloud (AKS)
- การติดตั้ง Jenkins X ในระบบคลาวด์ผ่านสคริปต์ Terraform และ
jx boot
- ตรวจสอบความเข้ากันได้ของเวอร์ชัน Kubernetes กับ Jenkins X ในบริการ Kubernetes ของผู้ให้บริการระบบคลาวด์เหล่านี้
- ความสามารถอื่นๆ (พื้นที่เก็บข้อมูลของห้องนิรภัยสำหรับข้อมูลลับ เวอร์ชันการควบคุมแหล่งที่มา หรืออื่นๆ) ที่จะพูดคุยกับ Deane และสมาชิกชุมชน Jenkins X
งานเกี่ยวกับการตั้งค่าโครงสร้างพื้นฐานของสภาพแวดล้อมการแสดงตัวอย่าง Jenkins X โดยอิงตาม OpenShift งานประกอบด้วยการดำเนินการต่อไปนี้
- ออกแบบเอกสารบนโครงสร้างพื้นฐานของสภาพแวดล้อมการแสดงตัวอย่าง Jenkins X บนแพลตฟอร์ม OpenShift
- สร้างสภาพแวดล้อมเวอร์ชันตัวอย่างของ Jenkins X ใน OpenShift โดยอัตโนมัติ
- อัปเดตเอกสารประกอบสำหรับ Jenkins X ในสภาพแวดล้อมเวอร์ชันตัวอย่าง
สิ่งที่ส่งมอบของโครงการ:
- แก้ไขผ่าน PR สำหรับปัญหาเกี่ยวกับเอกสารที่กล่าวถึงข้างต้น โดยพิจารณาที่จะรีแฟกทอริงเอกสารประกอบ Jenkins X ที่มีอยู่
- ตารางความสามารถของ Jenkins X ที่อัปเดตแล้วพร้อมด้วยเอกสารประกอบสำหรับผู้ใช้เกี่ยวกับการใช้ Jenkins X กับผู้ให้บริการระบบคลาวด์รายต่างๆ (บริการ Kubernetes โดยส่วนใหญ่คือ AKS, EKS และ GKE)
- การตั้งค่าโครงสร้างพื้นฐานของสภาพแวดล้อมเวอร์ชันตัวอย่างของ Jenkins X โดยอัตโนมัติซึ่งอิงตาม OpenShift โดยร่วมมือกับ Daniel
ลำดับเวลาโดยประมาณ (พร้อมกับงาน) ที่เสนอ
ความสัมพันธ์ในชุมชน (17 ส.ค. - 13 ก.ย.)
- ตั้งค่าสภาพแวดล้อมการพัฒนาสําหรับเอกสารทางเทคนิค รวมถึงรับสิทธิ์เข้าถึงโครงสร้างพื้นฐานระบบคลาวด์สําหรับทํางานในโปรเจ็กต์
- การพูดคุยกับที่ปรึกษาโครงการเกี่ยวกับลำดับเวลาที่เสนอคร่าวๆ สิ่งที่ต้องส่งของโปรเจ็กต์ รวมถึงงาน (พร้อมลำดับความสำคัญ)
- ทําความเข้าใจและเตรียมพร้อมให้พร้อมสําหรับกระบวนการทํางานขององค์กร กระบวนการตรวจสอบการประชาสัมพันธ์ และมีส่วนร่วมกับชุมชน
- ตรวจสอบสถานะเอกสารประกอบปัจจุบันของ Jenkins X
สัปดาห์ที่ 1 (14 ก.ย. - 20 ก.ย.)
- ทําความเข้าใจวิธีการตั้งค่า Jenkins X ในระบบคลาวด์ สถานะปัจจุบัน และเอกสารประกอบ
- การพูดคุยกับ Deane เกี่ยวกับความสามารถปัจจุบันของ Jenkins X (เพื่อยืนยันในผู้ให้บริการระบบคลาวด์รายต่างๆ)
- การสนทนากับ Daniel เกี่ยวกับสถานะปัจจุบันของโครงสร้างพื้นฐานสภาพแวดล้อมเวอร์ชันตัวอย่างของ Jenkins X ซึ่งอิงตาม OpenShift
- ทำงาน (ร่วมกับ Daniel) เพื่อออกแบบสถาปัตยกรรมสําหรับโครงสร้างพื้นฐานของสภาพแวดล้อมเวอร์ชันตัวอย่างของ Jenkins X ใน OpenShift
สัปดาห์ที่ 2 (21-27 กันยายน)
- ทำงานกับตารางความสามารถของ Jenkins X สำหรับ GKE Cloud: การติดตั้ง Jenkins X และเตรียมร่างหมายเหตุผู้ใช้
- ทำงานกับปัญหา docs-issue รายการใดรายการหนึ่งเพื่อปรับปรุงเอกสารประกอบ Jenkins X ที่มีอยู่
สัปดาห์ที่ 3 (28 ก.ย. - 4 ต.ค.)
- ทำงานกับตารางความสามารถของ Jenkins X สำหรับ GKE Cloud: การติดตั้ง Jenkins X และเตรียมร่างหมายเหตุผู้ใช้
- ทำงานกับปัญหา docs-issue รายการใดรายการหนึ่งเพื่อปรับปรุงเอกสารประกอบ Jenkins X ที่มีอยู่
- ทำงานเกี่ยวกับเอกสารการออกแบบสําหรับโครงสร้างพื้นฐานของสภาพแวดล้อมพรีวิวของ Jenkins X โดยอิงตาม OpenShift
สัปดาห์ที่ 4 (5-11 ต.ค.)
- จัดทำเอกสารสำหรับผู้ใช้ Jenkins X ใน GKE ให้เสร็จสมบูรณ์
- ทำงานกับปัญหา docs-issue รายการใดรายการหนึ่งเพื่อปรับปรุงเอกสารประกอบ Jenkins X ที่มีอยู่
สัปดาห์ที่ 5 (12-18 ต.ค.)
- ดำเนินการกับเมทริกซ์ความสามารถของ Jenkins X สำหรับระบบคลาวด์ Azure (AKS) ได้แก่ การติดตั้ง Jenkins X และการเตรียมบันทึกผู้ใช้ฉบับร่าง
- ทำงานกับปัญหา docs-issue รายการใดรายการหนึ่งเพื่อปรับปรุงเอกสารประกอบ Jenkins X ที่มีอยู่
- สรุปเอกสารการออกแบบสำหรับโครงสร้างพื้นฐานของสภาพแวดล้อมตัวอย่างของ Jenkins X ที่อิงตาม OpenShift หลังจากได้รับความคิดเห็นจากสมาชิกในชุมชน
สัปดาห์ที่ 6 (19-25 ต.ค.)
- ทำงานกับตารางความสามารถของ Jenkins X สำหรับระบบคลาวด์ Azure (AKS): การติดตั้ง Jenkins X และเตรียมร่างหมายเหตุผู้ใช้
- ทำงานกับปัญหา docs-issue รายการใดรายการหนึ่งเพื่อปรับปรุงเอกสารประกอบของ Jenkins X ที่มีอยู่
สัปดาห์ที่ 7 (26 ต.ค. - 1 พ.ย.)
- ดำเนินการกับเมทริกซ์ความสามารถของ Jenkins X สำหรับระบบคลาวด์ Azure (AKS) ได้แก่ การติดตั้ง Jenkins X และการเตรียมบันทึกผู้ใช้ฉบับร่าง
- ทำงานกับปัญหา docs-issue รายการใดรายการหนึ่งเพื่อปรับปรุงเอกสารประกอบ Jenkins X ที่มีอยู่
- ตั้งค่าโครงสร้างพื้นฐานของสภาพแวดล้อมเวอร์ชันตัวอย่างของ Jenkins X โดยอิงตาม OpenShift
สัปดาห์ที่ 8 (2-8 พ.ย.)
- จัดทำเอกสารสำหรับผู้ใช้ Jenkins X ใน AKS ให้เสร็จสมบูรณ์
- ดำเนินการกับหนึ่งในปัญหาเกี่ยวกับเอกสารเพื่อปรับปรุงเอกสารประกอบของ Jenkins X ที่มีอยู่
สัปดาห์ที่ 9 (9 - 15 พ.ย.)
- ทำงานกับตารางความสามารถของ Jenkins X สำหรับ AWS (EKS): การติดตั้ง Jenkins X และเตรียมร่างโน้ตผู้ใช้
- ทำงานกับปัญหา docs-issue รายการใดรายการหนึ่งเพื่อปรับปรุงเอกสารประกอบ Jenkins X ที่มีอยู่
- ตั้งค่าโครงสร้างพื้นฐานของสภาพแวดล้อมเวอร์ชันตัวอย่างของ Jenkins X โดยอิงตาม OpenShift
สัปดาห์ที่ 10 (16 - 22 พ.ย.)
- ทำงานบนเมทริกซ์ความสามารถ Jenkins X สำหรับ AWS (EKS) ได้แก่ การติดตั้ง Jenkins X และการเตรียมบันทึกผู้ใช้ฉบับร่าง
- ทำงานกับปัญหา docs-issue รายการใดรายการหนึ่งเพื่อปรับปรุงเอกสารประกอบ Jenkins X ที่มีอยู่
สัปดาห์ที่ 11 (23 - 29 พ.ย.)
- จัดทำเอกสารสำหรับผู้ใช้ Jenkins X ใน EKS ให้เสร็จสมบูรณ์
- ดำเนินการกับหนึ่งในปัญหาเกี่ยวกับเอกสารเพื่อปรับปรุงเอกสารประกอบของ Jenkins X ที่มีอยู่
- จัดทำเอกสารประกอบเกี่ยวกับโครงสร้างพื้นฐานของสภาพแวดล้อมเวอร์ชันตัวอย่างของ Jenkins X ให้เสร็จสมบูรณ์ในเว็บไซต์เอกสารของ Jenkins X
สัปดาห์ที่ 12 (30 พ.ย. - 5 ธ.ค.)
- จัดทำเนื้อหาที่ส่งมอบของโปรเจ็กต์ให้เสร็จสมบูรณ์และปรับโครงสร้างโค้ด (หากมี) โดยอิงตามความคิดเห็น
- ทดสอบการทำงานของเว็บไซต์เอกสาร Jenkins X ซึ่งรวมถึงลิงก์ รูปภาพ ไฮเปอร์ลิงก์ และอื่นๆ
- ตรวจสอบการควบคุมและการนําทางที่ผู้ใช้กําหนดของเว็บไซต์เอกสารประกอบของ Jenkins X
- ดูงานนำเสนอที่เสร็จสมบูรณ์แล้วของเมทริกซ์ Jenkins X Capabilites
ก่อนวันที่ 10 ธ.ค. 2020 ทั้งนักเขียนและที่ปรึกษาด้านเทคนิคจะส่งการประเมินโครงการ
โครงการที่เสนอจะมีประโยชน์ต่อ Jenkins X และชุมชนอย่างไร โปรเจ็กต์นี้จะช่วยให้ชุมชน Jenkins X ปรับปรุงเอกสารประกอบสำหรับผู้ใช้ปลายทางและนักพัฒนาซอฟต์แวร์เพื่อใช้เป็นข้อมูลอ้างอิงเกี่ยวกับสถาปัตยกรรมทางเทคนิค ความเข้ากันได้ การใช้งาน และการผสานรวมของ Jenkins X เมื่อโปรเจ็กต์ที่เสนอนี้เสร็จสมบูรณ์ จะมีเอกสารประกอบสำหรับผู้ใช้ที่ครบถ้วนสมบูรณ์ ระบุไว้เป็นอย่างดี และยืนยันทางเทคนิคของ Jenkins X พร้อมกับ Jenkins X Capability Matrix เพื่อให้สามารถใช้งานร่วมกับผู้ให้บริการระบบคลาวด์รายต่างๆ ได้
คุณวางแผนที่จะใช้ Jenkins X เพื่อรับประโยชน์ใดในอนาคต หลังจากสิ้นสุดโปรแกรม Google Season of Docs 2020 แล้ว เราวางแผนที่จะเป็นผู้มีส่วนร่วมระยะยาวในโปรเจ็กต์ Jenkins X ในฐานะสมาชิกที่มีส่วนร่วมของชุมชน ฉันจะคอยช่วยเหลือผู้อื่น (ผู้มาใหม่) และสนับสนุนให้พวกเขามีส่วนร่วมในชุมชน Jenkins X เสมอ เรายินดีที่จะทำงานกับแนวคิดโปรเจ็กต์ Jenkins X อื่นๆ เสมอ
เหตุผลที่ฉันเหมาะที่จะทำงานในโปรเจ็กต์นี้
- ผมมีระบบระเบียบและเป็นระเบียบมาก เราหวังว่าจะได้รับข้อมูลความคืบหน้าของโปรเจ็กต์ทั้งจากพี่เลี้ยงโครงการและชุมชนขององค์กรผ่านบล็อกโพสต์ทุกสัปดาห์ การประชุม SIG-docs ที่จัดขึ้นทุกสัปดาห์ และทางอีเมลเป็นประจำ
- จะขอคำแนะนำและความคิดเห็นจากพี่เลี้ยงและสมาชิกชุมชนเป็นประจำ เพื่อให้งานก้าวหน้าและทุกคนเข้าใจตรงกัน (รวมถึงพูดถึงความท้าทายและ/หรือปัญหาที่พบ)
- เขียนซอร์สโค้ดทั้งหมดที่เขียนขึ้นเป็นประจำ เพื่อให้มีการตรวจสอบโค้ดจากที่ปรึกษา ผู้ร่วมให้ข้อมูล และจัดทำเอกสารเกี่ยวกับงานที่ทำขึ้นเพื่อใช้อ้างอิงกับสมาชิกในชุมชน
- ผมมีทักษะด้านเทคนิคทั้งหมดที่ต้องใช้ในการสร้างไอเดียสำหรับโครงการนี้ และได้หารือเกี่ยวกับข้อเสนอของโครงการกับที่ปรึกษา Deane, Kara และ Daniel แล้ว เราเข้าใจอย่างละเอียดเกี่ยวกับข้อเสนอโปรเจ็กต์และสิ่งที่ส่งมอบ
- ฉันมีประสบการณ์ด้านทักษะทางเทคนิค (Google Cloud, Azure Cloud, AWS, Kubernetes, OpenShift, Hugo และอื่นๆ) ที่จำเป็นในการจัดเตรียมเอกสารประกอบที่สมบูรณ์ รวมถึงแก้ปัญหาส่วนใหญ่ที่เกี่ยวข้องกับเอกสารประกอบในปัจจุบัน ฉันมีทัศนคติเชิงบวก ทำโครงการให้เสร็จได้ตรงเวลาโดยมีการควบคุมดูแลเพียงเล็กน้อย