Jenkins X-Projekt

Auf dieser Seite finden Sie die Details zu einem Projekt für technisches Schreiben, das für Google Season of Docs angenommen wurde.

Projektzusammenfassung

Open-Source-Organisation:
Jenkins X
Technischer Redakteur:
Nitin
Projektname:
Refaktorierung der bestehenden Jenkins X-Dokumentationswebsite und der Jenkins X-Funktionsmatrix
Projektdauer:
Standardlänge (3 Monate)

Projektbeschreibung

Das Hauptziel dieses Projekts besteht darin, die vorhandene Jenkins X-Dokumentation zu überarbeiten und gleichzeitig die Probleme mit den Dokumenten zu beheben sowie die aktualisierte Jenkins X-Funktionsmatrix zusammen mit der Nutzerdokumentation zur Verwendung von Jenkins X bei Enterprise-Cloud-Anbietern vorzubereiten. Außerdem arbeiten wir in diesem Projekt in Zusammenarbeit mit Daniel an der Entwicklung der Jenkins X-Preview-Umgebungsinfrastruktur auf Basis von OpenShift.

Im Rahmen der Restrukturierung der vorhandenen Jenkins X-Dokumentation würde ich unter anderem an folgenden Problemen arbeiten:

  • In EKS-Ressourcen starten: Problem
  • Vault schlägt in EKS mit Booten fehl: Problem
  • Umgebungsvariablen für jx boot dokumentieren: Problem
  • Für die Einrichtung von Vault erforderliche Dokumentation: Problem
  • Boot-Upgrade von lokal auf Vault fehlgeschlagen: Problem
  • Feedback zur Dokumentation Beziehung zwischen „create“ und „install jx“, „boot“ und „import“: Problem
  • Helm-Dokumentation ist unübersichtlich: Problem
  • Verbesserte Dokumentation, warum ChartMuseum, Monocular und Docker Registry nicht durch Nexus Issue ersetzt werden
  • Docker-Registry kann bei Verwendung von Boot + GKE nicht geändert werden: Problem
  • Änderung der Domain von nip.io zu einer benutzerdefinierten Domain schlägt fehl: Problem

Für die Jenkins X-Funktionsmatrix umfasst die Arbeit (wie unten erwähnt) die von den einzelnen Cloud-Anbietern angebotenen Enterprise-Kubernetes-Dienste, d.h.: Google Cloud (GKE), Amazon Web Services (AWS EKS) und Azure Cloud (AKS).

  • Installation von Jenkins X in der Cloud über Terraform-Scripts und jx boot
  • Prüfung der Kompatibilität von Kubernetes-Versionen mit Jenkins X in den Kubernetes-Diensten dieser Cloud-Anbieter.
  • Alle anderen Funktionen (Vault-Speicher für Geheimnisse, Versionen der Quellcodeverwaltung oder andere), die mit Deane und den Mitgliedern der Jenkins X-Community besprochen werden sollen.

Die Einrichtung der Jenkins X-Vorabversionsumgebung auf OpenShift umfasst Folgendes:

  • Designdokument zur Infrastruktur der Jenkins X-Vorabversion auf der OpenShift-Plattform
  • Erstellung von Jenkins X-Vorabversionsumgebungen in OpenShift automatisieren
  • Aktualisierung der Dokumentation für Jenkins X in Vorschauumgebungen

Projektliefergegenstände:

  • Behebung der oben genannten Probleme mit der Dokumentation über einen PR, unter Berücksichtigung der Umstrukturierung der vorhandenen Jenkins X-Dokumentation.
  • Aktualisierung der Jenkins X-Funktionsmatrix zusammen mit der Nutzerdokumentation zur Verwendung von Jenkins X mit verschiedenen Cloud-Anbietern (Kubernetes-Dienste, hauptsächlich AKS, EKS und GKE).
  • Automatische Einrichtung der Jenkins X-Vorabversionsumgebung auf Basis von OpenShift in Zusammenarbeit mit Daniel

Vorläufiger Zeitplan (einschließlich Aufgaben):

Community Bonding (17. August bis 13. September)

  • Entwicklungsumgebung für die technische Dokumentation einrichten und Zugriff auf Cloud-Infrastrukturen für die Arbeit an den Projektaufgaben erhalten.
  • Besprechen des vorläufigen Zeitplans, der Projektliefergegenstände sowie der Aufgaben (zusammen mit ihrer Priorität) mit den Mentoren des Projekts.
  • Informieren Sie sich über den Arbeitsablauf und den PR-Überprüfungsprozess Ihrer Organisation und engagieren Sie sich in der Gemeinde.
  • Sehen Sie sich den aktuellen Dokumentationsstatus von Jenkins X an.

Woche 1 (14. bis 20. September)

  • Informationen zur Einrichtung von Jenkins X in der Cloud, zum aktuellen Status und zur Dokumentation.
  • Diskussion mit Deane über die aktuellen Jenkins X-Funktionen (zu verifizieren bei verschiedenen Cloud-Anbietern).
  • Gespräch mit Daniel über den aktuellen Stand der Jenkins X-Preview-Umgebungsinfrastruktur auf der Grundlage von OpenShift.
  • In Zusammenarbeit mit Daniel die Architektur für die Jenkins X-Vorabversionsumgebung in OpenShift entwerfen.

Woche 2 (21. bis 27. September)

  • Arbeiten Sie an der Jenkins X-Funktionsmatrix für die GKE-Cloud: Installation von Jenkins X und Erstellen von Notizen für Nutzer.
  • Arbeiten Sie an einem der Dokumentationsthemen, um die vorhandene Jenkins X-Dokumentation zu verbessern.

Woche 3 (28. September bis 4. Oktober)

  • Arbeiten Sie an der Jenkins X-Funktionsmatrix für die GKE-Cloud: Installation von Jenkins X und Erstellen von Nutzernotizen.
  • Arbeiten Sie an einem der Probleme mit der Dokumentation, um die vorhandene Jenkins X-Dokumentation zu verbessern.
  • Arbeiten Sie am Designdokument für die Jenkins X-Vorabversionsumgebung auf OpenShift-Basis.

Woche 4 (5. Okt. bis 11. Okt.)

  • Nutzerdokumentation für Jenkins X in GKE fertigstellen
  • Arbeiten Sie an einem der Dokumentationsthemen, um die vorhandene Jenkins X-Dokumentation zu verbessern.

Woche 5 (12. Okt. bis 18. Okt.)

  • Arbeiten Sie an der Jenkins X-Funktionsmatrix für die Azure-Cloud (AKS): Installation von Jenkins X und Erstellen von Notizen für Nutzer.
  • Arbeiten Sie an einem der Probleme mit der Dokumentation, um die vorhandene Jenkins X-Dokumentation zu verbessern.
  • Schließen Sie das Designdokument für die OpenShift-basierte Infrastruktur der Jenkins X-Vorabversion ab, nachdem Sie Feedback von den Communitymitgliedern erhalten haben.

Woche 6 (19. Okt. bis 25. Okt.)

  • Arbeiten Sie an der Jenkins X-Funktionsmatrix für die Azure-Cloud (AKS): Installation von Jenkins X und Erstellen von Notizen für Nutzer.
  • Arbeiten Sie an einem der Probleme mit der Dokumentation, um die vorhandene Jenkins X-Dokumentation zu verbessern.

Woche 7 (26. Okt. bis 1. Nov.)

  • Arbeiten Sie an der Jenkins X-Funktionsmatrix für die Azure-Cloud (AKS): Installation von Jenkins X und Erstellen von Notizen für Nutzer.
  • Arbeiten Sie an einem der Dokumentationsthemen, um die vorhandene Jenkins X-Dokumentation zu verbessern.
  • Arbeiten an der Einrichtung der Jenkins X-Vorabversionsumgebung auf Basis von OpenShift

Woche 8 (2. Nov. bis 8. Nov.)

  • Nutzerdokumente für Jenkins X in AKS fertigstellen.
  • Arbeiten Sie an einem der Probleme mit der Dokumentation, um die vorhandene Jenkins X-Dokumentation zu verbessern.

Woche 9 (9. Nov. bis 15. Nov.)

  • Arbeiten Sie an der Jenkins X-Funktionsmatrix für AWS (EKS): Installation von Jenkins X und Erstellen von Notizen für Nutzer.
  • Arbeiten Sie an einem der Dokumentationsthemen, um die vorhandene Jenkins X-Dokumentation zu verbessern.
  • Arbeiten an der Einrichtung der Jenkins X-Vorabversionsumgebung auf Basis von OpenShift

Woche 10 (16. Nov. bis 22. Nov.)

  • Arbeiten Sie an der Jenkins X-Funktionsmatrix für AWS (EKS): Installation von Jenkins X und Vorbereiten von Entwürfen für Nutzernotizen.
  • Arbeiten Sie an einem der Dokumentationsthemen, um die vorhandene Jenkins X-Dokumentation zu verbessern.

Woche 11 (23. Nov. bis 29. Nov.)

  • Nutzerdokumente für Jenkins X in EKS fertigstellen
  • Arbeiten Sie an einem der Probleme mit der Dokumentation, um die vorhandene Jenkins X-Dokumentation zu verbessern.
  • Die Dokumentation der Umgebungsinfrastruktur für die Jenkins X-Vorschau auf der Dokumentationswebsite zu Jenkins X fertigstellen.

Woche 12 (30. Nov. bis 5. Dez.)

  • Schließen Sie die Projektergebnisse ab und überarbeiten Sie gegebenenfalls den Code basierend auf dem Feedback.
  • Testen Sie die Funktion der Jenkins X-Dokumentationswebsite, einschließlich Links, Bildern, Hyperlinks usw.
  • Prüfen Sie die benutzerdefinierte Steuerung und Navigation der Jenkins X-Dokumentationswebsite.
  • Sehen Sie sich die fertige Präsentation der Jenkins X-Kompetenzmatrix an.

Vor dem 10. Dezember 2020 reichen sowohl der Technische Redakteur als auch die Mentoren eine Bewertung des Projekts ein.

Welche Vorteile hat das vorgeschlagene Projekt für Jenkins X und seine Community? Dieses Projekt wird der Jenkins X-Community helfen, die Dokumentation für Endnutzer und Entwickler zu verbessern, die sich über die technische Architektur, Kompatibilität, Verwendung und Integration von Jenkins X informieren möchten. Nach Abschluss dieses vorgeschlagenen Projekts würde es eine umfassende, klar definierte und technisch geprüfte Nutzerdokumentation für Jenkins X sowie die Jenkins X-Funktionsmatrix für die Kompatibilität mit verschiedenen Cloud-Anbietern geben.

Welche zukünftigen Vorteile möchten Sie mit Jenkins X nutzen? Nach dem Ende des Google Season of Docs 2020-Programms möchte ich als aktives Mitglied der Community langfristig zum Jenkins X-Projekt beitragen. Ich bin immer da, um anderen (Neulingen) zu helfen und sie zu ermutigen, sich in der Jenkins X-Community zu engagieren. Ich würde immer gerne an anderen Jenkins X-Projektideen arbeiten.

Hier sind einige Gründe, warum ich für dieses Projekt am besten geeignet bin:

  • Ich bin sehr methodisch und organisiert. Ich erwarte, dass sowohl die Projektmentoren als auch die Community der Organisation einmal pro Woche über Blogbeiträge, geplante wöchentliche SIG-Docs-Treffen und regelmäßig per E-Mail über den Fortschritt des Projekts informiert werden.
  • Sie werden häufig Rat und Feedback von den Mentoren und Communitymitgliedern einholen, um mit den Aufgaben voranzukommen und dafür zu sorgen, dass alle auf demselben Stand sind (einschließlich der Erwähnung von Herausforderungen und/oder Blockaden).
  • Der gesamte geschriebene Quellcode wird regelmäßig zur Verfügung gestellt, um den Code von der beratenden Person und den Mitwirkenden überprüfen zu lassen und die geleistete Arbeit zu dokumentieren, damit sie den Community-Mitgliedern als Referenz zur Verfügung stehen.
  • Ich habe alle erforderlichen technischen Fähigkeiten, um an dieser Projektidee zu arbeiten, und habe den Projektvorschlag mit den Mentoren Deane, Kara und Daniel besprochen. Ich habe ein umfassendes Verständnis des Projektvorschlags und seiner Arbeitsergebnisse.
  • Ich habe Erfahrung mit den technischen Fähigkeiten (Google Cloud, Azure Cloud, AWS, Kubernetes, OpenShift, Hugo und andere), die erforderlich sind, um eine umfassende Dokumentation zu erstellen und die meisten der aktuellen dokumentationsbezogenen Probleme zu lösen. Ich habe eine positive Einstellung und kann die Projektarbeit mit wenig Aufsicht rechtzeitig erledigen.