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).

TIP
Följande dokument från Adobe medverkande kan användas som ytterligare stöd för din dokumentationsprocess:

Konfigurera GitHub-miljön

Det första steget i att konfigurera GitHub-miljön är att navigera till Adobe Experience Platform GitHub-databas.

platform-repo

Nästa, välj Gaffel.

gaffel

När gaffeln är klar väljer du master och ange ett namn för den nya grenen i listrutan som visas. Ange ett beskrivande namn för din gren eftersom den används för att innehålla ditt arbete och välj sedan skapa gren.

create-branch

Navigera till mappstrukturen GitHub i den förankrade databasen. experience-platform.en/help/sources/tutorials/api/create/ 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.

TIP
Om du skapar dokumentation för gränssnittet går du till experience-platform.en/help/sources/tutorials/ui/create/ och väljer lämplig kategori för källan. Om du vill lägga till bilder går du till experience-platform.en/help/sources/images/tutorials/create/sdk lägg sedan till skärmbilderna i sdk mapp.

crm

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.

create-new-file

Namnge källfilen 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.

git-interface

Skriv dokumentationssidan för källan

Om du vill börja dokumentera den nya källan klistrar du in innehållet i dokumentationsmall för källor till 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.

paste-template

När du är klar implementerar du filen i din gren.

bekräfta

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 & dra-begäran.

compare-pr

Kontrollera att bas- och jämförelsegrenarna är korrekta. Lägg till en anteckning i PR-rapporten 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.

TIP
Lämna Tillåt redigeringar av underhållare kryssrutan markerad för att säkerställa att dokumentationsteamet på Adobe kan göra ändringar i PR.

create-pr

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.

confirm-pr

recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089