Wie Sie partizipieren können

Herzlich willkommen! Wir freuen uns, dass Sie in der Arbeitsgruppe Cartografos mitarbeiten möchten.

Einführung

Die Cartografos-Arbeitsgruppe hat sich zum Ziel gesetzt, Tools zur Verfügung zu stellen, die Adoptern und Endnutzern helfen, sich in der CNCF-Landcape und dem breiteren Cloud-native-Ökosystem zurechtzufinden.

Wir möchten Benutzer mit effektiven und praktischen Anleitungen unterstützen und aufklären, um ihnen zu helfen, das Cloud-native-Ökosystem zu verstehen. Wir tun dies durch die Zusammenarbeit mit Gruppen innerhalb und außerhalb der CNCF.

Wir arbeiten mit CNCF-Projekten auf Sandbox-, Incubating- und Graduated-Ebene zusammen, um eine effektive und akkurate Repräsentation innerhalb der Assets sowie der CNCF-Technical-Advisory-Groups sicherzustellen. Außerdem bieten wir auch ein anbieterneutrales Forum für Validierung, Diskussion und Feedback. In der Anfangsphase sind Sie in der besten Position, um uns Feedback zu Bereichen zu geben, in denen die Arbeitsgruppe Hilfe benötigt. Dazu gehören:

  • Lücken in unserer Dokumentation zu schließen
  • Definition neuer Artefakte
  • Einbindung in TAGs und SIGs innerhalb der CNCF und ihrer Projekte

Beitragen

Jeder ist eingeladen, Änderungen, Ergänzungen und Verbesserungen an den Artefakten der Arbeitsgruppe vorzuschlagen. Wir verwenden einen von der CNCF gesteuerten Prozess zur Entwicklung und Verbesserung von Artefakten. Beiträge sind von allen Teilnehmern in Übereinstimmung mit dem Zweck und der Charta der Arbeitsgruppe willkommen. Jeder, der einen Beitrag leisten möchte, kann ein GitHub Issue einreichen oder einen Pull Request erstellen. Neben Beiträgen zu Artefakten und Dokumentation ist Ihre Hilfe auf folgende Weise sehr willkommen:

  • Erstellen oder Beitragen von Artefakten zur Arbeitsgruppe, die die Aufgabe der Gruppe unterstützen, bei der Navigation in der Cloud-native-Landscape zu helfen
  • Beitragen von Aktualisierungen zu bestehenden Artefakten
  • Ideen für neue Artefakte und Verbesserungen, die Sie gerne sehen würden
  • Dokumentation
  • Problem-Sichtung
  • Kommunikation / Soziale Medien / Blogbeiträge
  • Release Management

Nicht alles geschieht über eine Pull-Request auf GitHub. Bitte kommen Sie zu unseren Treffen oder kontaktieren Sie uns und besprechen Sie, wie wir zusammenarbeiten können.

Komm zu den Treffen

Jeder ist herzlich eingeladen, an unseren Treffen teilzunehmen. Wir halten jeden zweiten Dienstag um 18.00 Uhr US/Eastern regelmäßige Community-Treffen ab.

Sie müssen der Cartografos-Arbeitsgruppe unter https://community.cncf.io beitreten und sich dann einfach für die Sitzung unter https://community.cncf.io/cncf-cartografos-working-group/ anmelden.

Wenn Sie das erste Mal kommen, reicht es aus, wenn Sie sich vorstellen. Wir hoffen, dass Sie sich mit der Zeit wohl dabei fühlen, Ihre Meinung zu äußern, Feedback zu den Ideen anderer zu geben und sogar Ihre eigenen Ideen und Erfahrungen mitzuteilen.

Bitte um Hilfe

Am besten erreichen Sie uns:

  • Über die ursprüngliche GitHub-Frage
  • In GitHub-Diskussionen innerhalb des Repositorys
  • Unser CNCF Slack-Kanal - # cartografos-wg
  • Und natürlich persönlich bei einem Treffen

Ablauf zum Beitragen

Ein Überblick über den Arbeitsablauf eines Mitwirkenden:

  • Fork it ( https://github.com/cncf/cartografos/fork)
  • Erstellen Sie einen Branch, von dem aus Sie Ihre Arbeit beginnen wollen (normalerweise main). Beispiel git checkout -b my-new-feature)
  • Nehmen Sie Ihre Änderungen vor und ordnen Sie diese in lesbaren Commits an.
  • Übertragen Sie Ihre Änderungen (Bsp. `git commit -am ‘Füge ein Feature hinzu’``)
  • Schieben Sie sie in den Branch (Bsp. git push origin my-new-feature)
  • Stellen Sie sicher, dass der Branch mit dem Basis-Branch des Upstream auf dem neuesten Stand ist (z.B. main)
  • Erstellen Sie einen neuen Pull Request (PR)

Einreichen eines PR

Sobald Sie Ihre Änderungen in Ihrem Branch aktualisiert haben, öffnen Sie einen PR für das Upstream-Repo von cartografos. Bevor Sie den PR öffnen, vergewissern Sie sich, dass Sie auf dem neuesten Stand des Upstreams rebased haben. Wenn vor der Zusammenführung Ihres PR andere Commits in den Upstream gepusht werden, müssen Sie ebenfalls einen Re-Base durchführen, bevor der PR zusammengeführt wird. Allgemeine Hinweise zum Einreichen eines Pull-Requests finden Sie unter [Creating a pull request] ( https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) auf GitHub.

Mitwirkungsstufen

Die Mitwirkugnsstufen beschreiben die verschiedenen Rollen der Mitwirkenden innerhalb der Arbeitsgruppe sowie die damit verbundenen Verantwortlichkeiten und Privilegien. Community-Mitglieder beginnen in der Regel auf den ersten Stufen der “Leiter” und steigen mit wachsendem Engagement in der Arbeitsgruppe auf. Die Mitglieder unserer Arbeitsgruppe helfen Ihnen gerne dabei, auf der Leiter der Mitwirkenden aufzusteigen.

Participant

Ein Teilnehmer engagiert sich für die Gruppe und ihre Gemeinschaft, indem er seine Zeit, seine Gedanken usw. einbringt. Community-Teilnehmer sind in der Regel Benutzer, die nicht mehr anonym sind, sondern sich aktiv an Gruppendiskussionen beteiligen.

Verantwortlichkeiten:

  • Muss den Verhaltenskodex der CNCF befolgen

Wie Benutzer sich in der Gemeinschaft engagieren können:

  • Teilnahme an Gemeinschaftsdiskussionen
  • Hilfe für andere Benutzer bereitstellen
  • Einreichung und Kommentierung von Issues
  • Feedback zu neuen Artefakt-Releases geben
  • Teilnahme an Community-Veranstaltungen

Beitragender

Ein Beitragender einer Arbeitsgruppe trägt direkt zur Gruppe bei und schafft einen Mehrwert für diese. Personen auf der Stufe “Beitragender” können neue Mitarbeiter sein oder nur gelegentlich Beiträge leisten.

Zu den Verantwortlichkeiten gehören:

  • Einhalten des Verhaltenskodex der CNCF
  • Einhalten des Leitfadens für Beiträge der Arbeitsgruppe
  • Anforderungen (eine oder mehrere der unten genannten):
  • Berichten und manchmal Lösen von Problemen
  • Gelegentliches Einreichen von PRs
  • Beitragen zu Artefakten
  • An Sitzungen teilnehmen
  • Beantwortung von Fragen anderer Community-Mitglieder
  • Feedback zu Problemen und PRs einreichen
  • Überprüft Aktualisierungen von Artefakten und gibt Feedback
  • Führt Veranstaltungen durch oder hilft bei der Durchführung
  • Werbung für die Arbeitsgruppe in der Öffentlichkeit
  • Unterstützung bei der Verwaltung der Infrastruktur der Arbeitsgruppe

Prüfer

Ein Prüfer hat die Verantwortung für bestimmte Assets, Dokumentationen oder andere Arbeitsgruppenbereiche. Sie sind gemeinsam mit anderen Prüfern für die Überprüfung aller Änderungen in diesen Bereichen verantwortlich und geben an, ob diese Änderungen für einen Merge bereit sind. Sie haben eine Erfolgsbilanz von Beiträgen und Überprüfungen in der Arbeitsgruppe.

Prüfer sind für einen “spezifischen Bereich” verantwortlich. Das kann ein bestimmtes Artefakt, ein Kapitel der Dokumentation oder ein anderes klar definiertes Gruppenartefakt sein, das kleiner ist als ein ganzes Repository. Meistens handelt es sich um ein oder mehrere Verzeichnisse in einem oder mehreren Git-Repositories. Der unten stehende “spezifische Bereich” bezieht sich auf diesen Verantwortungsbereich.

Prüfer haben alle Rechte und Pflichten eines Mitwirkenden und darüber hinaus:

  • Zu den Verantwortlichkeiten gehören:
  • Einhalten des Reviewing-Leitfadens
  • Überprüfung der meisten Pull Requests anhand ihrer spezifischen Verantwortungsbereiche
  • Andere Beitragende dabei unterstützen, Prüfer zu werden

Voraussetzungen:

  • Erfahrung als Beitragender
  • Ist ein Arbeitsgruppenmitglied
  • Hat tiefgreifende Kenntnisse in seinem spezifischen Bereich bewiesen. Idealerweise hat er das Artefakt in seinem spezifischen Bereich verfasst oder wesentlich dazu beigetragen.
  • Verpflichtet sich, für diesen speziellen Bereich verantwortlich zu sein
  • Unterstützt neue und gelegentliche Mitwirkende und hilft dabei, nützliche PRs in Form zu bringen.

Zusätzliche Privilegien:

  • Freigabe von Pull Requests in bestimmten Verzeichnissen

  • Kann andere Mitwirkende empfehlen und prüfen, Prüfer zu werden Der Prozess, ein Prüfer zu werden, ist folgender:

  • Der Mitwirkende wird nominiert, indem er einen PR gegen das entsprechende Repository eröffnet, wodurch sein GitHub-Benutzername der OWNERS-Datei für ein oder mehrere Verzeichnisse hinzugefügt wird.

  • Mindestens zwei Mitglieder des Teams, dem das Repository oder das Hauptverzeichnis gehört, die bereits Approver sind, genehmigen den PR.

Maintainer

Maintainer sind sehr erfahrene Mitwirkende, die für die gesamte Arbeitsgruppe verantwortlich sind. Als solche haben sie die Möglichkeit, PRs für jeden Bereich des Repositorys zu genehmigen, und es wird von ihnen erwartet, dass sie sich an Entscheidungen über die Strategie und die Prioritäten der Arbeitsgruppe beteiligen.

Ein Maintainer muss die Aufgaben und Anforderungen eines Prüfers erfüllen, plus: Zu den Verantwortlichkeiten gehören:

  • Mentoring neuer Prüfer
  • Schreiben von Refactoring-PRs
  • Teilnahme an den Aktivitäten der CNCF Maintainer
  • Strategie und Politik für die Arbeitsgruppe festlegen
  • Teilnahme an und Leitung von Community-Treffen

Voraussetzungen

  • Demonstration eines umfangreichen Wissens über die Arbeitsgruppe in mehreren Bereichen
  • Ist in der Lage, unabhängig von seinem Arbeitgeber, seinen Freunden oder seinem Team ein Urteil zum Wohle der Arbeitsgruppe zu fällen
  • Mentor für andere Mitwirkende
  • Kann sich verpflichten, Zeit für die Arbeit in der Arbeitsgruppe aufzuwenden

Zusätzliche Privilegien:

  • Genehmigung von PRs für jeden Bereich der Arbeitsgruppe
  • Repräsentation der Arbeitsgruppe in der Öffentlichkeit als Maintainer
  • Kommunikation mit der CNCF im Namen der Arbeitsgruppe
  • Stimmrecht bei Maintainer-Entscheidungstreffen

Verfahren, um Maintainer zu werden:

  • Jeder aktuelle Maintainer kann einen aktuellen Prüfer nominieren, neuer Maintainer zu werden, indem er einen PR gegen das Stammverzeichnis des cncf/cartografos-Repository eröffnet und den Nominierten als Approver in der OWNERS-Datei hinzufügt.
  • Der Kandidat fügt dem PR einen Kommentar hinzu, in dem er bestätigt, dass er mit allen Anforderungen an einen Maintainer einverstanden ist.
  • Eine Mehrheit der derzeitigen Maintainer muss dann den PR genehmigen.

Beitragen zur Website

Wir verwenden Hugo zum Formatieren und Generieren der Maturity-Model-Website, Docsy für das Styling und die Struktur der Website und Netlify, um die Bereitstellung der Website zu verwalten. Hugo ist ein Open-Source-Generator für statische Websites, der uns mit Vorlagen versorgt, Vorlagen, die Organisation von Inhalten in einer Standardverzeichnisstruktur und eine Website-Generierungs Maschine. Sie schreiben die Seiten in Markdown (oder HTML, wenn Sie wollen), und Hugo erstellt daraus eine Website.

Alle Beiträge, einschließlich der Beiträge von Projektmitgliedern, müssen geprüft werden. Wir verwenden dafür GitHub Pull Requests. Siehe GitHub-Hilfe für weitere Informationen zur Verwendung von Pull-Requests.

Einrichten einer lokalen Instanz

Installieren Sie eine lokale Kopie der Cloud-native-Maturity-Model-Site mit diesen Anweisungen. Beachten Sie, dass Sie npm und Hugo installiert haben müssen.

git clone https://github.com/cncf/cartografos.git
cd cartografos
git submodule update --init --recursive
cd website
npm installieren

Anschließend können Sie die Website mit npm run serve ausführen.

Zuletzt geändert April 3, 2024: Swap in PageFind for Google Custom Search (68bc21c)