Einführung und Ziele¶

Was ist der Contributor Guide?¶

Zuerst ist es wichtig zu beachten, dass es sich nicht nur um Codeprojekte handelt. OpenStack-Beiträge gibt es in verschiedenen Formen wie z.B. Meetups abhalten, Identifizierung von Use Cases (Product Working Group), Dokumentation, Testing, etc. Unser Ziel ist es, diese Beiträge gleichwertig zu bewerten.

Der Contributor Guide zielt darauf ab, eine gemeinsame Dokumentation für alle OpenStack-Contributors bereitzustellen und bei der Eingliederung zu helfen.

Die gemeinsame Dokumentation, an der verschiedene Projekte arbeiten, wird besser dazu beitragen, doppelten Aufwand und inkonsistente Dokumentation zu vermeiden und genauere Informationen zu liefern. Projekte, die keine/veraltete Dokumentation haben, können auch einfach den Contributor Guide verwenden.

Wo der Leitfaden verwendet wird¶

Bei verschiedenen OpenStack-Veranstaltungen wird das Contributor Guide verwendet, um verschiedene On-Boarding-Programme zu unterstützen:

Das OpenStack Upstream Institute
Die Prüfung zum Certified OpenStack Administrator
On-Boarding-Sitzungen des Projektteams

Projektspezifische Leitfäden für Mitwirkende¶

Projektteams sollten immer noch über eine eigene Mitwirkenden-Dokumentation verfügen, um Dinge abzudecken, die unter Beispiele für Dokumentation, die nicht üblich ist aufgeführt sind. Ein paar Beispiele für projektteamspezifische Mitwirkenden Guides sind die des Nova Teams und die des Dokumentationsteams .

Hinzufügen/Aktualisieren von Inhalten¶

Bevor Sie neue Inhalte ändern oder hinzufügen, machen Sie sich zunächst mit den Code-/Dokumentationsrichtlinien von OpenStack vertraut. Sie können die Code & Dokumentation Mitwirkende Anleitung für den Einstieg lesen.

Nachdem Sie die Anleitung gelesen haben, verwenden Sie git, um das Contributor Guide Repository zu kopieren:

git clone https://opendev.org/openstack/contributor-guide

Inhaltsrichtlinien¶

Keine Textwand. Der Leser sollte das Gefühl haben, dass er die Dinge auf der Seite in fünf Minuten erledigen kann, anstatt noch eine weitere vergessene Registerkarte zu haben, auf die er nie zurückkommen wird.
Verwenden Sie Screenshots.
Vermeiden Sie es, jedes Problem zu behandeln, das unterwegs auftreten kann. Je nachdem, wie verbreitet es ist, wird es von Fall zu Fall akzeptiert.
Bitte keine Videos. Sie sind viel zu kompliziert, um auf dem Laufenden zu bleiben.

Nur allgemeine Inhalte¶

Da das Contributor Guide allgemein gehalten ist, so dass jeder es benutzen kann, sind hier einige hilfreiche Beispiele dafür, was beigetragen werden soll. Beispiele für Dinge, die nicht üblich sind, sollten in der spezifischen Dokumentation Ihres Projektteams enthalten sein, die im Contributor Portal aufgelistet wird.

Beispiele für gängige Dokumentation¶

Einrichten von Git.
Einrichten des IRC zur Kommunikation.
Einrichten von Mailinglisten für die Kommunikation.
Einrichtung geeigneter Konten, um einen Beitrag wie Gerrit, Storyboard und Launchpad zu leisten.
Wie man bei Wahlen abstimmt.

Beispiele für Dokumentation, die nicht üblich ist.¶

Ein bestimmtes Softwaretool, das nur Ihr Projektteam verwendet.
Spezifische Verfahren für Dinge wie die Fehlersuche.

Beispiele für eine gute Dokumentation¶

Verwenden Sie bereits akzeptierte Kapitel, um sich ein Bild davon zu machen, wonach wir suchen.

Wie kann ich mit der Hilfe beginnen?¶

Fehlerberichte und Aufgaben werden alle in Storyboard aufgezeichnet. Wenn etwas nicht zugeordnet ist, steht es Ihnen zur Verfügung.

Hilfe beim Beitragen erhalten¶

We want you to succeed! You can ask for help on IRC OFTC in channel #openstack-doc. You can also ask for help on the OpenStack Discuss Mailing list prefixing your email subject with ‚[contributor-guide]‘. If you’re not familiar with these ways of communicating, read the Code & Dokumentation Mitwirkende Anleitung.

Einführung und Ziele