Uw bron documenteren
Gemaakt voor:
- Ontwikkelaar
De laatste stap voordat uw nieuwe bron live in Adobe Experience Platform kan worden ingesteld, is het documenteren van uw nieuwe bron.
Deze handleiding bevat:
- Een zelfstudie die u kunt volgen om een documentatiepagina voor uw nieuwe bron te maken;
- Een documentatiesjabloon dat u kunt invullen voor uw nieuwe bron.
- Instructies op hoe te om Markering voor het schrijven van technische documentatiete gebruiken;
- Instructies bij het begrip van de aroma van de Prijsverhoging van de Adobe.
Vereisten
De volgende items zijn vereist voordat u de nieuwe bron kunt documenteren:
- Een geldige GitHub gebruikersrekening: Als u geen bestaande rekening GitHub hebt, dan moet u één door de GitHub ondertekenen paginatot stand brengen;
- Toegang tot Desktop GitHub: U moet de Desktop gebruiken GitHub appom uw brondocumentatie in uw lokaal milieu tot stand te brengen;
- Uw integratie met Adobe moet zich in een testfase bevinden met uw bron die in een testomgeving in Platform wordt geïmplementeerd.
Instructies op hoog niveau om documentatie voor uw bron in Platform te maken
Op hoog niveau, om documentatie voor uw bron tot stand te brengen, moet u een vork van de de documentatiebewaarplaats van het Platform tot stand brengen en het verstrekte documentatiemalplaatje in een nieuwe tak uitgeven. Gebruik de door de Adobe verschafte sjabloon om een nieuwe bronpagina te maken en een pull request (PR) te openen wanneer u klaar bent. Hieronder vindt u instructies voor het maken van de nieuwe bronpagina.
Documentatiesjabloon
U kunt een vooraf ingevuld documentatiemalplaatjegebruiken om in het creëren van documentatie voor uw bron bij te wonen. Hieronder vindt u instructies voor het bewerken van de sjabloon en het openen van een pull-verzoek. De ingediende documentatie voor uw nieuwe bron zal door het de documentatieteam van de Adobe worden herzien en worden gepubliceerd.
U kunt ook de onderstaande documentatiesjablonen downloaden:
Nieuwe bronpagina maken
U kunt de GitHub Webinterface of uw lokaal milieu gebruiken om documentatie voor uw nieuwe bron in Platform tot stand te brengen. Zoek instructies voor beide opties in de onderstaande koppelingen: