Utilizza un editor di testo nell’ambiente locale per creare una pagina della documentazione di destinazione local-authoring
Le istruzioni in questa pagina mostrano come utilizzare un editor di testo per lavorare nell’ambiente locale per creare la documentazione e inviare una richiesta di pull (PR). Prima di eseguire i passaggi qui indicati, assicurati di leggere Documentare la destinazione in Destinazioni Adobe Experience Platform.
Connessione a GitHub e configurazione dell’ambiente di authoring locale set-up-environment
-
Nel browser, passa a
https://github.com/AdobeDocs/experience-platform.en
-
A fork nell’archivio, fai clic su Fork come mostrato di seguito. In questo modo viene creata una copia dell’archivio di Experienci Platform nel tuo account GitHub.
-
Clonare l’archivio sul computer locale. Seleziona Codice > HTTPS > Apri con desktop GitHub, come illustrato di seguito. Assicurati di avere Desktop GitHub installato. Per ulteriori informazioni, leggere Creare un clone locale dell’archivio nella guida per i collaboratori Adobe.
-
Nella struttura del file locale, passa a
experience-platform.en/help/destinations/catalog/[...]
, dove[...]
è la categoria desiderata per la destinazione. Ad Experience Platform, se stai aggiungendo una destinazione di personalizzazione a, seleziona lapersonalization
cartella.
Creare la pagina della documentazione per la destinazione author-documentation
- La pagina della documentazione si basa su modello di destinazione self-service. Scarica il file modello di destinazione. Decomprimi ed estrai il file
yourdestination-template.md
nella directory indicata al punto 4. Rinomina il fileYOURDESTINATION.md
, dove YOURDESTINATION è il nome della destinazione in Adobe Experience Platform. Ad esempio, se la tua società si chiama Moviestar, dovrai denominare il filemoviestar.md
. - Apri il nuovo file nel tuo editor di testo preferito. L’Adobe consiglia di utilizzare Codice di Visual Studio e installa l’estensione Adobe Markdown Authoring. Per installare l'estensione, aprire Visual Studio Code, selezionare Extensions sulla sinistra dello schermo e cerca
adobe markdown authoring
. Seleziona l’estensione e fai clic su Install.
- Modifica il modello con le informazioni rilevanti per la destinazione. Segui le istruzioni nel modello.
- Per le schermate o le immagini da aggiungere alla documentazione, vai a
GitHub/experience-platform.en/help/destinations/assets/catalog/[...]
, dove[...]
è la categoria desiderata per la destinazione. Ad Experience Platform, se stai aggiungendo una destinazione di personalizzazione a, seleziona lapersonalization
cartella. Crea una nuova cartella per la destinazione e salva qui le immagini. Devi creare un collegamento a tali elementi dalla pagina in cui vengono creati. Consulta istruzioni su come collegare le immagini. - Quando si è pronti, salvare il file su cui si sta lavorando.
Inviare la documentazione per la revisione submit-review
- In GitHub Desktop, crea un ramo di lavoro per gli aggiornamenti e seleziona Pubblica ramo per pubblicare il ramo su GitHub.
-
Nel desktop GitHub, commit il tuo lavoro, come illustrato di seguito.
-
Nel desktop GitHub, push il tuo lavoro per remoto come mostrato di seguito.
-
Nell’interfaccia web GitHub, apri una richiesta di pull (PR) per unire il ramo di lavoro nel ramo principale dell’archivio della documentazione di Adobe. Assicurati che il ramo su cui hai lavorato sia selezionato e seleziona Contribute > Apri richiesta pull.
-
Assicurati che i rami di base e di confronto siano corretti. Aggiungi una nota alla PR, descrivendo l’aggiornamento, e seleziona Creare una richiesta di pull. Viene aperto un PR per unire il ramo di lavoro del fork nel ramo principale dell’archivio di Adobi.
note tip TIP Lascia Consenti modifiche da parte dei gestori è stata selezionata una casella di controllo che consente al team della documentazione di Adobe di apportare modifiche alla PR. -
A questo punto, viene visualizzata una notifica che richiede di firmare il Contratto di licenza da collaboratore (CLA) di Adobe. Questo è un passaggio obbligatorio. Dopo aver firmato il contratto di licenza, aggiorna la pagina PR e invia la richiesta di pull.
-
Puoi confermare che la richiesta di pull è stata inviata esaminando Richieste pull scheda in
https://github.com/AdobeDocs/experience-platform.en
.
- Grazie. Il team di documentazione di Adobe si rivolgerà al PR nel caso siano necessarie modifiche e ti informerà di quando la documentazione verrà pubblicata.