Skapa en måldokumentationssida med GitHub-webbgränssnittet

Senaste uppdatering: 2023-11-01
  • Skapat för:
  • Developer
    User
    Admin
    Leader

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 kontrollera att du läser Dokumentera destinationen i Adobe Experience Platform Destinations.

Konfigurera din GitHub-redigeringsmiljö

  1. I webbläsaren går du till https://github.com/AdobeDocs/experience-platform.en.

  2. Till gaffel databasen klickar du på Gaffel 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. I mappstrukturen GitHub för den förankrade databasen navigerar du till experience-platform.en/help/destinations/catalog/[...], där [...] är den önskade kategorin för destinationen. Om du till exempel lägger till ett anpassningsmål till Experience Platform väljer du personalization kategori. Välj Lägg till fil > Skapa ny fil.

    Lägg till ny fil

  5. Namnge målet YOURDESTINATION.md, där YOURDESTINATION är namnet på destinationen 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äningsmall för dokumentation. Ladda ned mallen och zippa upp den för att extrahera .md filmall.

  2. Klistra in och redigera innehållet i mallen med relevant information om destinationen i en markeringsredigerare online, som 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. Använd 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 destinationen. Om du till exempel lägger till ett anpassningsmål till Experience Platform väljer du personalization kategori. Du måste länka till bilderna från sidan som du redigerar. Se anvisningar 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 huvudgrenen i dokumentationsdatabasen för Adobe. Se till att grenen du arbetade med är markerad och väljer Contribute > Öppna pull-begäran.

Skapa pull-begäran

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

    TIPS

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

    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 Dra in begäranden tabba in 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 till din dokumentation och om du vill ha andra frågor om Markdown läser du Använda markering i Adobe samarbetsvägledning.

På denna sida