Gebruik de het Webinterface van GitHub om een brondocumentatiepagina tot stand te brengen

Dit document verstrekt stappen op hoe te om de het Webinterface van GitHub aan auteursdocumentatie te gebruiken en een trekkingsverzoek (PR) voor te leggen.

Opstelling uw milieu GitHub

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

Daarna, uitgezochte Vlek.

Zodra het vork volledig is, selecteer meester en ga een naam voor uw nieuwe tak in het dropdown menu in dat verschijnt. Zorg ervoor dat u een beschrijvende naam voor uw tak verstrekt aangezien dit zal worden gebruikt om uw werk te bevatten, en selecteer dan tak creëren.

In de GitHub omslagstructuur van uw forked bewaarplaats, navigeer aan experience-platform.en/help/sources/tutorials/api/create/en selecteer dan de aangewezen categorie voor uw bron van de lijst. Bijvoorbeeld, als u documentatie voor een nieuwe bron van CRM creeert, uitgezochte crm.

Er wordt een map met bestaande CRM-bronnen weergegeven. Om documentatie voor een nieuwe bron toe te voegen, voeg dossier toe en selecteer dan creeer nieuw dossier van het drop-down menu dat verschijnt.

Geef het bronbestand een naam YOURSOURCE.md waarbij UURSOURCE de naam van de bron in Platform is. Als uw bedrijf bijvoorbeeld ACME CRM is, moet uw bestandsnaam acme-crm.md zijn.

Auteur de documentatiepagina voor uw bron

Beginnen uw nieuwe bron te documenteren, kleef de inhoud van het malplaatje van de brondocumentatiein de het Webredacteur van GitHub. U kunt het malplaatje 🔗 ook hier downloaden.

Met het malplaatje dat over aan de interface van de Webredacteur van GitHub wordt gekopieerd, volg de instructies die op het malplaatje worden geschetst en geef de waarden uit die relevante informatie voor uw bron bevatten.

Als u klaar bent, legt u het bestand in de vertakking vast.

De documentatie ter controle verzenden

Als het bestand eenmaal is toegewezen, kunt u een pull-verzoek (PR) openen om uw werkvertakking samen te voegen in de hoofdvertakking van de documentatieopslagplaats van de Adobe. Zorg ervoor dat de tak u aan hebt gewerkt wordt geselecteerd, en selecteer dan vergelijken & trekken 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.

Op dit punt, lijkt een bericht dat u ertoe aanzet om de Overeenkomst van de Vergunning van de Medewerker van de Adobe (CLA) te ondertekenen. Dit is een verplichte stap. Nadat u CLA ondertekent, vernieuw de PR pagina en verzend het trekkingsverzoek.

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