Skapa en måldokumentationssida med GitHub-webbgränssnittet github-interface
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ö set-up-environment
-
Navigera till
https://github.com/AdobeDocs/experience-platform.en
i webbläsaren. -
Om du vill förgrena databasen klickar du på Förgrening enligt nedan. Detta skapar en kopia av databasen Experience Platform i ditt eget GitHub-konto.
-
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.
-
Navigera till
experience-platform.en/help/destinations/catalog/[...]
i mappstrukturen GitHub för den förankrade databasen, där[...]
är den önskade kategorin för ditt mål. Om du till exempel lägger till ett anpassningsmål i Experience Platform väljer du kategorinpersonalization
. Välj Lägg till fil > Skapa ny fil. -
Ange namnet
YOURDESTINATION.md
där YOURDESTINATION är namnet på målet i Adobe Experience Platform. Om ditt företag till exempel heter Moviestar skulle du kalla din filmoviestar.md
.
Skriv dokumentationssidan för ditt mål author-documentation
-
Du skapar innehållet på målsidan baserat på dokumentationsmallen för självbetjäning. Hämta mallen och zippa upp den för att extrahera
.md
-filmallen. -
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.
note tip TIP 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.
-
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 kategorinpersonalization
. Du måste länka till bilderna från sidan som du redigerar. Se instruktioner om hur du länkar till bilder. -
När du är klar sparar du filen i din gren.
Skicka in din dokumentation för granskning submit-review
- 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. Kontrollera att grenen du arbetade med är markerad och välj Contribute > Öppna pull-begäran.
-
Kontrollera att bas- och jämförelsegrenarna är korrekta. Lägg till en anteckning i 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.
note tip TIP Låt kryssrutan Tillåt redigeringar av underhållare vara markerad så att dokumentationsteamet på Adobe kan göra ändringar i PR-dokumentet. -
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 fliken Pull-begäranden i
https://github.com/AdobeDocs/experience-platform.en
. -
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.