หน้านี้มีรายละเอียดของโครงการการเขียนเชิงเทคนิคที่ยอมรับสำหรับ Google Season of Docs
ข้อมูลสรุปของโปรเจ็กต์
- องค์กรโอเพนซอร์ส:
- เจนกินส์ เอ็กซ์
- ผู้เขียนด้านเทคนิค:
- นิติน
- ชื่อโปรเจ็กต์:
- การปรับโครงสร้างเว็บไซต์เอกสารของ Jenkins X และ Jenkins X Capabilities Matrix
- ระยะเวลาของโปรเจ็กต์:
- ระยะเวลามาตรฐาน (3 เดือน)
คำอธิบายโปรเจ็กต์
วัตถุประสงค์หลักของโครงการนี้คือการปรับโครงสร้างเอกสารของ Jenkins X ที่มีอยู่ใหม่พร้อมกับแก้ไขปัญหาเกี่ยวกับเอกสาร ตลอดจนเตรียมเมทริกซ์ความสามารถของ Jenkins X ที่อัปเดตแล้วพร้อมกับเอกสารประกอบสำหรับผู้ใช้เกี่ยวกับการใช้ Jenkins X ในผู้ให้บริการระบบคลาวด์ขององค์กร นอกจากนี้ โปรเจ็กต์นี้ยังเกี่ยวข้องกับการพัฒนาโครงสร้างพื้นฐานของสภาพแวดล้อมการแสดงตัวอย่าง Jenkins X บน OpenShift โดยร่วมมือกับ Daniel อีกด้วย
ในการปรับโครงสร้างเอกสารของ Jenkins X ที่มีอยู่ใหม่ ปัญหาบางประการที่เรากำลังดำเนินการมีดังนี้
- ทรัพยากรสำหรับการบูตใน EKS: ปัญหา
- ห้องนิรภัยล้มเหลวใน EKS เมื่อเปิดเครื่อง: ปัญหา
- Envars เอกสารสำหรับการเปิดเครื่อง JX: ปัญหา
- เอกสารประกอบที่จำเป็นสำหรับการตั้งค่าห้องนิรภัย: ปัญหา
- อัปเกรดเปิดเครื่องจากในเครื่องเป็นห้องนิรภัยไม่สำเร็จ: ปัญหา
- ความคิดเห็นต่อเอกสารประกอบ ความสัมพันธ์ระหว่าง "create" กับ "install jx" กับ "boot" กับ "import": ปัญหา
- เอกสารประกอบว่าด้วยคลังสินค้ามีอยู่ทุกที่: ปัญหา
- ปรับปรุงเอกสารว่าเหตุใด ChartMuseum, Monocular และ Docker Registry จึงไม่แทนที่ปัญหาของ Nexus
- เปลี่ยน Docker Registry ไม่ได้เมื่อใช้ Boot + 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 ในสภาพแวดล้อมการแสดงตัวอย่าง
สิ่งที่จะส่งมอบในโครงการ:
- แก้ไขผ่านการประชาสัมพันธ์สำหรับปัญหาเกี่ยวกับเอกสารที่กล่าวถึงข้างต้น โดยพิจารณาการเปลี่ยนโครงสร้างภายในเอกสาร 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: การติดตั้ง Jenkins X และจัดเตรียมบันทึกผู้ใช้ฉบับร่าง
- ทำงานกับหนึ่งในปัญหาด้านเอกสารเพื่อปรับปรุงเอกสาร Jenkins X ที่มีอยู่
สัปดาห์ที่ 3 (28 กันยายน - 4 ตุลาคม)
- จัดการเมทริกซ์ความสามารถใน Jenkins X สำหรับระบบคลาวด์ของ GKE: การติดตั้ง Jenkins X และจัดเตรียมบันทึกผู้ใช้ฉบับร่าง
- ทำงานกับหนึ่งในปัญหาด้านเอกสารเพื่อปรับปรุงเอกสาร Jenkins X ที่มีอยู่
- จัดทำเอกสารการออกแบบสำหรับโครงสร้างพื้นฐานของสภาพแวดล้อมการแสดงตัวอย่างของ Jenkins X ตาม OpenShift
สัปดาห์ที่ 4 (5 ต.ค. - 11 ต.ค.)
- สรุปเอกสารของผู้ใช้สำหรับ Jenkins X บน GKE
- ทำงานกับหนึ่งในปัญหาด้านเอกสารเพื่อปรับปรุงเอกสาร Jenkins X ที่มีอยู่
สัปดาห์ที่ 5 (12 ต.ค. - 18 ต.ค.)
- ทำเมทริกซ์ความสามารถใน Jenkins X สำหรับระบบคลาวด์ Azure (AKS): การติดตั้ง Jenkins X และเตรียมโน้ตผู้ใช้ฉบับร่าง
- ทำงานกับหนึ่งในปัญหาด้านเอกสารเพื่อปรับปรุงเอกสาร Jenkins X ที่มีอยู่
- จัดทำเอกสารการออกแบบสำหรับโครงสร้างพื้นฐานของสภาพแวดล้อมตัวอย่าง Jenkins X ตาม OpenShift ให้เสร็จสิ้นหลังจากได้รับความคิดเห็นจากสมาชิกในชุมชน
สัปดาห์ที่ 6 (19 ต.ค. - 25 ต.ค.)
- ทำเมทริกซ์ความสามารถใน Jenkins X สำหรับระบบคลาวด์ Azure (AKS): การติดตั้ง Jenkins X และเตรียมโน้ตผู้ใช้ฉบับร่าง
- ทำงานกับหนึ่งในปัญหาด้านเอกสารเพื่อปรับปรุงเอกสาร Jenkins X ที่มีอยู่
สัปดาห์ที่ 7 (26 ต.ค. - 1 พ.ย.)
- ทำเมทริกซ์ความสามารถใน Jenkins X สำหรับระบบคลาวด์ Azure (AKS): การติดตั้ง Jenkins X และเตรียมโน้ตผู้ใช้ฉบับร่าง
- ทำงานกับหนึ่งในปัญหาด้านเอกสารเพื่อปรับปรุงเอกสาร Jenkins X ที่มีอยู่
- ทำงานเกี่ยวกับการตั้งค่าโครงสร้างพื้นฐานของสภาพแวดล้อมการแสดงตัวอย่างของ Jenkins X โดยใช้ OpenShift
สัปดาห์ที่ 8 (2 พ.ย. - 8 พ.ย.)
- สรุปเอกสารของผู้ใช้สำหรับ Jenkins X ใน AKS
- ทำงานกับหนึ่งในปัญหาด้านเอกสารเพื่อปรับปรุงเอกสาร Jenkins X ที่มีอยู่
สัปดาห์ที่ 9 (9 พ.ย. - 15 พ.ย.)
- ทำเมทริกซ์ความสามารถใน Jenkins X สำหรับ AWS (EKS): การติดตั้ง Jenkins X และจัดเตรียมบันทึกผู้ใช้ฉบับร่าง
- ทำงานกับหนึ่งในปัญหาด้านเอกสารเพื่อปรับปรุงเอกสาร Jenkins X ที่มีอยู่
- ทำงานเกี่ยวกับการตั้งค่าโครงสร้างพื้นฐานของสภาพแวดล้อมการแสดงตัวอย่างของ Jenkins X โดยใช้ OpenShift
สัปดาห์ที่ 10 (16 พ.ย. - 22 พ.ย.)
- ทำเมทริกซ์ความสามารถใน Jenkins X สำหรับ AWS (EKS): การติดตั้ง Jenkins X และจัดเตรียมบันทึกผู้ใช้ฉบับร่าง
- ทำงานกับหนึ่งในปัญหาด้านเอกสารเพื่อปรับปรุงเอกสาร 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 โครงการนี้จะช่วยชุมชน Jenkins X ปรับปรุงเอกสารประกอบสำหรับผู้ใช้ปลายทางและนักพัฒนาซอฟต์แวร์เพื่อใช้เป็นข้อมูลอ้างอิงเกี่ยวกับสถาปัตยกรรมทางเทคนิค ความเข้ากันได้ การใช้งาน และการผสานรวมของ Jenkins X เมื่อดำเนินโครงการที่เสนอนี้เสร็จสมบูรณ์แล้ว จะมีเอกสารสำหรับผู้ใช้ที่ครบถ้วนสมบูรณ์ มีคำจำกัดความ และได้รับการยืนยันทางเทคนิคของ Jenkins X พร้อมด้วย Jenkins X Capability Matrix เพื่อความเข้ากันได้กับผู้ให้บริการระบบคลาวด์ต่างๆ
คุณวางแผนจะร่วมงานกับ Jenkins X ในด้านใดในอนาคต หลังจากโปรแกรม Google ซีซันของเอกสาร 2020 สิ้นสุดลง ก็มีแผนที่จะมีส่วนร่วมในโครงการ Jenkins X ในฐานะสมาชิกที่กระตือรือร้นในชุมชนนี้ ฉันจะคอยช่วยเหลือคนอื่น (เพื่อนใหม่) และสนับสนุนให้พวกเขามีส่วนร่วมในชุมชน Jenkins X อยู่เสมอ ฉันยินดีที่จะทำงานคิดไอเดียของโครงการอื่นๆ ของ Jenkins X เสมอ
เหตุผลบางประการที่ทำให้ฉันเหมาะกับโครงการนี้ที่สุด:
- ผมมีระเบียบและเป็นระเบียบมาก ฉันคาดหวังอย่างยิ่งว่าจะได้รับข้อมูลอัปเดตเกี่ยวกับความคืบหน้าของโปรเจ็กต์ทั้งกับที่ปรึกษาของโครงการและชุมชนองค์กรผ่านบล็อกโพสต์สัปดาห์ละครั้ง กำหนดการประชุมรายสัปดาห์กับ SIG ผ่านเอกสาร และทางอีเมลเป็นประจำ
- จะต้องขอคำแนะนำและความคิดเห็นจากที่ปรึกษาและสมาชิกในชุมชนบ่อยๆ เพื่อความก้าวหน้าในงานและดูแลให้ทุกคนเข้าใจตรงกัน (รวมถึงพูดถึงอุปสรรคและ/หรืออุปสรรคที่พบ)
- ทำซอร์สโค้ดทั้งหมดที่เขียนขึ้นเป็นประจำเพื่อรับการตรวจสอบโค้ดจากที่ปรึกษา ผู้ร่วมให้ข้อมูล และบันทึกข้อมูลงานที่ทำเสร็จแล้วเพื่อการอ้างอิงให้กับสมาชิกในชุมชน
- ฉันมีทักษะทางเทคนิคที่จำเป็นทั้งหมดสำหรับการทำไอเดียโปรเจ็กต์นี้ และได้พูดคุยเรื่องข้อเสนอโปรเจ็กต์กับ Deane, Kara และ Daniel เป็นที่ปรึกษาแล้ว ผมมีความเข้าใจอย่างถ่องแท้เกี่ยวกับข้อเสนอของโครงการและสิ่งที่ส่งมอบ
- ฉันมีประสบการณ์ในการใช้ทักษะด้านเทคนิค (Google Cloud, Azure Cloud, AWS, Kubernetes, OpenShift, Hugo และอื่นๆ) ที่จำเป็นในการจัดทำเอกสารฉบับเต็ม รวมถึงแก้ปัญหาที่เกี่ยวข้องกับเอกสารประกอบปัจจุบันส่วนใหญ่ได้ ฉันมีทัศนคติเชิงบวกที่สามารถดำเนินการโครงการให้เสร็จตรงเวลาโดยต้องมีการควบคุมดูแลเพียงเล็กน้อย