Utilizza un editor di testo nel tuo ambiente locale per creare una pagina di documentazione di destinazione

Le istruzioni presenti in questa pagina mostrano come utilizzare un editor di testo per lavorare nel proprio ambiente locale per creare la documentazione e inviare una richiesta di pull (PR). Prima di eseguire i passaggi qui indicati, leggi Documentare la destinazione in Adobe Experience Platform Destinations.

Connettersi a GitHub e configurare l’ambiente di authoring locale

  1. Nel browser, passa a https://github.com/AdobeDocs/experience-platform.en

  2. Per fork l'archivio, fai clic su Fork come mostrato di seguito. In questo modo viene creata una copia dell’archivio Experience Platform nel tuo account GitHub.

    Archivio della documentazione di Adobe fork

  3. Clonare l’archivio sul computer locale. Seleziona Codice > HTTPS > Apri con GitHub Desktop, come mostrato di seguito. Assicurati di aver installato GitHub Desktop. Per ulteriori riferimenti, consulta Creare un clone locale dell’archivio nella guida per i collaboratori di Adobe .

    Clona l’archivio della documentazione di Adobe in ambiente locale

  4. Nella struttura del file locale, passa a experience-platform.en/help/destinations/catalog/[...], dove [...] è la categoria desiderata per la destinazione. Ad Experience Platform, se aggiungi una destinazione di personalizzazione, seleziona la cartella personalization .

Creare la pagina della documentazione per la destinazione

  1. La pagina della documentazione si basa sul modello di destinazione self-service. Scarica il modello di destinazione. Decomprimetela ed estraete il file yourdestination-template.md nella directory indicata al punto 4. Rinomina il file YOURDESTINATION.md, dove YOURDESTINATION è il nome della destinazione in Adobe Experience Platform. Ad esempio, se l’azienda si chiama Moviestar, devi assegnare un nome al file moviestar.md.
  2. Apri il nuovo file nell' editor di testo selezionato. Adobe consiglia di utilizzare Codice di Visual Studio e installare l'estensione Adobe Markdown Authoring. Per installare l'estensione, apri Codice di Visual Studio, seleziona la scheda Extensions a sinistra dello schermo e cerca adobe markdown authoring. Seleziona l’estensione e fai clic su Install.
    Installare l’estensione Adobe Markdown Authoring
  3. Modifica il modello con le informazioni rilevanti per la destinazione. Segui le istruzioni contenute nel modello .
  4. Per tutte le schermate o immagini che intendi aggiungere alla documentazione, passa a GitHub/experience-platform.en/help/destinations/assets/catalog/[...], dove [...] è la categoria desiderata per la destinazione. Ad Experience Platform, se aggiungi una destinazione di personalizzazione, seleziona la cartella personalization . Crea una nuova cartella per la tua destinazione e salva le immagini qui. Devi effettuare un collegamento a tali elementi dalla pagina che stai creando. Consulta istruzioni su come collegare immagini.
  5. Quando sei pronto, salva il file su cui stai lavorando.

Invia la documentazione per la revisione

SUGGERIMENTO

Notate che non c'è niente che potete rompere qui. Seguendo le istruzioni contenute in questa sezione, ti consigliamo semplicemente un aggiornamento della documentazione. L’aggiornamento consigliato verrà approvato o modificato dal team di documentazione di Adobe Experience Platform.

  1. In GitHub Desktop, crea un ramo di lavoro per gli aggiornamenti e seleziona Pubblica ramo per pubblicare il ramo in GitHub.

Nuovo ramo locale

  1. In GitHub Desktop, esegui il commit del tuo lavoro, come mostrato di seguito.

    Conferma locale

  2. In GitHub Desktop, invia il lavoro al ramo remoto, come mostrato di seguito.

    Spingi il tuo commit

  3. Nell’interfaccia web GitHub, apri una richiesta di pull (PR) per unire il ramo di lavoro al ramo principale dell’archivio della documentazione di Adobe. Assicurati che il ramo su cui hai lavorato sia selezionato e seleziona Contribute > Apri richiesta di pull.

    Creare una richiesta di pull

  4. Assicurati che i rami di base e di confronto siano corretti. Aggiungi una nota alla PR, descrivendo l'aggiornamento, e seleziona Crea richiesta di pull. Viene aperto un PR per unire il ramo di lavoro del fork nel ramo principale dell’archivio Adobe.

    SUGGERIMENTO

    Lascia selezionata la casella di controllo Consenti modifiche da parte dei manutentori in modo che il team della documentazione di Adobe possa apportare modifiche alla PR.

    Creare una richiesta di pull all’archivio della documentazione di Adobe

  5. A questo punto, viene visualizzata una notifica che richiede la firma del contratto di licenza da collaboratore (CLA) Adobe. Si tratta di un passaggio obbligatorio. Dopo aver firmato il Contratto di licenza da collaboratore, aggiorna la pagina PR e invia la richiesta di pull.

  6. Puoi confermare che la richiesta di pull è stata inviata controllando la scheda Richieste di pull in https://github.com/AdobeDocs/experience-platform.en.

PR riuscito

  1. Grazie. Il team di documentazione di Adobe contatterà la PR nel caso siano necessarie modifiche e per informarti quando verrà pubblicata la documentazione.
SUGGERIMENTO

Per aggiungere immagini e collegamenti alla documentazione e per qualsiasi altra domanda su Markdown, leggi Utilizzo di Markdown nella guida collaborativa alla scrittura di Adobe.

In questa pagina