Zu Hauptinhalt springen Zu ergänzendem Inhalt springen

Implementieren des Portals mit GitHub Pages

Die GitHub Pages-Implementierung kann direkt in Talend Cloud API Designer aktiviert werden. Dies ist aber auch manuell nach dem Generieren des Repositorys möglich. Weitere Informationen finden Sie in der GitHub-Dokumentation.

Vorbereitungen

  • Sie haben Ihr API Portal-Repository generiert.
  • Sie verfügen über einen GitHub-Plan, der Ihnen die Veröffentlichung über ein privates Repository ermöglicht.

Prozedur

  1. Gehen Sie in Ihrem GitHub-Repository zu Settings (Einstellungen) und scrollen Sie nach unten zum Abschnitt GitHub Pages.
  2. Wählen Sie gh-pages als Quell-Branch und /(root) als Quellverzeichnis aus und klicken Sie dann auf Save (Speichern).
    Abschnitt GitHub Pages.
  3. Öffnen Sie im Branch main die Datei /.github/workflows/github-pages.yaml und aktualisieren Sie das Element on wie folgt:
    on:
      push:
        branches: [ 'main' ]
  4. Übergeben Sie Ihre Änderungen.

Ergebnisse

Nach dem Übergeben Ihrer Änderungen an github-pages.yaml wird die entsprechende GitHub-Aktion ausgeführt. Sie erstellt den Inhalt über Ihren Branch main und verschiebt ihn in den Branch gh-pages, der zum Implementieren des Portals verwendet wird. Die URL ist im Abschnitt GitHub Pages in den Einstellungen verfügbar.
In diesem Beispiel ist die URL https://company.github.io/api-portal/ im Abschnitt GitHub Pages verfügbar.

Hat diese Seite Ihnen geholfen?

Wenn Sie ein Problem mit dieser Seite oder ihrem Inhalt feststellen, sei es ein Tippfehler, ein ausgelassener Schritt oder ein technischer Fehler, informieren Sie uns bitte!