Skapa en måldokumentationssida med en textredigerare i den lokala miljön local-authoring
Instruktionerna på den här sidan visar hur du använder en textredigerare för att arbeta i din lokala miljö 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.
Anslut till GitHub och konfigurera din lokala redigeringsmiljö set-up-environment
-
Navigera till
https://github.com/AdobeDocs/experience-platform.eni 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.
-
Klona databasen till din lokala dator. Välj Kod > HTTPS > Öppna med GitHub Desktop, så som visas nedan. Kontrollera att GitHub Desktop är installerat. Mer information finns i Skapa en lokal klon av databasen i handboken för medverkande i Adobe.
-
Navigera till
experience-platform.en/help/destinations/catalog/[...]i den lokala filstrukturen, 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 mappenpersonalization.
Skriv dokumentationssidan för ditt mål author-documentation
- Dokumentationssidan är baserad på målmallen för självbetjäning. Hämta målmallen. Zippa upp den och extrahera filen
yourdestination-template.mdtill katalogen som nämns i steg 4 ovan. Byt namn på filenYOURDESTINATION.md, där YOURDESTINATION är namnet på ditt mål i Adobe Experience Platform. Om ditt företag till exempel heter Moviestar skulle du kalla din filmoviestar.md. - Öppna den nya filen i den textredigerare du vill använda. Adobe rekommenderar att du använder Visual Studio Code och installerar redigeringstillägget Adobe Markdown. Om du vill installera tillägget öppnar du Visual Studio-kod, väljer fliken Extensions till vänster på skärmen och söker efter
adobe markdown authoring. Markera tillägget och klicka på Install.
- Redigera mallen med relevant information om destinationen. Följ instruktionerna i mallen.
- För skärmbilder eller bilder som du planerar att lägga till i dokumentationen går du till
GitHub/experience-platform.en/help/destinations/assets/catalog/[...], 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 mappenpersonalization. Skapa en ny mapp för destinationen och spara bilderna här. Du måste länka till dem från sidan som du redigerar. Se instruktioner om hur du länkar till bilder. - När du är klar sparar du filen som du arbetar med.
Skicka in din dokumentation för granskning submit-review
- I GitHub Desktop skapar du en arbetsgren för dina uppdateringar och väljer Publish-gren för att publicera grenen på GitHub.
-
I GitHub Desktop utför ditt arbete, vilket visas nedan.
-
I GitHub Desktop push ditt arbete till grenen remote, vilket visas nedan.
-
Öppna en pull-begäran (PR) i GitHub-webbgränssnittet för att sammanfoga din arbetsgren med huvudgrenen i Adobe dokumentationsdatabas. 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.