Lerne, wie du deine Dokumentation auf unserer Website veröffentlichst!

Entwicklerportal

Du kannst auf unser Entwicklerportal zugreifen, indem du auf den Button Dashboard öffnen auf der Startseite oder Entwickler im Footer klickst.

Erster Login

Wenn du dich zum ersten Mal anmeldest, wirst du zur Login-Seite weitergeleitet, auf der du dich mit deinem GitHub-Konto anmelden kannst.

GitHub wird dich bitten, unsere GitHub-App zu autorisieren, um auf dein Konto zuzugreifen. Es sind nur minimale Berechtigungen erforderlich, die verwendet werden, um deine Identität und Repository-Zugriffsrechte zu überprüfen. Nach der Genehmigung der Anfrage wirst du automatisch zum Entwicklerportal weitergeleitet.

Projekte registrieren

Um ein neues Projekt im Wiki hinzuzufügen, klicke auf den Button Projekt hinzufügen. Dies öffnet ein Dialogfenster, in dem du gebeten wirst, die folgenden Informationen auszufüllen:

• Besitzer - GitHub Repository-Besitzer. Kann ein Benutzer oder eine Organisation sein
• Name - Name des GitHub Repositories
• Branch - Name des Branches, in dem die Dokumentation sich befindet
• Pfad zum Stammverzeichnis der Dokumentation - Pfad zum Dokumentationsstammordner innerhalb des Repositories. Sollte mit einem / beginnen.

Sobald du alles ausgefüllt hast, klicke auf den Button Einreichen, um den Registrierungsprozess abzuschließen.

Wenn der Prozess erfolgreich abgeschlossen wurde, bist du bereit! Versuche, das Projekt im Wiki zu öffnen, um das gerenderte Ergebnis zu sehen.

Solltest du auf Fehler stoßen, siehe dir bitte den Abschnitt zur Fehlerbehebung unten an. Falls das Problem weiterhin besteht, kontaktiere uns.

( Vergiss auch nicht, deine Nutzer wissen zu lassen, dass sie nun die Dokumentation für dein Projekt hier finden können :) )

Fehlerbehebung

Bitte installiere zuerst unsere GitHub-App auf deinem Repository (hier).

1. Mögliche Ursache: Die Wiki-GitHub-App ist nicht im GitHub-Repository des Projekts installiert und kann daher nicht darauf zugreifen. Lösung: Navigiere zu dem Link, der in der Fehlermeldung angegeben ist, und gewähre der Wiki-GitHub-App Zugriff auf dein Repository. Es reicht aus, wenn du ihr nur Zugriff auf das Repository des Projekts gewährst, anstatt auf alle gleichzeitig. Mach dir keine Sorgen, wenn du die Seite verlässt – ausgefüllte Informationen werden gespeichert und beim Zurückkehren wieder angewendet.

2. Mögliche Ursache: Das angegebene GitHub-Repository existiert nicht. Lösung: Stelle sicher, dass du die Felder Besitzer und Name des Repositories korrekt ausgefüllt hast. Diese sollten dem owner/name Paar des Repositories entsprechen, wie es in der URL zu sehen ist, z. B. https://github.com/Sinytra/Wiki würde Sinytra als Besitzer und Wiki als Name verwenden.

Verifizierungsfehler

• Mögliche Ursache: Dein Projekt auf der Hosting-Plattform (siehe Dokumentations-Metadaten) enthält keinen Link zur Quelle, der auf dein GitHub-Repository verweist. Lösung: Um die Projektzugehörigkeit zu verifizieren, stelle bitte vorübergehend sicher, dass die URL im "Source Code"-Feld deines Projekts mit der URL deines GitHub-Repositories übereinstimmt.

Erweitern, um Unterstützung für Modrinth-Projekte zu erhalten

1. Gehe zu den Einstellungen deines Projekts.
2. Navigiere zum Tab Links.
3. Gib die GitHub-Repository-URL in das Feld Source code ein.
4. Wende die Änderungen an.

Erweitern, um Unterstützung für CurseForge-Projekte zu erhalten

1. Gehe zu den Einstellungen deines Projekts.
2. Navigiere zum Tab Source.
3. Gib die GitHub-Repository-URL in das Feld Repository URL ein.
4. Wende die Änderungen an.

Der Benutzer hat keinen Zugriff auf das Repository.

Die Zugriffsberechtigungen für dein Repository reichen nicht aus, um es auf der Wiki zu registrieren. Stelle bitte sicher, dass du mindestens Maintain- oder Admin-Zugriff hast.

Ungültiger Pfad angegeben

Der angegebene Pfad existiert nicht oder ist eine reguläre Datei. Stelle bitte sicher, dass der Pfad auf ein existierendes Verzeichnis im Repository verweist. Es ist nicht nötig, den Pfad mit einem Branch- oder Tag-Namen zu versehen.

Dieses Feld entspricht dem path-Parameter der GitHub "Get repository content" REST-API Route.

Projektmanagement

In deinem Entwickler-Dashboard findest du einige Optionen, mit denen du dein Projekt verwalten kannst. Diese werden im Folgenden detailliert beschrieben.

Projekt neu validieren

Alle zwischengespeicherten Dokumentationsseiten werden gelöscht, sodass sie bei Bedarf erneut gerendert werden. Diese Option sollte nur verwendet werden, wenn die Dokumentationsquelle selbst aktualisiert wurde.

Zu deiner eigenen Bequemlichkeit empfehlen wir, die Dokumente nach der Veröffentlichung automatisch mithilfe unseres Gradle-Plugins neu zu validieren.

Projekt bearbeiten

Bearbeite die während der Registrierung festgelegten Parameter des Projekts. Das Eigentum des Projekts wird bei einer Aktualisierung erneut validiert.

Projekt löschen

Lösche das Projekt dauerhaft und entferne alle zugehörigen Daten von unseren Servern. Der Cache für Dokumentationsseiten wird sofort gelöscht, aber es kann einige Zeit dauern, bis die Änderungen im CDN und bei den Browsern angezeigt werden.

Diese Aktion kann nicht rückgängig gemacht werden.