Repository-Architektur
Das zur Generierung und Veröffentlichung des Portals verwendete Repository ist folgendermaßen strukturiert:
| Element | Beschreibung |
|---|---|
| .github | Dieser Ordner enthält Konfigurationsdateien für GitHub-Aktionen, die beispielsweise die Implementierung in GitHub Pages oder Azure Static Web Apps ermöglichen. |
| apis | Dieser Ordner enthält die zu veröffentlichende API-Dokumentation. Für jede API sollte ein Ordner vorhanden sein, wobei jeder dieser Ordner wiederum einen Ordner pro Version enthalten sollte. Die Dokumentation für eine API-Version befinden sich in apis/<api-name>/<api-version>/index.md. Mit der Benutzeroberfläche von Talend Cloud API Designer wird diese Struktur bei der Veröffentlichung einer API automatisch erstellt. |
| assets | Dieser Ordner enthält vom Benutzer verwaltete Dateien, wie z. B. JavaScript- und CSS-Dateien. |
| content | Dieser Ordner enthält alle anderen Seiten, die Sie in Ihr Portal aufnehmen möchten. Standardmäßig sind eine Landingpage sowie eine Seite „Erste Schritte“ enthalten. |
| static | Dieser Ordner enthält vom Benutzer verwaltete statische Dateien, wie z. B. Bilder und Schriftarten. |
| themes | Dieser Ordner enthält das Thema für das Portal. Es wird von Talend bereitgestellt, eine Bearbeitung wird nicht empfohlen. Wenn Sie das Thema anpassen möchten, finden Sie weitere Informationen unter Customizing your portal. |
| config.toml | Diese Datei enthält die Konfiguration für das Portal. Diese gibt das bei der Generierung der Website zu verwendende Thema vor und ermöglicht Ihnen die Anordnung Ihrer APIs in Kategorien. Weitere Informationen finden Sie unter Organizing your API list. |