Diese Seite wurde von der Cloud Translation API übersetzt.

Jenkins X-Projekt

Diese Seite enthält die Details eines Projekts für technisches Schreiben, das für die Google-Staffel von Google Docs akzeptiert wurde.

Projektzusammenfassung

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

Projektbeschreibung

Das Hauptziel dieses Projekts ist es, die vorhandene Jenkins X-Dokumentation zu refaktorieren, die dokumentenbezogenen Probleme zu beheben und die aktualisierte Jenkins X-Funktionsmatrix sowie die Nutzerdokumentation zur Nutzung von Jenkins X auf den Cloud-Anbietern des Unternehmens vorzubereiten. Darüber hinaus umfasst dieses Projekt in Zusammenarbeit mit Daniel die Entwicklung der Infrastruktur für die Jenkins X-Vorschauumgebung, die auf OpenShift basiert.

Im Rahmen der Refaktorierung der vorhandenen Jenkins X-Dokumentation würde ich unter anderem folgende Probleme untersuchen:

In EKS-Ressourcen starten: Problem
Vault schlägt in EKS beim Booten 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
Dokumentationsfeedback – Beziehung zwischen „create“, „install jx“, „boot“ vs. „import“: Problem
Die Helm-Dokumentation ist überall: Problem
Verbesserung der Dokumentation, 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 Kubernetes-Dienste für Unternehmen, die von den einzelnen Cloud-Anbietern 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
Prüfung der Kompatibilität von Kubernetes-Versionen mit Jenkins X auf den Kubernetes-Diensten dieser Cloud-Anbieter.
Alle anderen Funktionen (Vault-Speicher für Secrets, Versionsverwaltungsversionen usw.), die mit Deane und den Mitgliedern der Jenkins X-Community besprochen werden.

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

Designdokument zur Vorschau der 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:

Behebung der oben genannten Probleme mit der Dokumentation über PR im Hinblick auf eine Refaktorierung der vorhandenen Jenkins X-Dokumentation.
Die Jenkins X-Funktionsmatrix wurde zusammen mit der Nutzerdokumentation zur Verwendung von Jenkins X mit verschiedenen Cloud-Anbietern aktualisiert (Kubernetes-Dienste hauptsächlich AKS, EKS und GKE).
Automatisierte Einrichtung der Jenkins X-Vorschauumgebung auf Grundlage von OpenShift in Zusammenarbeit mit Daniel.

Vorläufiger Zeitplan (zusammen mit Aufgaben):

Community Bonding (17. August–13. Sept.)

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

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

Anleitung für die Einrichtung von Jenkins X in der Cloud, den aktuellen Status und die Dokumentation
Diskussion mit Deane über die aktuellen Jenkins X-Funktionen (zur Verifizierung bei verschiedenen Cloud-Anbietern).
Diskussion mit Daniel über den aktuellen Status der auf OpenShift basierenden Vorschauinfrastruktur für die Jenkins X-Vorschau.
Entwerfen Sie (in Zusammenarbeit mit Daniel) die Architektur für die Jenkins X-Vorschauinfrastruktur in OpenShift.

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

An der Jenkins X-Funktionsmatrix für die GKE Cloud arbeiten: Jenkins X installieren und Nutzernotizen entwerfen
Arbeiten Sie an einem der Probleme mit der Dokumentation, um die vorhandene Jenkins X-Dokumentation zu verbessern.

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

An der Jenkins X-Funktionsmatrix für die GKE Cloud arbeiten: Jenkins X installieren und Nutzernotizen entwerfen
Arbeiten Sie an einem der Probleme mit der Dokumentation, um die vorhandene Jenkins X-Dokumentation zu verbessern.
Auf der Grundlage von OpenShift am Designdokument für die Jenkins X-Vorschauinfrastruktur 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 Entwurf von Nutzernotizen.
Arbeiten Sie an einem der Probleme mit der Dokumentation, um die vorhandene Jenkins X-Dokumentation zu verbessern.
Anhand des Feedbacks von Community-Mitgliedern das Designdokument für die auf OpenShift basierende Vorschau-Infrastruktur von Jenkins X fertigstellen.

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

An der Jenkins X-Funktionsmatrix für Azure Cloud (AKS) arbeiten: 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 7 (26. Okt.–1. Nov.)

An der Jenkins X-Funktionsmatrix für Azure Cloud (AKS) arbeiten: 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.
Einrichtung einer Vorschau-Infrastrukturinfrastruktur für Jenkins X basierend auf 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 Entwurf von Nutzernotizen.
Arbeiten Sie an einem der Probleme mit der Dokumentation, um die vorhandene Jenkins X-Dokumentation zu verbessern.
Einrichtung einer Vorschau-Infrastrukturinfrastruktur für Jenkins X basierend auf OpenShift.

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

An der Jenkins X-Funktionsmatrix für AWS (EKS) arbeiten: 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 11 (23. Nov.–29. Nov.)

Nutzerdokumentation 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-Infrastruktur für die Vorschauumgebung 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.
Überprüfen Sie die benutzerdefinierte Steuerung und Navigation der Jenkins X-Dokumentationswebsite.
Sehen Sie sich die fertige Präsentation der Jenkins X-Fähigkeitsmatrix an.

Vor dem 10. Dezember 2020 Sowohl technische Redakteure als auch Mentoren reichen eine Bewertung des Projekts ein.

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

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

Einige der Gründe dafür, dass ich am besten an diesem Projekt arbeiten kann:

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 an die Projektbeteiligten und die Community der Organisation über den Projektfortschritt informieren werde.
Sie bitten häufig um Rat sowie Feedback von den Mentoren und Community-Mitgliedern, um die Aufgaben voranzubringen und sicherzustellen, dass alle auf demselben Stand sind (einschließlich der Erwähnung etwaiger Herausforderungen und/oder Stolpersteine).
Die regelmäßig geschriebenen Quellcodes werden festgeschrieben, damit der Code vom Mentor und den Mitwirkenden überprüft und die geleistete Arbeit für die Community-Mitglieder dokumentiert werden kann.
Ich verfüge über 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 den Projektvorschlag und seine Liefergegenstände genau verstanden.
Ich habe Erfahrung 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 dokumentationsbezogenen Probleme zu lösen. Ich habe die positive Einstellung, dass die Projektarbeit pünktlich und mit wenig Aufsicht erledigt werden kann.