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.

Estensione

Immettere Adobe Markdown Authoring nella barra di ricerca, quindi selezionare Installa dalla pagina visualizzata.

installa

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.

modifica-modello

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.

commit-vs

Quindi, seleziona Invia origine per caricare il lavoro nel ramo remoto.

push-origin

Per creare una richiesta pull, selezionare Crea richiesta 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 Crea richiesta di pull. Verrà aperto un PR per unire il ramo di lavoro nel ramo principale dell’archivio Adobe.

SUGGERIMENTO
Lascia selezionata la casella di controllo Consenti modifiche da parte dei responsabili della manutenzione per garantire che il team di documentazione di 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