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

Senast uppdaterad: 5 maj 2025
  • Ämnen:

Skapat för:

  • Utvecklare

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

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

Förhandskrav

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

platform-repo

På huvudsidan i Experience Platform GitHub-databasen väljer du Förgrening.

förgrening

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

TIPS
Mer information finns i självstudiekursen Konfigurera Git-databasen lokalt för dokumentation.

open-git-desktop

Tillåt sedan några ögonblick för GitHub Desktop att klona databasen experience-platform.en.

kloning

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

ny gren

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

create-branch-vs

Välj sedan Publicera gren.

publish-branch

Skriv dokumentationssidan för källan

När databasen är klonad till din lokala dator och en ny gren har skapats kan du nu börja skapa dokumentationssidan för den nya källan med den textredigerare som du väljer.

Adobe rekommenderar att du använder Visual Studio Code och att du installerar tillägget Adobe Markdown Authoring. Om du vill installera tillägget startar du Visual Studio-kod och väljer sedan fliken Tillägg i den vänstra navigeringen.

tillägg

Ange sedan Adobe Markdown Authoring i sökfältet och välj Installera på sidan som visas.

installera

När den lokala datorn är klar hämtar du dokumentationsmallen för källor och extraherar 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 din dokumentation för granskning måste du först spara 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

Välj sedan Push origin 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, som beskriver uppdateringen och välj sedan Skapa pull-begäran. Då öppnas en PR som sammanfogar arbetsgrenen i ditt arbete med huvudgrenen i Adobe-databasen.

TIPS
Låt kryssrutan Tillåt redigeringar av underhållare vara markerad för att se till att Adobe dokumentationsteam kan göra ändringar i PR-dokumentet.

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