Använd GitHub-webbgränssnittet för att skapa en måldokumentationssida

Instruktionerna nedan visar hur du använder GitHub-webbgränssnittet för att skapa dokumentation och skicka en pull-begäran (PR). Innan du går igenom de steg som anges här bör du läsa Dokumentera ditt mål i Adobe Experience Platform Destinations.

Konfigurera din GitHub-redigeringsmiljö

  1. Navigera till https://github.com/AdobeDocs/experience-platform.en i webbläsaren.

  2. Om du vill förgrening databasen klickar du på Förgrening enligt nedan. Detta skapar en kopia av databasen Experience Platform i ditt eget GitHub-konto.

    Dokumentationsarkiv för Adobe

  3. Skapa en ny gren för ditt projekt i databasens gaffel, så som visas nedan. Använd den här nya grenen för ditt arbete.

    Skapa ny GitHub-gren

  4. Navigera till experience-platform.en/help/destinations/catalog/[...], där [...] är den önskade kategorin för ditt mål, i mappstrukturen GitHub för den förankrade databasen. Om du till exempel lägger till ett anpassningsmål i Experience Platform väljer du kategorin personalization. Välj Lägg till fil > Skapa ny fil.

    Lägg till ny fil

  5. Ange ett namn på målet YOURDESTINATION.md, där YOURDESTINATION är namnet på målet i Adobe Experience Platform. Om ditt företag till exempel heter Moviestar skulle du namnge filen moviestar.md.

Skriv dokumentationssidan för ditt mål

  1. Du skapar innehållet på målsidan baserat på självbetjäningsmallen för dokumentationen. Ladda ned mallen och zippa upp den för att extrahera .md filmallen.

  2. Klistra in och redigera innehållet i mallen med relevant information om målet i en markeringsredigerare online, till exempel dillinger.io. Följ instruktionerna i mallen för mer information om vad du ska fylla i och vilka stycken som kan tas bort.

    TIPS

    Du kan när som helst stänga webbläsarfönstret och öppna det igen senare. Ditt arbete sparas automatiskt och väntar på dig när du öppnar webbläsaren igen.

    3. Kopiera innehållet från markeringsredigeraren till den nya filen i GitHub.
  3. För skärmbilder eller bilder som du tänker använda använder du GitHub-gränssnittet för att överföra filerna till experience-platform.en/help/destinations/assets/catalog/[...], där [...] är den önskade kategorin för målet. Om du till exempel lägger till ett anpassningsmål i Experience Platform väljer du kategorin personalization. Du måste länka till bilderna från sidan som du redigerar. Se instruktioner om hur du länkar till bilder.

    Överför bild till GitHub

  4. När du är klar sparar du filen i din gren.

Bekräfta skapande av fil

Skicka in din dokumentation för granskning

TIPS

Observera att det inte finns något du kan bryta här. Genom att följa instruktionerna i det här avsnittet föreslår du bara en uppdatering av dokumentationen. Den föreslagna uppdateringen kommer att godkännas eller redigeras av Adobe Experience Platform dokumentationsteam.

  1. När du har sparat filen och överfört de önskade bilderna kan du öppna en pull-begäran (PR) för att sammanfoga din arbetsgren med den överordnad grenen i dokumentationsdatabasen för Adobe. Kontrollera att den gren du arbetade med är markerad och välj Contribute > Öppna pull-begäran.

Skapa pull-begäran

  1. Kontrollera att bas- och jämförelsegrenarna är korrekta. Lägg till en anteckning i PR:en som beskriver uppdateringen och välj Skapa pull-begäran. Då öppnas en PR som sammanfogar arbetsgrenen i din gaffel till den överordnad grenen i Adobe-databasen.

    TIPS

    Låt kryssrutan Tillåt redigeringar av underhållare vara markerad så att dokumentationsteamet på Adobe kan göra ändringar i PR-dokumentet.

    Skapa pull-begäran till Adobe-dokumentationsarkivet

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

  3. Du kan bekräfta att pull-begäran har skickats genom att granska fliken Pull-begäranden i https://github.com/AdobeDocs/experience-platform.en.

    PR lyckades

  4. Tack! Dokumentationsteamet på Adobe kommer att nå ut i PR om det skulle behövas ändringar och informera dig om när dokumentationen kommer att publiceras.

TIPS

Om du vill lägga till bilder och länkar i din dokumentation och om du vill ha andra frågor om Markdown, ska du läsa Använda Markdown i Adobe samarbetshandbok.

På denna sida