Een teksteditor in uw lokale omgeving gebruiken om een pagina met brondocumentatie te maken

Dit document bevat stappen voor het gebruik van uw lokale omgeving bij het schrijven van documentatie voor uw bron en het indienen van een pull-verzoek (PR).

Vereisten

Het volgende leerprogramma vereist dat u Desktop GitHub hebt die op uw lokale machine wordt geïnstalleerd. Als u geen Desktop GitHub hebt, kunt u de toepassing hierdownloaden.

Verbind met GitHub en opstelling uw lokale auteursmilieu

De eerste stap in vestiging uw lokaal auteursmilieu moet aan de bewaarplaats van Adobe Experience Platform navigeren GitHub.

Voor de belangrijkste pagina van de bewaarplaats van GitHub van het Platform, uitgezochte Fork.

Om de bewaarplaats aan uw lokale machine te klonen, selecteer Code. Van het dropdown menu dat verschijnt, selecteert HTTPS en dan, selecteert Open met Desktop GitHub.

Daarna, sta enkele ogenblikken voor Desktop GitHub toe om de experience-platform.en bewaarplaats te klonen.

Zodra het het klonen proces volledig is, hoofd aan Desktop GitHub om een nieuwe tak tot stand te brengen. Selecteer Hoofd van de hoogste navigatie en selecteer dan Nieuwe tak

In popover paneel dat verschijnt, ga een beschrijvende naam voor uw tak in, en selecteer dan tak creëren.

Daarna, uitgezochte tak van Publish.

Auteur de documentatiepagina voor uw bron

Met de bewaarplaats die aan uw lokale machine en een nieuwe gecreeerde tak wordt gekloond, kunt u nu beginnen de documentatiepagina voor uw nieuwe bron door de tekstredacteur van uw keuste ontwerpen.

De Adobe adviseert dat u Code van Visual Studiogebruikt en dat u de Authoring van de Markeringen van de Adobe uitbreiding installeert. Om de uitbreiding te installeren, lanceer de Code van Visual Studio, en selecteer dan het lusje van Uitbreidingen van de linkernavigatie.

Daarna, ga Adobe Markdown Authoring in de onderzoeksbar in en selecteer dan installeer van de pagina die verschijnt.

Met uw lokale machine klaar, download het malplaatje van de brondocumentatieen haal het dossier aan experience-platform.en/help/sources/tutorials/api/create/... met [...] die de categorie van uw keus vertegenwoordigen. Als u bijvoorbeeld een databasebron maakt, selecteert u de databasemap.

Volg ten slotte de instructies in de sjabloon en bewerk de sjabloon met de relevante informatie over de bron.

De documentatie ter controle verzenden

Als u een pull-verzoek (PR) wilt maken en de documentatie ter controle wilt verzenden, slaat u uw werk eerst op in Visual Studio Code (of de door u gekozen teksteditor). Daarna, gebruikend Desktop GitHub, ga een begaat bericht in en selecteer vastleggen om bron-documentatie tot stand te brengen.

Daarna, uitgezochte Push oorsprong om uw werk aan de verre tak te uploaden.

Om een trekkrachtverzoek tot stand te brengen, creeer het Volledige Verzoek.

Zorg ervoor dat de basis- en vergelijkingsvertakkingen correct zijn. Voeg een nota aan PR toe, beschrijvend uw update, en selecteer dan trekken verzoek creëren. Dit opent een PR om de werkende tak van uw werk in de hoofdtak van de bewaarplaats van de Adobe samen te voegen.

U kunt bevestigen dat het trekkingsverzoek is voorgelegd door het lusje van trekkingsverzoeken in https://github.com/AdobeDocs/experience-platform.en te inspecteren.