EXPERIENCE MANAGER GUIDES e EDGE DELIVERY SERVICES
Adobe Experience Manager Guides consente di pubblicare i contenuti DITA direttamente in Edge Delivery Services (EDS) tramite un profilo di pubblicazione dedicato basato su GitHub. Questa funzionalità consente alle organizzazioni di fornire esperienze di documentazione reattiva e a elevate prestazioni, mantenendo al contempo i flussi di lavoro di authoring basati su DITA in Experience Manager Guides.
Per ulteriori dettagli sull’utilizzo di EDS in Adobe Experience Manager, visualizzare Panoramica di Edge Delivery Services.
Per abilitare la pubblicazione da Experience Manager Guides a EDS, è necessario completare una serie di passaggi di configurazione in GitHub e Experience Manager Guides. Le sezioni seguenti descrivono ogni passaggio in sequenza e spiegano come interagiscono nel flusso di lavoro di pubblicazione complessivo.
Per una procedura dettagliata e rapida, visualizza Pubblicazione in AEM Guides.
Configurazione di GitHub per EDS
Questa sezione descrive come impostare e configurare GitHub per l’utilizzo con EDS. Include la creazione di un archivio utilizzando la piattaforma standard Adobe, la connessione di GitHub a Adobe Experience Manager tramite AEM Code Sync, la configurazione delle applicazioni GitHub e OAuth richieste e la definizione del punto di montaggio dell’archivio utilizzato per la pubblicazione dei contenuti.
Creare un archivio GitHub per EDS
EDS richiede un archivio GitHub con una struttura predefinita. Adobe fornisce un archivio standard ufficiale appositamente progettato per gli utenti di Experience Manager Guides.
Per creare l’archivio, effettua le seguenti operazioni:
-
Apri il repository dei modelli boilerplate di Experience Manager Guides aem-guides-boilerplate.
-
Crea un nuovo archivio utilizzando questo modello. Scopri come creare un archivio da un modello. Verificare che la visibilità dell’archivio sia impostata su Pubblico in modo che sia accessibile da EDS.
L’archivio viene ora creato e allineato con la struttura del modello standard.
Crea una nuova app OAuth
È necessaria un’app OAuth per autenticare gli utenti durante la creazione di un profilo di pubblicazione EDS in Experience Manager Guides. Abilita un flusso di accesso sicuro utilizzando un ID client e un Segreto client.
Per creare una nuova app OAuth, effettua le seguenti operazioni:
-
Su GitHub, passa alla barra laterale a sinistra e seleziona Impostazioni sviluppatore.
-
Nella barra laterale sinistra, seleziona App OAuth.
-
Seleziona Nuova app OAuth.
{width="650"}
-
Registra l’applicazione fornendo i seguenti dettagli obbligatori:
- Nome applicazione: immettere il nome dell’archivio EDS
- URL home page: immettere l’URL dell’istanza di Experience Manager Guides. Per il formato URL di esempio, fare riferimento al passaggio 4 della sezione Creare una nuova app GitHub.
- URL callback di autorizzazione: uguale all’URL della home page
-
Selezionare l’opzione Abilita flusso dispositivo, quindi selezionare Registra applicazione per completare la registrazione.
{width="650"}
L’app è ora pronta. Annota l’ID client. Puoi generare fino a cinque segreti client ora o in seguito durante la configurazione del profilo di pubblicazione in Experience Manager Guides.
Configurare l’URL del punto di montaggio nell’archivio EDS
EDS legge il contenuto da un URL mountpoint definito nel file fstab.yaml nella directory principale dell’archivio. Questo URL punta EDS al percorso in cui Experience Manager Guides pubblica il contenuto generato.
Per configurare l’URL del punto di attivazione nel file fstab.yaml:
-
Nell’archivio GitHub, apri il file
fstab.yaml. -
Aggiorna il valore
urlutilizzando il seguente formato:code language-text https://guides.adobe.com/eds-workers/<account type>/<git acc domain>/<git username>/<git repo>/<branch>/<root folder>La tabella seguente descrive ogni campo nell’URL:
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 Campo Descrizione https://guides.adobe.com/eds-workersURL di lavoro utilizzato da Experience Manager Guides per pubblicare i contenuti su EDS. Non modificare questo valore. <account type>Tipo di account Git. Imposta su github.<git acc domain>Dominio dell’account Git. Imposta su github.com.<git username>Nome utente GitHub. <git repo>Nome dell’archivio GitHub creato per EDS. <branch>Ramo in cui desideri pubblicare il contenuto. Il valore predefinito è main. Se modifichi il nome del ramo su GitHub, aggiornalo qui e nel profilo di pubblicazione EDS in Experience Manager Guides.<root folder>Cartella principale dell’archivio in cui viene eseguito il commit dei file pubblicati. Il valore predefinito è docs. Se modifichi il nome della cartella su GitHub, aggiornalo qui e nel profilo di pubblicazione EDS in Experience Manager Guides.Ad esempio, se il nome utente GitHub è
my-usernamee il nome dell’archivio èmy-eds-repo, il filefstab.yamlverrà visualizzato come segue: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 Se si continua a utilizzare il formato URL precedente ( https://guides.adobe.com/eds-workers/<git username>/<git repo>/<branch>/<root folder>), il tipo di account e il dominio predefiniti sarannogithubegithub.com. -
Ripeti i passaggi 2 e 3 dalla sezione Connetti GitHub ad Adobe tramite AEM Code Sync per autorizzare l’archivio.
Collegare GitHub ad Adobe tramite AEM Code Sync
Adobe Experience Manager utilizza un’applicazione GitHub denominata AEM Code Sync per inviare contenuti da Experience Manager Guides a GitHub.
Per installare e configurare l’applicazione AEM Code Sync, eseguire la procedura seguente:
-
Passare alla pagina Sincronizzazione codice AEM e selezionare Installa.
AEM Code Sync monitora le modifiche all’archivio e assicura che gli aggiornamenti vengano inviati correttamente a GitHub.
note NOTE Durante l’installazione dell’applicazione, assicurati di utilizzare lo stesso account GitHub a cui appartiene l’archivio.
-
Nella pagina successiva, concedi l’accesso all’archivio creato. Seleziona Solo repository, quindi seleziona il tuo archivio dal menu a discesa.
{width="350"}
-
Selezionare Installa e autorizza.
Viene visualizzata la pagina di configurazione di GitHub.
-
Rivedi i dettagli del codice sorgente e seleziona Avanti.
-
Nella pagina Origine contenuto configurare le impostazioni seguenti:
- Tipo di origine del contenuto: Seleziona Altro (inserisci il tuo markup).
- URL origine contenuto: Verificare l’URL configurato come URL punto di montaggio nel file
fstab.yaml. Se non hai aggiornato l’URL nel file, puoi aggiornarlo qui. - Estensione file: Modificare il suffisso predefinito
.htmlin.htm.
Assicurarsi che sia selezionato Usa un’origine di contenuto diversa.
-
Nella pagina Utenti, aggiungi gli utenti se necessario e seleziona Avanti.
-
Rivedi il riepilogo della configurazione e seleziona Salva.
Dopo la registrazione, viene visualizzata una pagina di conferma. Puoi copiare e salvare gli URL Anteprima e Live per il tuo sito Web da questa pagina.
Configurazione di GitLab per EDS
Per istruzioni sulla configurazione di GitLab come archivio di pubblicazione per Edge Delivery Services, visualizzare Configurare GitLab per EDS.
Creare e configurare un profilo di pubblicazione per EDS in Experience Manager
Le sezioni seguenti descrivono ogni passaggio in sequenza e spiegano come impostare il profilo di pubblicazione EDS, configurare un predefinito di output e generare l’output utilizzando EDS in Experience Manager Guides.
Creare il profilo di pubblicazione EDS per GitHub o GitLab
-
Vai a Impostazioni Workspace > Pubblica profili.
-
Seleziona l’icona + per creare un nuovo profilo di pubblicazione e fornisci i seguenti dettagli:
-
Tipo di server*: Seleziona Git (Edge Delivery Service) dal menu a discesa.
-
Nome*: Immettere un nome per il profilo di pubblicazione.
-
Tipo di account Git*: Seleziona GitHub o GitLab dal menu a discesa, a seconda del provider dell’archivio Git.
-
URL istanza*: Inserisci l’URL dell’istanza GitHub o GitLab, ad esempio
https://github.comohttps://gitlab.com. -
Nome archivio*: Inserisci il nome dell’archivio GitHub o GitLab.
-
Nome utente*: Inserisci il nome utente GitHub o GitLab.
-
Nome ramo: Impostato su
main(impostazione predefinita). -
Cartella principale*: Impostata su
docs(impostazione predefinita). -
Proprietario sito (Solo GitLab): Immettere il proprietario del sito Edge Delivery Services.
-
Archivio sito (Solo GitLab): Immettere il nome dell’archivio associato al sito Edge Delivery Services.
-
Chiave API HLX: Immettere la chiave API HLX per la configurazione EDS. Questa chiave è necessaria per supportare la funzione Non pubblicato introdotta nella versione 2026.11.0 di Experience Manager Guides as a Cloud Service. Inoltre, la chiave è necessaria per pubblicare il contenuto in EDS se la dimensione del contenuto è superiore a 100 file.
-
Credenziali di autenticazione: Specificare le credenziali in base al tipo di account Git selezionato:
- GitHub: Immetti l’ID client* e il Segreto client* ottenuti dall’app OAuth GitHub. Per ulteriori informazioni, consulta Creare una nuova app OAuth.
- GitLab: Immetti il token di accesso* generato per l’account GitLab.
-
-
(Solo GitHub) Seleziona Accesso per eseguire l’autenticazione. Per GitLab, non è necessario alcun accesso perché il token di accesso viene utilizzato per l’autenticazione.
{width="650"}
-
Seleziona Salva. Per GitHub, l’opzione Salva è disponibile dopo la corretta autenticazione.
Il profilo di pubblicazione EDS è ora configurato.
Creare un predefinito di output per EDS e generare un output
-
Apri la mappa nella console Mappa.
-
Nella scheda Predefiniti di output, selezionare + per creare un nuovo predefinito di output.
-
Nella finestra di dialogo Nuovo predefinito di output, fornisci i seguenti dettagli:
- Tipo: Seleziona Servizio Edge Delivery
- Nome: specifica un nome per questo predefinito
-
Seleziona Aggiungi.
{width="650"}
-
Apri il predefinito di output EDS appena creato e configura i campi seguenti:
-
Filtro condizionale: Seleziona Nessuno per generare l’output senza filtri o Utilizza DITAVAL per applicare il filtro condizionale.
-
Sottocartella di pubblicazione: Immettere il nome della sottocartella in cui viene pubblicato l’output. La sottocartella viene creata nel repository sotto la cartella principale e il suo nome viene visualizzato nei collegamenti EDS al contenuto pubblicato. Ad esempio, se la cartella principale è
docse la sottocartella di pubblicazione èproduct-guide, il contenuto verrà pubblicato indocs/contents/product-guide. -
Profilo di pubblicazione: Seleziona il profilo di pubblicazione GitHub o GitLab configurato nella sezione precedente.
{width="650"}
-
-
Selezionare Salva, quindi Genera output.
<root folder>/contents/<publish subfolder> dell'archivio EDS.L’output EDS viene ora generato. Il contenuto viene presentato in un layout pulito e reattivo. Include elementi regolari come il titolo della pagina, le breadcrumb, il contenuto del corpo e tutti i blocchi utilizzati nell’argomento. Il sommario a sinistra (generato dalla mappa) consente di navigare tra gli argomenti, mentre un mini-sommario a destra evidenzia le sezioni all’interno della pagina corrente. L’intero output è completamente reattivo, garantendo un’esperienza di lettura ottimizzata e coerente tra i dispositivi.
Personalizzare l’output utilizzando i blocchi EDS
EDS utilizza blocks per controllare lo stile e la visualizzazione delle diverse parti del contenuto. Puoi modificare i blocchi esistenti o crearne di personalizzati.
Gli esempi descritti di seguito descrivono come personalizzare un blocco esistente e crearne uno nuovo per applicare uno stile all’output finale EDS in Experience Manager Guides.
Personalizzare un blocco di breadcrumb per aggiornarne il colore del testo
Le breadcrumb vengono utilizzate in più pagine per aiutare gli utenti a capire dove si trovano nella documentazione. Poiché questo blocco viene visualizzato in modo coerente in tutto il sito web, l’aggiornamento dello stile consente un aggiornamento unificato del design.
Per personalizzare un blocco di breadcrumb per aggiornarne il colore del testo, effettua le seguenti operazioni:
-
Vai all’archivio GitHub e apri la cartella
blocks. -
Seleziona il blocco breadcrumb.
{width="650"}
-
Aprire il file
csse aggiornare il colore del testo. -
Apporta le modifiche a GitHub.
-
Aggiorna il sito web live per visualizzare gli aggiornamenti.
Aggiornare gli script EDS per creare un elemento personalizzato nell’output pubblicato
In alcuni casi, potrebbe essere utile applicare uno stile solo a una parte specifica del contenuto. Per ottenere questo risultato, esegui i seguenti passaggi utilizzando un blocco personalizzato.
-
Aprire il file dell’argomento e selezionare il testo all’interno di un elemento tag.
Nella schermata seguente, il contenuto all’interno del tag
exampleè selezionato.
{width="650"}
-
Per configurare il testo all’interno del tag
example:- Passa a Proprietà contenuto.
- Aggiungi l’attributo
outputclass. - Imposta il relativo valore su
example eds-force-block. - Seleziona Aggiungi.
{width="650"}
-
Salvate e rigenerate l’output.
-
Creare una nuova cartella con lo stesso nome di
outputclassnella directoryblocks. Scopri come aggiungere file a un repository. {width="650"}
-
Aggiungere i file richiesti
csse facoltativijs. {width="650"}
-
Eseguire il commit delle modifiche e rigenerare l’output.
Il contenuto selezionato ora visualizza lo stile personalizzato definito nel blocco.