Utilizza un editor di testo nell’ambiente locale per creare una pagina della documentazione delle sorgenti
Questo documento descrive come utilizzare l’ambiente locale per creare la documentazione per la tua origine e inviare una richiesta di pull (PR).
Prerequisiti
Il seguente tutorial richiede che GitHub Desktop sia installato sul computer locale. Se non disponi di GitHub Desktop, puoi scaricare l'applicazione qui.
Connessione a GitHub e configurazione dell’ambiente di authoring locale
Il primo passaggio nella configurazione dell'ambiente di authoring locale consiste nel passare all'archivio GitHub di Adobe Experience Platform.
Nella pagina principale dell'archivio GitHub di Experience Platform, seleziona Fork.
Per clonare l'archivio nel computer locale, selezionare Codice. Dal menu a discesa visualizzato, selezionare HTTPS e quindi Apri con GitHub Desktop.
Attendere qualche istante, quindi, per consentire a GitHub Desktop di clonare l'archivio experience-platform.en.
Una volta completato il processo di clonazione, passa a GitHub Desktop per creare un nuovo ramo. Seleziona Master dalla navigazione superiore, quindi seleziona Nuovo ramo
Nel pannello popover visualizzato, immettere un nome descrittivo per il ramo, quindi selezionare Crea ramo.
Selezionare Pubblica ramo.
Creare la pagina della documentazione per la sorgente
Dopo aver clonato l'archivio nel computer locale e creato un nuovo ramo, è ora possibile iniziare a creare la pagina della documentazione per la nuova origine tramite l'editor di testo desiderato.
Adobe consiglia di utilizzare Visual Studio Code e di installare l'estensione Adobe Markdown Authoring. Per installare l'estensione, avviare Visual Studio Code, quindi selezionare la scheda Estensioni dal menu di navigazione a sinistra.
Immettere Adobe Markdown Authoring nella barra di ricerca, quindi selezionare Installa dalla pagina visualizzata.
Quando il computer locale è pronto, scarica il modello di documentazione sources ed estrai il file in experience-platform.en/help/sources/tutorials/api/create/... con [...] che rappresenta la categoria desiderata. Se ad esempio si sta creando un'origine di database, selezionare la cartella del database.
Infine, segui le istruzioni descritte nel modello e modifica il modello con le informazioni pertinenti relative alla tua origine.
Inviare la documentazione per la revisione
Per creare una richiesta di pull (PR) e inviare la documentazione per la revisione, salvare innanzitutto il lavoro in Visual Studio Code (o nell'editor di testo scelto). Quindi, utilizzando GitHub Desktop, immetti un messaggio di commit e seleziona Commit to create-source-documentation.
Quindi, seleziona Invia origine per caricare il lavoro nel ramo remoto.
Per creare una richiesta pull, selezionare Crea richiesta pull.
Assicurati che i rami di base e di confronto siano corretti. Aggiungi una nota alla PR, descrivendo l'aggiornamento, quindi seleziona Crea richiesta di pull. Verrà aperto un PR per unire il ramo di lavoro nel ramo principale dell’archivio Adobe.
Puoi confermare che la richiesta di pull è stata inviata esaminando la scheda delle richieste di pull in https://github.com/AdobeDocs/experience-platform.en.
