Zu den Docs beitragen

Unser Benutzerhandbuch ist quelloffen und wird in einem öffentlich zugänglichen Repository auf GitHub gehostet, wo Sie Änderungen über Pull Requests (PRs) einreichen können. Dieser Open-Source-Ansatz für die Dokumentation hat viele Vorteile:

  • Ein offener und transparenter Prozess, um die hilfreichsten Inhalte zur Verwendung von Adobe Commerce und Magento Open Source zu erstellen
  • Kontinuierliche Aktualisierung und Veröffentlichung von Verbesserungen und Änderungen der Inhalte
  • Kontinuierliche Zusammenarbeit zwischen Kunden, Partnern, unseren Produktteams und unserem Dokumentationsteam

Arbeiten mit kollaborativer Dokumentation

Als Commerce-Anwender - unabhängig davon, ob Sie Mitarbeiter, Partner, Kunde oder potenzieller Kunde von Adobe sind - haben Sie die Möglichkeit, auf einfache Weise zu dieser Dokumentation beizutragen:

  • Melden Sie ein GitHub-Problem für eine bestimmte Seite an
  • Senden Sie eine kurze Bearbeitung, wenn Sie grundlegende Fehler sehen
  • Verfassen ganzer Abschnitte oder Seiten, einschließlich Grafiken

Die Informationen in diesem Thema beschreiben alles, was Sie wissen müssen, um mit diesem Benutzerhandbuch zu interagieren und dazu beizutragen.

Ein Problem protokollieren

Wenn Sie ein Problem mit einer unserer Seiten sehen, wie z. B. einen defekten Link, einen Inhaltsfehler oder ein anderes Problem, das Sie identifizieren können, lassen Sie es uns wissen.

  1. Klicken Sie rechts neben dem Seitentitel auf Problem melden.

    Ein Problem melden

    Dies öffnet die Registerkarte “Probleme” in unserem GitHub-Repository. Die URL der Seite wird automatisch in das Feld “Zusammenfassung” eingefügt.

Um ein Problem zu protokollieren, müssen Sie ein neues Konto erstellen oder sich bei Ihrem bestehenden GitHub-Konto anmelden.

  1. Geben Sie eine Zusammenfassung ein (oder belassen Sie die Standardeinstellung), schreiben Sie eine kurze Beschreibung des Problems und klicken Sie dann auf Neues Problem einreichen.

    Ein neues Problem einreichen

Inhaltliche Änderungen einreichen

Unser gesamter Inhalt befindet sich auf GitHub, einer bekannten Plattform zur Versionskontrolle. Jeder kann ein kostenloses GitHub-Konto erstellen und über die GitHub-Weboberfläche Änderungen und Ergänzungen an den Inhalten vornehmen. Wenn Sie ein Entwickler sind oder sich mit der Git-Source-Control und lokalen Build-Umgebungen auskennen, können Sie auf diese Weise mit unseren Quelldateien arbeiten.

Damit Ihre Beiträge, ob groß oder klein, akzeptiert und veröffentlicht werden können, müssen Sie die Adobe Contributor License Agreement (CLA) unterzeichnen. Diese CLA ist mit Ihrem GitHub-Konto verknüpft. Sie müssen sie nicht erneut unterschreiben.

Schnelles Editieren ermöglichen

Änderungen sind eine gute Möglichkeit, kleine Fehler und Auslassungen im Benutzerhandbuch zu beheben. Wenn eine Seite einen Link zum Bearbeiten anzeigt, können Sie selbst eine schnelle Korrektur vornehmen. Wenn Sie das Dokument bearbeiten, senden Sie uns einen Pull Request (PR), um die Korrektur/den Vorschlag an uns zu übermitteln. Dann können wir die eingereichte Änderung überprüfen, genehmigen und veröffentlichen.

  1. Öffnen Sie die Seite des Benutzerhandbuchs, die Sie bearbeiten oder aktualisieren möchten.

  2. Klicken Sie rechts neben dem Titel des Themas auf Edit on GitHub.

    Auf GitHub bearbeiten

    Dadurch wird automatisch die Markdown-Quelldatei in GitHub geöffnet.

  3. Klicken Sie auf das Bleistiftsymbol, um die Seite zu bearbeiten.

    Klicken Sie auf das Bleistiftsymbol

Wenn das Bleistiftsymbol nicht verfügbar ist, müssen Sie sich bei Ihrem GitHub-Konto anmelden oder ein neues Konto erstellen.

  1. Nehmen Sie Ihre Änderungen im Webeditor vor.

    Sie können auf die Registerkarte Änderungen prüfen klicken, um die Formatierung Ihrer Änderung zu überprüfen.

  2. Wenn Sie Ihre Änderungen abgeschlossen haben, blättern Sie zum Ende der Seite.

  3. Geben Sie eine Zusammenfassung und Beschreibung für Ihren Commit (Änderungsdatensatz) ein, ähnlich wie im folgenden Beispiel:

    Commit changes

  4. Klicken Sie auf Änderungen festschreiben.

Wenn Sie eine Fehlermeldung zur Validierung der Unterzeichnung eines Contributor License Agreement (CLA) erhalten, klicken Sie auf Details, um die Lizenzvereinbarung zu öffnen. Unterschreiben Sie die Vereinbarung, wenn sie akzeptabel ist. Kehren Sie zu Ihrer Pull-Anfrage zurück und fahren Sie fort.

Das war’s schon! Mitglieder des Adobe Commerce Docs-Teams werden Ihren PR überprüfen und zusammenführen, damit Ihre Änderungen in unseren automatischen Veröffentlichungsprozess aufgenommen werden können.

Einen neuen Abschnitt oder eine neue Seite verfassen

Wir wissen, dass unsere Partner und Kunden aufgrund ihrer praktischen Erfahrungen mit Commerce-Produkten über ein umfangreiches Wissen verfügen. Wenn Sie Ihr Wissen teilen, profitiert die gesamte Commerce-Community davon. Eine neue Seite, auf der Sie zum Beispiel beschreiben, wie Sie eine E-Commerce-Anforderung gelöst haben, ist eine großartige Ergänzung für unser Benutzerhandbuch.

Unser GitHub wiki bietet detaillierte Informationen über das Verfassen von Inhalten, unsere Markdown-Syntax und die Seitennavigation.