Documentare l’origine (Streaming SDK)

Ultimo aggiornamento: 16 luglio 2024

Argomenti:

Creato per:

Sviluppatore

NOTE

L’SDK di streaming per origini self-service è in versione beta. Per ulteriori informazioni sull'utilizzo di origini con etichetta beta, leggere la panoramica delle origini.

L’ultimo passaggio prima che la nuova origine possa essere impostata live in Adobe Experience Platform è documentare la nuova origine.

Questa guida alla documentazione include:

Un tutorial che puoi seguire per creare una pagina di documentazione per la nuova sorgente;
Un modello di documentazione da compilare per la nuova sorgente;
Istruzioni sull'utilizzo di Markdown per la scrittura della documentazione tecnica;
Istruzioni su come comprendere il sapore Adobe Markdown.

Prerequisiti

Prima di iniziare a documentare la nuova origine, sono necessari i seguenti elementi:

Un account utente GitHub valido: se non disponi di un account GitHub esistente, devi crearne uno tramite la pagina di iscrizione a GitHub;
Accesso a GitHub Desktop: è necessario utilizzare l'app desktop GitHub per creare la documentazione di origine nell'ambiente locale;
L’integrazione con Adobe deve essere in una fase di test con l’origine implementata in un ambiente di staging in Platform.

Istruzioni di alto livello per creare la documentazione per l’origine in Platform

Ad alto livello, per creare la documentazione per la tua origine, devi creare un fork dell’archivio della documentazione di Platform e modificare il modello di documentazione fornito in un nuovo ramo. Utilizza il modello fornito dall’Adobe per creare una nuova pagina sorgente e aprire una richiesta di pull (PR) quando è il momento. Le istruzioni per eseguire questa operazione sono riportate di seguito, nei passaggi per creare la nuova pagina sorgente.

Modello di documentazione

Puoi utilizzare un modello di documentazione API precompilato o il modello di documentazione dell'interfaccia utente per facilitare la creazione della documentazione per la tua origine. Più avanti, puoi trovare istruzioni su come modificare il modello e aprire una richiesta di pull. La documentazione inviata per la nuova origine verrà rivista e pubblicata dal team di documentazione di Adobe.

Puoi scaricare i modelli di documentazione riportati di seguito:

Crea la nuova pagina sorgente

Puoi utilizzare l’interfaccia web GitHub o l’ambiente locale per creare la documentazione per la nuova origine in Platform. Per istruzioni su entrambe le opzioni, consulta i collegamenti seguenti:

recommendation-more-help