Använda en textredigerare i den lokala miljön för att skapa en källdokumentationssida

Det här dokumentet innehåller anvisningar om hur du använder din lokala miljö för att skapa dokumentation för källan 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:

Förutsättningar

I följande självstudie måste du ha installerat GitHub Desktop på din lokala dator. Om du inte har GitHub Desktop kan du hämta programmet här.

Anslut till GitHub och konfigurera din lokala redigeringsmiljö

Det första steget i att konfigurera din lokala redigeringsmiljö är att navigera till Adobe Experience Platform GitHub-databas.

platform-repo

På huvudsidan i GitHub-databasen väljer du Gaffel.

gaffel

Om du vill klona databasen till din lokala dator väljer du Code. I listrutan som visas väljer du HTTPS och sedan väljer Öppna med GitHub Desktop.

TIP
Mer information finns i självstudiekursen om konfigurera Git-databasen lokalt för dokumentation.

open-git-desktop

Låt sedan GitHub Desktop klona experience-platform.en databas.

kloning

När kloningsprocessen är klar går du till GitHub Desktop och skapar en ny gren. Välj Master i den övre navigeringen och välj Ny gren

ny gren

Ange ett beskrivande namn för din gren på pover-panelen som visas och välj sedan Skapa gren.

create-branch-vs

Nästa, välj Publicera gren.

publish-branch

Skriv dokumentationssidan för källan

När databasen är klonad till din lokala dator och en ny gren skapas kan du nu börja skapa dokumentationssidan för den nya källan via valfri textredigerare.

Adobe rekommenderar att du använder Visual Studio Code och att du installerar tillägget för redigering av Adobe Markdown. Starta Visual Studio Code och välj sedan Tillägg från vänster navigering.

extension

Nästa, ange Adobe Markdown Authoring i sökfältet och välj Installera från sidan som visas.

installera

Ladda ned dokumentationsmall för källor och extrahera filen till experience-platform.en/help/sources/tutorials/api/create/... med [...] som representerar den kategori som du väljer. Om du t.ex. skapar en datakälla väljer du databasmappen.

Till sist följer du instruktionerna i mallen och redigerar mallen med relevant information om källan.

edit-template

Skicka in din dokumentation för granskning

Om du vill skapa en pull-begäran (PR) och skicka in din dokumentation för granskning sparar du först ditt arbete i Visual Studio Code (eller den textredigerare du valt). Sedan anger du ett implementeringsmeddelande med hjälp av GitHub Desktop och väljer Verkställ för att skapa källdokumentation.

commit-vs

Nästa, välj Penselursprung för att överföra ditt arbete till fjärrgrenen.

push-origin

Om du vill skapa en pull-begäran väljer du Skapa pull-begäran.

create-pr-vs

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

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