Jenkins X-Projekt

Diese Seite enthält die Details zu einem Projekt für technisches Schreiben, das für die Google-Produktsaison von Google Docs akzeptiert wurde.

Projektzusammenfassung

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

Projektbeschreibung

Das Hauptziel dieses Projekts besteht darin, die vorhandene Jenkins X-Dokumentation zu refaktorieren und gleichzeitig die mit der Dokumentation verbundenen Probleme zu beheben. Außerdem wird die aktualisierte Jenkins X-Funktionsmatrix zusammen mit der Nutzerdokumentation zur Nutzung von Jenkins X bei den Unternehmens-Cloud-Anbietern vorbereitet. Darüber hinaus umfasst dieses Projekt in Zusammenarbeit mit Daniel auch die Arbeit an der Entwicklung der Infrastruktur für die Jenkins X-Vorschau, die auf OpenShift basiert.

Im Rahmen der Refaktorierung 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 Bootvorgang fehl: Problem
  • Dokumentenvars für jx-Boot: Problem
  • Für die Vault-Einrichtung erforderliche Dokumentation: Problem
  • Boot-Upgrade von lokal auf Vault schlägt fehl: Problem
  • Feedback zur Dokumentation Beziehung zwischen „create“ vs. „install jx“, „boot“ vs. „import“: Problem
  • Die Helm-Dokumentation ist überall: Problem
  • Dokumentation verbessern, warum ChartMuseum, Monocular und Docker Registry nicht durch ein Nexus-Problem ersetzt werden
  • Docker-Registry kann bei Verwendung von Boot + GKE nicht geändert werden: Problem
  • Fehler beim Ändern der Domain von nip.io in eine benutzerdefinierte Domain: Problem

Bei der Jenkins X-Funktionsmatrix umfasst die Arbeit (wie unten erwähnt) die Arbeit in Kubernetes-Diensten für Unternehmen, die von jedem der Cloud-Anbieter angeboten werden, d.h. Google Cloud (GKE), Amazon Web Services (AWS EKS) und Azure Cloud (AKS).

  • Installation von Jenkins X in der Cloud über Terraform-Skripts und jx boot
  • Es wird die Kompatibilität von Kubernetes-Versionen mit Jenkins X in diesen Kubernetes-Diensten von Cloud-Anbietern geprüft.
  • Alle anderen Funktionen (Vault-Speicher für Secrets, Versionen der Versionsverwaltung usw.), die mit Deane und den Mitgliedern der Jenkins X-Community besprochen werden.

Die Einrichtung der Infrastruktur für die Jenkins X-Vorschauumgebung, die auf OpenShift basiert, umfasst Folgendes:

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

Liefergegenstände des Projekts:

  • Fehlerkorrekturen über PR an den oben genannten Dokumenten-Problemen unter Berücksichtigung der Refaktorierung der vorhandenen Jenkins X-Dokumentation.
  • Aktualisierung der Jenkins X-Funktionsmatrix und der Nutzerdokumentation zur Verwendung von Jenkins X mit verschiedenen Cloud-Anbietern (Kubernetes-Dienste hauptsächlich AKS, EKS und GKE).
  • Automatisierte Einrichtung der Jenkins X-Vorschauumgebung, Infrastruktur basierend auf OpenShift, in Zusammenarbeit mit Daniel.

Vorgeschlagener vorläufiger Zeitplan (zusammen mit Aufgaben):

Community Bonding (17. August bis 13. September)

  • Richten Sie eine Entwicklungsumgebung für die technische Dokumentation ein und erhalten Sie Zugriff auf Cloud-Infrastrukturen, um an den Projektaufgaben zu arbeiten.
  • Diskussion mit den Mentoren des Projekts über den vorgeschlagenen vorläufigen Zeitplan, die Projektliefergegenstände sowie die Aufgaben (zusammen mit ihrer Priorität).
  • Den Arbeitsprozess und die PR-Überprüfung der Organisation verstehen und gut vorbereitet sein und sich in die Community einbringen.
  • Prüfen Sie den aktuellen Dokumentationsstatus von Jenkins X.

Woche 1 (14. Sept.–20. Sept.)

  • Hier erfahren Sie mehr über die Anleitung zum Einrichten von Jenkins X in der Cloud, den aktuellen Status und die Dokumentation.
  • Diskussion mit Deane über die aktuellen Jenkins X-Funktionen (wird bei verschiedenen Cloud-Anbietern geprüft).
  • Diskussion mit Daniel über den aktuellen Status der Vorschau-Infrastruktur von Jenkins X, die auf OpenShift basiert.
  • Arbeiten Sie (in Zusammenarbeit mit Daniel) an der Architektur der Vorschau-Infrastruktur von Jenkins X in OpenShift.

Woche 2 (21. Sept.–27. Sept.)

  • Arbeiten Sie an der Jenkins X-Funktionsmatrix für die GKE Cloud: Installation von Jenkins X und Entwurf von Nutzernotizen.
  • Arbeiten Sie an einem der Probleme mit der Dokumentation, um die vorhandene Jenkins X-Dokumentation zu verbessern.

Woche 3 (28. Sept.–4. Okt.)

  • Arbeiten Sie an der Jenkins X-Funktionsmatrix für die GKE Cloud: Installation von Jenkins X und Entwurf von Nutzernotizen.
  • Arbeiten Sie an einem der Probleme mit der Dokumentation, um die vorhandene Jenkins X-Dokumentation zu verbessern.
  • Auf Grundlage von OpenShift am Designdokument für die Vorschau-Infrastruktur von Jenkins X arbeiten.

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

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

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

  • An der Jenkins X-Funktionsmatrix für Azure Cloud (AKS) arbeiten: Installation von Jenkins X und Vorbereiten von Nutzernotizen.
  • Arbeiten Sie an einem der Probleme mit der Dokumentation, um die vorhandene Jenkins X-Dokumentation zu verbessern.
  • Das Designdokument für die Vorschau-Infrastruktur von Jenkins X basierend auf OpenShift fertigstellen, nachdem Feedback von den Community-Mitgliedern eingeholt wurde.

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

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

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

  • An der Jenkins X-Funktionsmatrix für Azure Cloud (AKS) arbeiten: Installation von Jenkins X und Vorbereiten von Nutzernotizen.
  • Arbeiten Sie an einem der Probleme mit der Dokumentation, um die vorhandene Jenkins X-Dokumentation zu verbessern.
  • Einrichtung einer Vorschauinfrastruktur für die Jenkins X-Vorschau auf Grundlage von OpenShift.

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

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

Woche 9 (9. Nov.–15. Nov.)

  • An der Jenkins X-Funktionsmatrix für AWS (EKS) arbeiten: Installation von Jenkins X und Vorbereiten von Nutzernotizen.
  • Arbeiten Sie an einem der Probleme mit der Dokumentation, um die vorhandene Jenkins X-Dokumentation zu verbessern.
  • Einrichtung einer Vorschauinfrastruktur für die Jenkins X-Vorschau auf Grundlage von OpenShift.

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

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

Woche 11 (23. Nov.–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 Jenkins X-Vorschauinfrastruktur auf der Jenkins X-Dokumentationswebsite fertigstellen.

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

  • Die Liefergegenstände des Projekts fertigstellen und den Code, falls vorhanden, auf der Grundlage des Feedbacks refaktorieren.
  • Testen Sie die Funktionsweise der Jenkins X-Dokumentationswebsite, einschließlich Links, Bildern, Hyperlinks und mehr.
  • Prüfen Sie die benutzerdefinierte Steuerung und Navigation der Dokumentationswebsite für Jenkins X.
  • Sehen Sie sich die fertige Präsentation der Jenkins X-Kapazitätsmatrix an.

Vor dem 10. Dezember 2020 haben sowohl technische Redakteure als auch Mentoren eine Bewertung des Projekts eingereicht.

Welche Vorteile bietet das vorgeschlagene Projekt für Jenkins X und seine Community? Dieses Projekt hilft der Jenkins X-Community dabei, die Dokumentation für Endnutzer und Entwickler als Referenz zur technischen Architektur, Kompatibilität, Nutzung und Integration von Jenkins X zu verbessern. Nach Abschluss dieses vorgeschlagenen Projekts gäbe es eine vollwertige, klar definierte und technisch verifizierte Nutzerdokumentation von Jenkins X sowie die Jenkins X-Funktionsmatrix für die Kompatibilität mit verschiedenen Cloud-Anbietern.

An welchen Vorteilen möchten Sie zukünftig mit Jenkins X arbeiten? Nach dem Ende des Programms „Season of Docs 2020“ von Google möchte ich langfristig als aktives Mitglied der Community zum Jenkins X-Projekt beitragen. Ich werde immer da sein, um anderen (Neulingen) zu helfen und sie zu ermutigen, sich in der Jenkins X-Community zu engagieren. Ich wäre immer bereit, an anderen Projektideen für Jenkins X zu arbeiten.

Einige der Gründe, die mich am besten für die Arbeit an diesem Projekt eignen:

  • Ich bin sehr methodisch und organisiert. Ich erwarte sehr, dass ich einmal pro Woche Blogposts, wöchentliche SIG-Docs-Meetings und regelmäßige E-Mails über den Fortschritt des Projekts an die Projektberater und die Community der Organisation halten werde.
  • Sie bitten häufig um Rat und Feedback von den Mentoren und Community-Mitgliedern, um die Aufgaben zu erledigen und sicherzustellen, dass alle auf dem gleichen Stand sind (einschließlich der Erwähnung etwaiger Herausforderungen und/oder der Hindernisse, mit denen sie konfrontiert sind).
  • Der gesamte Quellcode, der regelmäßig geschrieben wird, um den Code vom Mentor und den Mitwirkenden überprüfen zu lassen und die geleistete Arbeit als Referenz für die Community-Mitglieder zu dokumentieren
  • Ich verfüge über alle erforderlichen technischen Fähigkeiten, die für die Arbeit an dieser Projektidee erforderlich sind, und habe den Projektvorschlag mit den Mentoren Deane, Kara und Daniel besprochen. Ich habe den Projektvorschlag und seine Liefergegenstände genau verstanden.
  • Ich habe Erfahrung in der Arbeit mit den technischen Fähigkeiten (Google Cloud, Azure Cloud, AWS, Kubernetes, OpenShift, Hugo usw.), die erforderlich sind, um eine umfassende Dokumentation bereitzustellen und die meisten aktuellen Dokumentationsprobleme zu lösen. Ich habe die positive Einstellung, dass ich die Projektarbeit pünktlich und ohne Aufsicht erledigen kann.