Utilizza l’interfaccia web GitHub per creare una pagina della documentazione di origine
Questo documento descrive come utilizzare l’interfaccia web GitHub per creare la documentazione e inviare una richiesta di pull (PR).
Configurare l’ambiente GitHub
Il primo passaggio nella configurazione dell'ambiente GitHub consiste nel passare all'archivio GitHub di Adobe Experience Platform.
Quindi, seleziona Fork.
Una volta completato il fork, seleziona master e immetti un nome per il nuovo ramo nel menu a discesa visualizzato. Assicurati di fornire un nome descrittivo per il ramo, in quanto verrà utilizzato per contenere il lavoro, quindi seleziona crea ramo.
Nella struttura di cartelle GitHub dell'archivio con fork, passa a experience-platform.en/help/sources/tutorials/api/create/ e seleziona la categoria appropriata per l'origine dall'elenco. Ad esempio, se stai creando la documentazione per una nuova origine CRM, seleziona crm.
experience-platform.en/help/sources/tutorials/ui/create/ e seleziona la categoria appropriata per la tua origine. Per aggiungere le immagini, passa a experience-platform.en/help/sources/images/tutorials/create/sdk e aggiungi le tue schermate alla cartella sdk.
Viene visualizzata una cartella delle origini CRM esistenti. Per aggiungere la documentazione per una nuova origine, selezionare Aggiungi file, quindi selezionare Crea nuovo file dal menu a discesa visualizzato.
Denomina il file di origine YOURSOURCE.md dove YOURSOURCE è il nome dell'origine in Platform. Ad esempio, se la società è ACME CRM, il nome file deve essere acme-crm.md.
Creare la pagina della documentazione per la sorgente
Per iniziare a documentare la nuova origine, incolla il contenuto del modello di documentazione origini nell'editor Web GitHub. Puoi scaricare il modello qui.
Con il modello copiato nell’interfaccia dell’editor web GitHub, segui le istruzioni descritte nel modello e modifica i valori contenenti le informazioni rilevanti per la tua origine.
Al termine, esegui il commit del file nel ramo.
Inviare la documentazione per la revisione
Una volta eseguito il commit del file, puoi aprire 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 stai lavorando sia selezionato, quindi seleziona Confronta e richiedi 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à aperta una PR per unire il ramo di lavoro nel ramo principale dell’archivio di Adobi.
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 la scheda delle richieste di pull in https://github.com/AdobeDocs/experience-platform.en.
