Skapa en källdokumentationssida med GitHub-webbgränssnittet
Det här dokumentet innehåller anvisningar om hur du använder GitHub-webbgränssnittet för att skapa dokumentation och skicka en pull-begäran (PR).
Konfigurera GitHub-miljön
Det första steget för att konfigurera GitHub-miljön är att navigera till Adobe Experience Platform GitHub-databasen.
Välj sedan Förgrening.
När gaffeln är klar väljer du master och anger ett namn för den nya grenen i listrutan som visas. Se till att du anger ett beskrivande namn för din gren eftersom det används för ditt arbete och välj sedan Skapa gren.
Navigera till experience-platform.en/help/sources/tutorials/api/create/ i mappstrukturen för GitHub i den förankrade databasen och välj sedan lämplig kategori för källan i listan. Om du till exempel skapar dokumentation för en ny CRM-källa väljer du crm.
experience-platform.en/help/sources/tutorials/ui/create/ och väljer lämplig kategori för källan. Om du vill lägga till dina bilder går du till experience-platform.en/help/sources/images/tutorials/create/sdk och lägger sedan till skärmbilderna i mappen sdk.
En mapp med befintliga CRM-källor visas. Om du vill lägga till dokumentation för en ny källa väljer du Lägg till fil och sedan Skapa ny fil i listrutan som visas.
Ge källfilen namnet YOURSOURCE.md där YOURSOURCE är namnet på källan i Platform. Om ditt företag till exempel är ACME CRM ska ditt filnamn vara acme-crm.md.
Skriv dokumentationssidan för källan
Om du vill börja dokumentera den nya källan klistrar du in innehållet i dokumentationsmallen för källor i GitHub-webbredigeraren. Du kan även hämta mallen här.
När mallen har kopierats till GitHub-webbredigeringsgränssnittet följer du instruktionerna som beskrivs i mallen och redigerar värdena som innehåller relevant information för källan.
När du är klar implementerar du filen i din gren.
Skicka in din dokumentation för granskning
När filen har implementerats kan du öppna en pull-begäran (PR) för att sammanfoga din arbetsgren med huvudgrenen i dokumentationsdatabasen för Adobe. Kontrollera att grenen du har arbetat med är markerad och välj sedan Jämför och dra in-begäran.
Kontrollera att bas- och jämförelsegrenarna är korrekta. Lägg till en anteckning i PR, som beskriver uppdateringen och välj sedan Skapa pull-begäran. Då öppnas en PR för att sammanfoga arbetsgrenen i ditt arbete med huvudgrenen i Adobe-databasen.
Nu visas ett meddelande som uppmanar dig att signera Adobe Contributor License Agreement (CLA). Detta är ett obligatoriskt steg. När du har signerat CLA-avtalet uppdaterar du PR-sidan och skickar pull-begäran.
Du kan bekräfta att pull-begäran har skickats genom att granska mottagarfliken i https://github.com/AdobeDocs/experience-platform.en.
