Utilizza l’interfaccia web GitHub per creare una pagina della documentazione di origine

Ultimo aggiornamento: 2023-11-01
  • Argomenti:
  • Sources
    Visualizza ulteriori informazioni su questo argomento
  • Creato per:
  • Developer

Questo documento descrive come utilizzare l’interfaccia web GitHub per creare la documentazione e inviare una richiesta di pull (PR).

SUGGERIMENTO

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

Configurare l’ambiente GitHub

Il primo passaggio nella configurazione dell’ambiente GitHub consiste nel passare alla Archivio GitHub Adobe Experience Platform.

platform-repo

Quindi, seleziona Fork.

fork

Una volta che il fork è completo, seleziona principale e inserisci 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.

create-branch

Nella struttura di cartelle GitHub dell’archivio con fork, passa a experience-platform.en/help/sources/tutorials/api/create/ quindi selezionare la categoria appropriata per l'origine dall'elenco. Ad esempio, se stai creando la documentazione per una nuova origine CRM, seleziona crm.

SUGGERIMENTO

Se stai creando la documentazione per l’interfaccia utente, passa a experience-platform.en/help/sources/tutorials/ui/create/ e seleziona la categoria appropriata per la tua origine. Per aggiungere le immagini, vai a experience-platform.en/help/sources/images/tutorials/create/sdk quindi aggiungi le tue schermate al sdk cartella.

crm

Viene visualizzata una cartella delle origini CRM esistenti. Per aggiungere la documentazione per una nuova origine, seleziona Aggiungi file e quindi seleziona Crea nuovo file dal menu a discesa visualizzato.

create-new-file

Denomina il file di origine YOURSOURCE.md dove YOURSOURCE è il nome della sorgente in Platform. Ad esempio, se la tua società è ACME CRM, il nome file deve essere acme-crm.md.

git-interface

Creare la pagina della documentazione per la sorgente

Per iniziare a documentare la nuova origine, incolla il contenuto della modello di documentazione delle sorgenti nell’editor web GitHub. Puoi anche 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.

incolla-modello

Al termine, esegui il commit del file nel ramo.

commit

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.

compare-pr

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.

SUGGERIMENTO

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

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.

confirm-pr

In questa pagina