Gelegentliche Beiträge leisten
Um Änderungen an der auf GitLab gehosteten Dokumentationsseite vorzunehmen, steht Ihnen ein integrierter Web-Editor zur Verfügung, der Ihren ersten Beitrag so einfach wie nie zuvor macht. Bearbeiten Sie die Dokumentation direkt in der GitLab Web IDE, die Sie mit einem Klick starten können. Sie benötigen keine speziellen Berechtigungen oder Schreibzugriff auf das Originalprojekt.
-
Es ist nicht nötig, Anwendungen zu installieren oder Repositories auf Ihrem lokalen Computer zu klonen oder Git-Befehle im Terminal auszuführen.
-
Es besteht keine Gefahr, dass etwas kaputt geht.
-
Diese Anleitung gilt für in GitLab gehostete Repositories.
Ein Dokument mit der Web-IDE bearbeiten
Schritt 1: Wählen Sie eine Seite zur Bearbeitung aus
-
Suchen Sie nach einer Dokumentationsseite, die Sie bearbeiten wollen.
-
Navigieren Sie nach oben rechts und suchen Sie die drei Knöpfe.
-
Klicken Sie auf den mittleren Knopf edit the page, um Korrekturen vorzunehmen.
| Der linke Knopf führt Sie zur Versionshistorie der geöffneten Dokumentationsseite. Mit dem rechten Knopf „report an issue“ können Sie Änderungen oder Aktualisierungen melden. |
|
|
-
Melden Sie sich an Ihrem bestehenden Gitlab-Konto an
-
Verwenden Sie den SAML-Link, um Ihr Konto mit dem FAS-Konto zu verknüpfen
-
Sie werden gegebenenfalls weitergeleitet und nach Ihren FAS-Zugangsdaten gefragt
-
Erteilen Sie Fedora die Erlaubnis
Erstellen Sie ein Konto, falls Sie noch keines haben (siehe Abbildung unten).
|
| Dieser Leitfaden für Mitwirkende führt durch die neue Web-IDE, die mit GitLab Version 15.7 eingeführt wurde. Er berücksichtigt auch eine kürzliche Änderung bezüglich der Aktualisierung von Forks. |
Schritt 2: Erstellen Sie Ihr Projekt (Kopie)
Klicken Sie auf die Schaltfläche Open in Web IDE. Alternativ können Sie die Taste . (Punkt) auf Ihrer Tastatur drücken, um die Web-IDE zu starten.
|
Ein Projekt erstmalig forken
Klicken Sie auf den Knopf Fork.
Der Knopf Fork wird nur beim ersten Beitrag zum Repository einer bestimmten Dokumentationsseite angezeigt. Wenn Sie zum ersten Mal zum Fedora-Projekt beitragen und keine Schreibrechte für das gewünschte Repository besitzen, müssen Sie ein Projekt forken.
Ein Fork ist eine persönliche Kopie des Repositorys, die Sie in Ihrem Namensraum erstellen.
|
Wenn Sie zuvor ein Projekt geforkt haben
Falls Sie zuvor ein Projekt geforkt haben, werden Sie ohne den Knopf Fork automatisch zum nächsten Schritt weitergeleitet.
Wenn Sie die Web-IDE nicht aus Ihrem Fork starten, erscheint anstelle des Knopfes „Open in Web IDE“ der Knopf „edit fork in Web IDE“. Anschließend werden Sie mit go to fork aufgefordert, zum Fork zu wechseln und diesen auszuchecken.
-
Gehen Sie zu ihrem geforkten Projekt.
-
Überprüfen Sie den Status Ihres Forks unterhalb des Knopfs „Web IDE“.
Wenn Ihr Fork Up to date with the upstream repository anzeigt, fahren Sie mit Schritt 3 in der Web IDE fort.
Wenn Ihr Fork hinter Upstream zurückliegt, wird Ihnen in der Benutzeroberfläche angezeigt, wie weit Ihre Fork dahinter ist.
-
Klicken Sie auf Update fork.
-
Im Fork wird Up to date with the upstream repository angezeigt
-
Der Knopf Update fork verschwindet, sobald der Fork aktualisiert ist
Schritt 3: Erstellen Sie einen neuen Zweig (eine neue Version)
Erstellen Sie in Ihrem Fork-Projekt einen neuen Zweig und wechseln Sie zu diesem, um die folgenden Schritte zu befolgen.
-
Klicken Sie in der Statusleiste unten links auf den Namen des aktuellen Zweigs (normalerweise „main“).
-
Wählen Sie in der Auswahlliste „Create new branch…“.
-
Geben Sie den Zweignamen ein, der zu einer Aufgabe gehört.
-
Drücken Sie die Eingabetaste.
-
Wechseln Sie mit „Checkout“ zu einem neuen Zweig. Klicken Sie im folgenden Pop-up-Fenster auf „Yes“.
Are you sure you want to checkout <Zweigname>? Any unsaved changes will be lost.
Schritt 4: Änderungen bearbeiten und speichern
Nehmen Sie nun die erforderlichen Änderungen in der Web-IDE vor. Um einen einheitlichen Stil zu gewährleisten, beachten Sie bitte die Stilrichtlinien für die Dokumentation.
Once you’ve finished, select the source control button and click the file underneath changes below Commit & Push button) to view your changes.
Type a commit message and click Commit & Push. Click No to commit to existing branch.
Step 5. Create Merge Request (MR)
In the lower-right corner, you will find three options - create MR, Go to project, Continue working.
-
Click Create MR to create merge request.
-
Bearbeiten Sie den Titel und die Beschreibung der Seite.
-
Scroll down to the blue Create merge request button and click it.
| Go to project option is suitable when you made small commits by stage and want to squash them into one. Continue working is when you want to make smaller commits by sub tasks. If you select Create MR, the UI will navigate to merge request. |
If merge request is successful, you will see the following result in the lower-middle of merge request.
Ready to merge by members who can write to the target branch.
Step 6. Review
Your request will be reviewed by Docs team. You will expect one of the following actions.
-
Reviewers ask you to revise your changes
-
Approve
-
Reject and close MR within reason
Whatever the case it is, MR comments facilitate collaboration between contributors and reviewers. Everyone can learn from those comments and corrections.
Once your MR is approved, the process is complete.
Thanks for your contribution!
Want to help? Learn how to contribute to Fedora Docs ›