[Beta]{class="badge informative"}
Dokumentera källan (Streaming SDK)
Det sista steget innan den nya källan kan publiceras i Adobe Experience Platform är att dokumentera den nya källan.
Den här handboken innehåller följande:
- En självstudiekurs som du kan följa för att skapa en dokumentationssida för den nya källan;
- En dokumentationsmall där du kan fylla i för den nya källan;
- Instruktioner om hur du använder Markdown för att skriva teknisk dokumentation;
- Instruktioner om hur du förstår Adobe Markdown-smak.
Förhandskrav
Följande objekt krävs innan du kan börja dokumentera den nya källan:
- Ett giltigt GitHub-användarkonto: Om du inte har något befintligt GitHub-konto måste du skapa ett via GitHub-registreringssidan;
- Åtkomst till GitHub Desktop: Du måste använda GitHub-skrivbordsappen för att kunna skapa källdokumentation i din lokala miljö;
- Din integrering med Adobe måste vara i en testfas med din källa i en testmiljö i Experience Platform.
Instruktioner på hög nivå för att skapa dokumentation för källan i Experience Platform
Om du vill skapa dokumentation för källan måste du skapa en gaffel i Experience Platform dokumentationsarkiv och redigera dokumentationsmallen i en ny gren. Använd mallen som tillhandahålls av Adobe för att skapa en ny källsida och öppna en pull-begäran (PR) när du är klar. Anvisningar om hur du gör detta finns nedan, i steg för att skapa en ny källsida.
Dokumentationsmall
Du kan använda en förfylld API-dokumentationsmall eller dokumentationsmallen för användargränssnittet för att skapa dokumentation för källan. Nedan finns instruktioner om hur du redigerar mallen och öppnar en pull-begäran. Dokumentation som skickas till den nya källan granskas och publiceras av Adobe dokumentationsteam.
Du kan även hämta dokumentationsmallarna nedan:
Skapa en ny källsida
Du kan använda GitHub-webbgränssnittet eller din lokala miljö för att skapa dokumentation för den nya källan i Experience Platform. Sök efter instruktioner för båda alternativen i länkarna nedan: