Experience Manager Guides und Edge Delivery Services
Mit Adobe Experience Manager Guides können Sie Ihre DITA-Inhalte über ein dediziertes GitHub-basiertes Veröffentlichungsprofil direkt in Edge Delivery Services (EDS) veröffentlichen. Mit dieser Funktion können Unternehmen hochleistungsfähige, responsive Dokumentationserlebnisse bereitstellen und gleichzeitig DITA-basierte Authoring-Workflows in Experience Manager Guides beibehalten.
Weitere Informationen zur Verwendung von EDS in Adobe Experience Manager finden Sie in der Übersicht über Edge Delivery Services.
Um die Veröffentlichung von Experience Manager Guides in EDS zu aktivieren, müssen Sie eine Reihe von Konfigurationsschritten für GitHub und Experience Manager Guides durchführen. In den folgenden Abschnitten werden die einzelnen Schritte der Reihe nach beschrieben und erläutert, wie sie im gesamten Veröffentlichungs-Workflow zusammenarbeiten.
Eine kurze Videoanleitung finden Sie unter Veröffentlichen in AEM Guides.
Einrichten und Konfigurieren von GitHub für EDS
In diesem Abschnitt wird beschrieben, wie Sie GitHub für die Verwendung mit EDS einrichten und konfigurieren. Es behandelt das Erstellen eines Repositorys mit dem Adobe-Textbaustein, das Verbinden von GitHub mit Adobe Experience Manager über AEM Code Sync, das Konfigurieren der erforderlichen GitHub- und OAuth-Anwendungen und das Definieren des Repository-Bereitstellungspunkts, der für die Veröffentlichung von Inhalten verwendet wird.
Erstellen eines GitHub-Repositorys für EDS
EDS erfordert ein GitHub-Repository mit einer vordefinierten Struktur. Adobe bietet ein offizielles Textbaustein-Repository, das speziell für Experience Manager Guides-Anwender entwickelt wurde.
Führen Sie die folgenden Schritte aus, um Ihr Repository zu erstellen:
-
Öffnen Sie das Experience Manager Guides-Vorlagenrepository aem-guides-boilerplate.
-
Erstellen Sie mithilfe dieser Vorlage ein neues Repository. Erfahren Sie Erstellen eines Repositorys aus einer Vorlage. Stellen Sie sicher, dass die Repository-Sichtbarkeit auf "" ist, damit der Zugriff über EDS möglich ist.
Das Repository wird jetzt erstellt und an der Textbausteinvorlagenstruktur ausgerichtet.
Erstellen einer neuen OAuth-App
Zum Authentifizieren von Benutzern beim Erstellen eines EDS-Veröffentlichungsprofils in Experience Manager Guides ist eine OAuth-App erforderlich. Dies ermöglicht einen sicheren Anmeldefluss mit einer Client-ID und Client-Geheimnis.
Führen Sie die folgenden Schritte aus, um eine neue OAuth-App zu erstellen:
-
Navigieren Sie auf GitHub zur linken Seitenleiste und wählen Sie Entwicklereinstellungen.
-
Wählen Sie in der linken Seitenleiste OAuth-Apps aus.
-
Wählen Sie Neue OAuth-App aus.
{width="650"}
-
Registrieren Sie Ihre Anwendung, indem Sie die folgenden obligatorischen Details angeben:
- Anwendungsname: Geben Sie den Namen Ihres EDS-Repositorys ein
- Homepage-URL: Geben Sie die URL für die Experience Manager Guides-Instanz ein. (Das Beispiel-URL-Format finden Sie in Schritt 4 des Abschnitts Erstellen einer neuen GitHubApp).
- Autorisierungs-Callback-URL: identisch mit der Homepage-URL
-
Wählen Sie die Option Gerätefluss aktivieren und wählen Sie dann Anwendung registrieren, um die Registrierung abzuschließen.
{width="650"}
Ihre App ist jetzt bereit. Notieren Sie sich die Client-ID. Beim Konfigurieren des Veröffentlichungsprofils in können Sie jetzt oder bis zu fünf Client-Geheimnisse generieren.
Konfigurieren der Bereitstellungspunkt-URL im EDS-Repository
EDS liest Inhalte aus einer Bereitstellungspunkt-URL, die in der fstab.yaml-Datei im Stammverzeichnis Ihres Repositorys definiert ist. Diese URL verweist EDS auf den Speicherort, an dem Experience Manager Guides die generierten Inhalte veröffentlicht.
So konfigurieren Sie die Bereitstellungspunkt-URL in der fstab.yaml:
-
Öffnen Sie die
fstab.yaml-Datei in Ihrem GitHub-Repository. -
Aktualisieren Sie den
urlunter Verwendung des folgenden Formats:code language-text https://guides.adobe.com/eds-workers/<account type>/<git acc domain>/<git username>/<git repo>/<branch>/<root folder>In der folgenden Tabelle werden die einzelnen Felder der URL beschrieben:
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 Feld Beschreibung https://guides.adobe.com/eds-workersWorker-URL, die von Experience Manager Guides zum Veröffentlichen von Inhalten in EDS verwendet wird. Ändern Sie diesen Wert nicht. <account type>Typ des Git-Kontos. Auf githubsetzen.<git acc domain>Domain Ihres Git-Kontos. Auf github.comsetzen.<git username>Ihr GitHub-Benutzername. <git repo>Name des GitHub-Repositorys, das Sie für EDS erstellt haben <branch>Verzweigung, auf der der Inhalt veröffentlicht werden soll. Der Standardwert ist main. Wenn Sie den Verzweigungsnamen auf GitHub ändern, aktualisieren Sie ihn hier und im EDS-Veröffentlichungsprofil in Experience Manager Guides.<root folder>Stammordner des Repositorys, in den die veröffentlichten Dateien übertragen werden. Der Standardwert ist docs. Wenn Sie den Ordnernamen auf GitHub ändern, aktualisieren Sie ihn hier und im EDS-Veröffentlichungsprofil in Experience Manager Guides.Wenn beispielsweise Ihr GitHub-Benutzername
my-usernameund Ihr Repository-Namemy-eds-repoist, wird diefstab.yamlwie folgt angezeigt:code language-yaml mountpoints: /: url: https://guides.adobe.com/eds-workers/github/github.com/my-username/my-eds-repo/main/docs type: markup {width="650"}
note NOTE Wenn Sie weiterhin das frühere URL-Format ( https://guides.adobe.com/eds-workers/<git username>/<git repo>/<branch>/<root folder>) verwenden, werden für den Kontotyp und die Domain standardmäßiggithubundgithub.com. -
Wiederholen Sie die Schritte 2 und 3 aus dem Abschnitt Verbinden von GitHub mit Adobe über AEM Code-), um das Repository zu autorisieren.
Verbinden von GitHub mit Adobe über die AEM-Codesynchronisierung
Adobe Experience Manager verwendet eine GitHub-Anwendung namens AEM Code Sync, um Inhalte von Experience Manager Guides auf GitHub zu pushen.
Führen Sie die folgenden Schritte aus, um die Anwendung AEM Code Sync zu installieren und zu konfigurieren:
-
Navigieren Sie zur Seite AEM Code Sync und wählen Sie Installieren.
AEM Code Sync überwacht Repository-Änderungen und stellt sicher, dass Aktualisierungen korrekt an GitHub gesendet werden.
note NOTE Stellen Sie bei der Installation der Anwendung sicher, dass Sie dasselbe GitHub-Konto verwenden, dem das Repository gehört.
-
Gewähren Sie auf der nächsten Seite Zugriff auf das von Ihnen erstellte Repository. Wählen Sie Nur Repositorys auswählen und wählen Sie dann Ihr Repository aus der Dropdown-Liste aus.
{width="350"}
-
Wählen Sie Installieren und autorisieren aus.
Sie werden zur GitHub-Setup-Seite weitergeleitet.
-
Überprüfen Sie die Details zum Quell-Code und wählen Sie Weiter aus.
-
Konfigurieren Sie auf Seite Inhaltsquelle“ die folgenden Einstellungen:
- Quelltyp des Inhalts: Wählen Sie Sonstige (eigenes Markup einbringen).
- Inhaltsquellen-URL: Überprüfen Sie die URL, die als Bereitstellungspunkt-URL in der
fstab.yaml-Datei konfiguriert ist. Wenn Sie die URL in der Datei nicht aktualisiert haben, können Sie sie hier aktualisieren. - Dateierweiterung: Ändern Sie das standardmäßige
.htmlSuffix in.htm.
Stellen Sie sicher dass „Andere Inhaltsquelle verwenden ausgewählt ist.
-
Fügen Sie auf Seite Benutzer“ bei Bedarf Benutzer hinzu und klicken Sie auf Weiter.
-
Überprüfen Sie die Konfigurationsübersicht und wählen Sie Speichern aus.
Nach erfolgreicher Registrierung wird eine Bestätigungsseite angezeigt. Sie können die URLs Vorschau und Live für Ihre Website von dieser Seite kopieren und speichern.
Einrichten und Konfigurieren von GitLab für EDS
Anweisungen zum Konfigurieren von GitLab als Publishing-Repository für Edge Delivery Services finden Sie unter Einrichten und Konfigurieren von GitLab für EDS.
Erstellen und Konfigurieren eines Veröffentlichungsprofils für EDS in Experience Manager
In den folgenden Abschnitten werden die einzelnen Schritte nacheinander beschrieben und erläutert, wie Sie das EDS-Veröffentlichungsprofil einrichten, eine Ausgabevorgabe konfigurieren und mithilfe von EDS in Experience Manager Guides eine Ausgabe generieren.
Erstellen des EDS-Veröffentlichungsprofils für GitHub oder GitLab
-
Wechseln Sie zu Workspace Einstellungen > Profile veröffentlichen.
-
Wählen Sie das Symbol + aus, um ein neues Veröffentlichungsprofil zu erstellen, und geben Sie die folgenden Details an:
-
Servertyp*: Wählen Sie Git (Edge Delivery-Service) aus der Dropdown-Liste aus.
-
Name*: Geben Sie einen Namen für das Veröffentlichungsprofil ein.
-
Git-Kontotyp*: Wählen Sie GitHub oder GitLab aus der Dropdown-Liste aus, je nach Git-Repository-Anbieter.
-
Instanz-URL*: Geben Sie die URL Ihrer GitHub- oder GitLab-Instanz ein, z. B.
https://github.comoderhttps://gitlab.com. -
Repository-Name*: Geben Sie den Namen Ihres GitHub- oder GitLab-Repositorys ein.
-
Benutzername*: Geben Sie Ihren GitHub- oder GitLab-Benutzernamen ein.
-
Zweigname: auf
main(Standard) gesetzt. -
Stammordner*: Auf
docs(Standard) gesetzt. -
Site-Inhaber (nur GitLab): Geben Sie den Inhaber der Edge Delivery Services-Site ein.
-
Site-Repository (nur -Lab: Geben Sie den Repository-Namen ein, der mit der Edge Delivery Services-Site verknüpft ist.
-
HLX-API-Schlüssel Geben Sie den HLX-API-Schlüssel für Ihre EDS-Konfiguration ein. Dieser Schlüssel ist erforderlich, um die Funktion „Veröffentlichung rückgängig gemacht“ zu unterstützen, die in der Version 2026.11.0 von Experience Manager Guides as a Cloud Service eingeführt wurde. Außerdem ist der Schlüssel für die Veröffentlichung des Inhalts in EDS erforderlich, wenn die Inhaltsgröße mehr als 100 Dateien beträgt.
-
Authentifizierungsberechtigungen: Geben Sie die Anmeldeinformationen basierend auf dem ausgewählten Git-Kontotyp an:
- GitHub: Geben Sie die Client-ID* und Client-Geheimnis* ein, die Sie von Ihrer GitHub OAuth-App erhalten haben. Weitere Informationen finden unter „Erstellen einer neuen OAuth-".
- GitLab: Geben Sie das Zugriffstoken* ein, das für Ihr GitLab-Konto generiert wurde.
-
-
(Nur GitHub) Wählen Sie Anmelden aus, um sich zu authentifizieren. Für GitLab ist keine Anmeldung erforderlich, da das Zugriffstoken für die Authentifizierung verwendet wird.
{width="650"}
-
Klicken Sie auf Speichern. Für GitHub ist die Option Speichern nach erfolgreicher Authentifizierung verfügbar.
Ihr EDS-Veröffentlichungsprofil ist jetzt konfiguriert.
Erstellen einer Ausgabevorgabe für EDS und Generieren einer Ausgabe
-
Öffnen Sie Ihre Karte in der Kartenkonsole.
-
Wählen Sie auf Registerkarte Ausgabevorgaben“ + aus, um eine neue Ausgabevorgabe zu erstellen.
-
Geben Sie Dialogfeld „Neue" die folgenden Details ein:
- type: Edge Delivery-Service auswählen
- Name: Geben Sie einen Namen für diese Voreinstellung an
-
Wählen Sie Hinzufügen aus.
{width="650"}
-
Öffnen Sie die neu erstellte EDS-Ausgabevorgabe und konfigurieren Sie die folgenden Felder:
-
Bedingte Filterung: Wählen Sie Keine, um eine Ausgabe ohne Filterung zu generieren, oder Mit DITAVAL, um die bedingte Filterung anzuwenden.
-
Unterordner veröffentlichen: Geben Sie den Namen des Unterordners ein, in dem die Ausgabe veröffentlicht wird. Der Unterordner wird im Repository unter dem Stammordner erstellt und erscheint in den EDS-Links zum veröffentlichten Inhalt. Wenn beispielsweise der Stammordner
docsund der Unterordner Veröffentlichenproduct-guideist, wird der Inhalt indocs/contents/product-guideveröffentlicht. -
Veröffentlichungsprofil: Sie das im vorherigen Abschnitt konfigurierte GitHub- oder GitLab-Veröffentlichungsprofil aus.
{width="650"}
-
-
Wählen Sie Speichern und dann Ausgabe generieren.
<root folder>/contents/<publish subfolder> des EDS-Repositorys gespeichert.Die EDS-Ausgabe wird jetzt generiert. Der Inhalt wird in einem sauberen, responsiven Layout präsentiert. Sie enthält reguläre Elemente wie den Seitentitel, Breadcrumbs, Textinhalte und alle im Thema verwendeten Blöcke. Das Inhaltsverzeichnis auf der linken Seite (generiert aus der Karte) hilft Ihnen, durch Themen zu navigieren, während ein Mini-Inhaltsverzeichnis auf der rechten Seite die Abschnitte innerhalb der aktuellen Seite hervorhebt. Die gesamte Ausgabe ist vollständig responsiv und sorgt für ein optimiertes, konsistentes Leseerlebnis auf allen Geräten.
Anpassen der Ausgabe mithilfe von EDS-Blöcken
EDS verwendet blocks, um zu steuern, wie verschiedene Teile Ihres Inhalts formatiert und angezeigt werden. Sie können vorhandene Blöcke ändern oder benutzerdefinierte Blöcke erstellen.
Die folgenden Beispiele führen Sie durch die Anpassung eines vorhandenen Bausteins und die Erstellung eines neuen Bausteins, um die endgültige EDS-Ausgabe in Experience Manager Guides zu gestalten.
Anpassen eines Breadcrumb-Blocks, um seine Textfarbe zu aktualisieren
Breadcrumbs werden seitenübergreifend verwendet, damit Benutzer verstehen können, wo sie sich in der Dokumentation befinden. Da dieser Baustein auf der gesamten Website konsistent angezeigt wird, ermöglicht eine Aktualisierung seines Stils eine einheitliche Design-Aktualisierung.
Führen Sie die folgenden Schritte aus, um einen Breadcrumb-Block anzupassen und seine Textfarbe zu aktualisieren:
-
Wechseln Sie zu Ihrem GitHub-Repository und öffnen Sie den Ordner
blocks. -
Wählen Sie den Breadcrumbs-Block aus.
{width="650"}
-
Öffnen Sie die
cssund aktualisieren Sie die Textfarbe. -
Übertragen Sie die Änderungen an GitHub.
-
Aktualisieren Sie die Live-Website, um die Aktualisierungen anzuzeigen.
Aktualisieren von EDS-Skripten zum Erstellen benutzerdefinierter Elemente in der veröffentlichten Ausgabe
In einigen Fällen möchten Sie möglicherweise nur einen bestimmten Teil Ihres Inhalts formatieren. Führen Sie die folgenden Schritte aus, um dies mithilfe eines benutzerdefinierten Blocks zu erreichen.
-
Öffnen Sie die Themendatei und wählen Sie den Text in einem Tag-Element aus.
Im folgenden Screenshot ist der Inhalt innerhalb des
example-Tags ausgewählt.
{width="650"}
-
So konfigurieren Sie den Text im
example-Tag:- Navigieren Sie zu Inhaltseigenschaften.
- Fügen Sie das Attribut
outputclasshinzu. - Legen Sie den Wert auf
example eds-force-blockfest. - Wählen Sie Hinzufügen aus.
{width="650"}
-
Speichern und regenerieren Sie die Ausgabe.
-
Erstellen Sie einen neuen Ordner mit demselben Namen wie der
outputclassimblocks. Erfahren Sie mehr über Hinzufügen von Dateien zu einem Repository. {width="650"}
-
Fügen Sie die erforderlichen
cssund optionalejshinzu. {width="650"}
-
Änderungen übernehmen und Ausgabe neu generieren.
Der ausgewählte Inhalt zeigt jetzt die benutzerdefinierten Stile an, die in Ihrem Block definiert sind.