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).

TIP
I seguenti documenti della guida introduttiva di Adobe possono essere utilizzati per supportare ulteriormente la procedura di documentazione:

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 alla Archivio GitHub Adobe Experience Platform.

platform-repo

Nella pagina principale dell’archivio GitHub di Platform, seleziona Fork.

fork

Per clonare l’archivio sul computer locale, seleziona Codice. Dal menu a discesa visualizzato, seleziona HTTPS quindi, seleziona Apri con GitHub Desktop.

TIP
Per ulteriori informazioni, consulta l’esercitazione su configurazione locale dell’archivio Git per la documentazione.

open-git-desktop

Quindi, attendi alcuni istanti prima che GitHub Desktop cloni il experience-platform.en archivio.

clonazione

Una volta completato il processo di clonazione, passa a GitHub Desktop per creare un nuovo ramo. Seleziona Principale dalla navigazione in alto, quindi seleziona Nuovo ramo

new-branch

Nel pannello a comparsa visualizzato, immetti un nome descrittivo per il ramo, quindi seleziona Crea ramo.

create-branch-vs

Quindi, seleziona Pubblica ramo.

publish-branch

Creare la pagina della documentazione per la sorgente

Dopo aver clonato l’archivio nel computer locale e creato un nuovo ramo, puoi iniziare a creare la pagina della documentazione per la nuova origine tramite editor di testo desiderato.

L’Adobe consiglia di utilizzare Codice di Visual Studio e installare l’estensione Adobe Markdown Authoring. Per installare l'estensione, avviare Visual Studio Code, quindi selezionare Estensioni dal menu di navigazione a sinistra.

Estensione

Quindi, immetti Adobe Markdown Authoring nella barra di ricerca, quindi seleziona Installa dalla pagina visualizzata.

installare

Quando il computer locale è pronto, scarica il modello di documentazione delle sorgenti ed estrarre il file in experience-platform.en/help/sources/tutorials/api/create/... con [...] rappresenta la categoria scelta. 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.

edit-template

Inviare la documentazione per la revisione

Per creare una richiesta di pull (PR) e inviare la documentazione per la revisione, salva il lavoro in Visual Studio Code (o l’editor di testo scelto). Quindi, utilizzando GitHub Desktop, immetti un messaggio di commit e seleziona Conferma creazione-origine-documentazione.

commit-vs

Quindi, seleziona Origine push per caricare il lavoro nel ramo remoto.

push-origin

Per creare una richiesta di pull, seleziona Crea richiesta di pull.

create-pr-vs

Assicurati che i rami di base e di confronto siano corretti. Aggiungi una nota alla PR, descrivendo l’aggiornamento, quindi seleziona Creare una richiesta di pull. Verrà aperta una PR per unire il ramo di lavoro nel ramo principale dell’archivio di Adobi.

TIP
Lascia Consenti modifiche da parte dei gestori è stata selezionata una casella di controllo per garantire che il team della documentazione Adobe possa apportare modifiche alla PR.

create-pr

Puoi confermare che la richiesta di pull è stata inviata esaminando la scheda delle richieste di pull in https://github.com/AdobeDocs/experience-platform.en.

confirm-pr

recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089