MDN Web Docs Repositories

MDN Web Docs ist ein komplexes Projekt mit vielen beweglichen Teilen. Es ist eine gute Idee, sich mit den verschiedenen Repositories des Projekts vertraut zu machen. Dieses Dokument soll Ihnen helfen, die verschiedenen Repositories (Repos) zu finden, die Sie benötigen könnten, wenn Sie zu verschiedenen Teilen des MDN Web Docs Projekts beitragen.

Repository-Ebenen

Ebene 1

Der Code in diesen Repositories ist zentral für das MDN Web Docs Projekt und läuft auf von Mozilla betriebenen Domains.

Ein Projekt der Ebene 1 sollte mindestens 3 Mitglieder haben, darunter mindestens zwei mit Administratorrechten.

Ebene 2

Diese Repositories konzentrieren sich hauptsächlich auf die Unterstützung von Inhalten, wie z. B. Codebeispiele, den MDN Web Docs Lernbereich, Lokalisierung und Beispielprojekte. Beispiele sind:

Ein Projekt der Ebene 2 sollte mindestens 2 Mitglieder haben, darunter mindestens eines mit Administratorrechten.

Ebene 3

Dies sind Repositories, die für die Projektplanung, die Dokumentation des Projekts selbst und die Einbindung der Community verwendet werden. Beispiele sind:

Ein Projekt der Ebene 3 benötigt einen Administrator.

Kern-Repos

  • Kerninhalt: https://github.com/mdn/content. Das wichtigste Repo für MDN Web Docs Inhalte — hier wird der gesamte englische Kerninhalt der Webseite gespeichert und hier nehmen Sie alle Standardänderungen an Seiteninhalten vor.
  • MDN Web Docs Plattform: https://github.com/mdn/yari. Hier wird die MDN Web Docs Plattform gespeichert. Hier sollten Sie hingehen, wenn Sie Änderungen an der Seitenstruktur auf hoher Ebene oder an der Rendering-Mechanik vornehmen möchten.
  • Browser-Kompatibilitätsdaten: https://github.com/mdn/browser-compat-data. Hier werden die Daten gespeichert, die zur Generierung der Browser-Kompatibilitätstabellen auf unseren Referenzseiten verwendet werden (Beispiel). Wenn Sie Informationen über die Browser-Kompatibilität von Web-Features haben — oder bereit und in der Lage sind, etwas Forschung und/oder Experimente durchzuführen — können Sie helfen, MDNs Browser-Kompatibilitätsdaten zu aktualisieren.
  • Interaktive Beispiele: https://github.com/mdn/interactive-examples. Dieses Repo speichert die Beispiel-Codeblöcke, die auf vielen unserer Referenzseiten oben zu finden sind (Beispiel). Bearbeiten Sie diese Beispiele hier.
  • Bob aka Builder of Bits: https://github.com/mdn/bob Dieses Repo speichert den Rendering-Code, der die schönen bearbeitbaren, kopierbaren Beispiele erzeugt, die auf vielen unserer Referenzseiten oben zu finden sind (Beispiel).
  • Übersetzter Inhalt: https://github.com/mdn/translated-content. Hier befindet sich der lokalisierte Inhalt. Besuchen Sie dieses Repo, wenn Sie helfen möchten, Seiten in eine unserer aktiv gepflegten Sprachen zu übersetzen.
  • Workflows: https://github.com/mdn/workflows Eine wachsende Sammlung von wiederverwendbaren GitHub-Aktionen für die Verwendung in MDN Web Docs Repositories.

Codebeispiel

Codebeispiele und Demos

Die MDN Web Docs GitHub Organisation enthält eine große Anzahl von Beispiel-Repos. Diese enthalten generell eigenständige Codebeispiele, die zu groß sind oder nicht mit dem EmbedLiveSample Makro gerendert werden können. Diese Beispiele werden in die Inhaltsseiten mit einem Makroaufruf wie diesem eingebettet — {{EmbedGHLiveSample("css-examples/learn/tasks/grid/grid1.html", '100%', 700)}}.

Denken Sie immer daran, dass Sie, wenn Sie den Code auf einer bestimmten Seite aktualisieren, auch das entsprechende Beispiel-Repo aktualisieren müssen.