Een teksteditor in uw lokale omgeving gebruiken om een doeldocumentatiepagina te maken local-authoring
In de instructies op deze pagina ziet u hoe u een teksteditor kunt gebruiken om in uw lokale omgeving te werken aan de auteur van documentatie en een pull-verzoek (PR) in te dienen. Voordat u de hier aangegeven stappen doorloopt, moet u ervoor zorgen dat u Uw doel documenteren in Adobe Experience Platform-doelen.
Verbind met GitHub en opstelling uw lokale auteursmilieu set-up-environment
-
Blader in uw browser naar
https://github.com/AdobeDocs/experience-platform.en
-
Naar vork in de repository klikt u op Vork zoals hieronder weergegeven. Dit leidt tot een exemplaar van de bewaarplaats van het Experience Platform in uw eigen rekening GitHub.
-
Kloont de opslagplaats naar uw lokale computer. Selecteren Code > HTTPS > Openen met GitHub Desktop, zoals hieronder weergegeven. Zorg ervoor dat u GitHub Desktop geïnstalleerd. Lees voor meer informatie Een lokale kloon maken van de opslagplaats in de handleiding voor contribuanten van de Adobe.
-
Ga in uw lokale bestandsstructuur naar
experience-platform.en/help/destinations/catalog/[...]
, waarbij[...]
is de gewenste rubriek voor uw bestemming. Als u bijvoorbeeld een verpersoonlijkingsbestemming aan Experience Platform toevoegt, selecteert u de optiepersonalization
map.
Auteur de documentatiepagina voor uw bestemming author-documentation
- De documentatiepagina is gebaseerd op de self-service doelsjabloon. Download de doelsjabloon. Pak het uit en extraheer het bestand
yourdestination-template.md
in de in stap 4 hierboven vermelde directory. De naam van het bestand wijzigenYOURDESTINATION.md
, waarbij YOURDESTINATION de naam van je bestemming in Adobe Experience Platform is. Als uw bedrijf bijvoorbeeld Moviestar heet, geeft u het bestand een naammoviestar.md
. - Open uw nieuwe bestand in uw teksteditor van keuze. Adobe raadt u aan Visual Studio-code en installeer de Adobe Markdown Authoring-extensie. Om de uitbreiding, de open Code van Visual Studio te installeren, selecteer Extensions links op het scherm en zoek naar
adobe markdown authoring
. Selecteer de extensie en klik op Install.
- Bewerk de sjabloon met relevante informatie voor uw doel. Volg de instructies in de sjabloon.
- Ga voor alle schermafbeeldingen of afbeeldingen die u wilt toevoegen aan uw documentatie naar
GitHub/experience-platform.en/help/destinations/assets/catalog/[...]
, waarbij[...]
is de gewenste rubriek voor uw bestemming. Als u bijvoorbeeld een verpersoonlijkingsbestemming aan Experience Platform toevoegt, selecteert u de optiepersonalization
map. Maak een nieuwe map voor uw bestemming en sla uw afbeeldingen hier op. U moet er een koppeling naar maken vanaf de pagina die u ontwerpt. Zie instructies voor het koppelen naar afbeeldingen. - Sla het bestand waaraan u werkt op als u klaar bent.
De documentatie ter controle verzenden submit-review
- In de Desktop van GitHub, creeer een het werk tak voor uw updates en selecteer Vertakking publiceren om de vertakking naar GitHub te publiceren.
-
In GitHub Desktop, begaan uw werk, zoals hieronder getoond.
-
In GitHub Desktop, duwen uw werk aan extern vertakking, zoals hieronder weergegeven.
-
In de het Webinterface van GitHub, open een trekkingsverzoek (PR) om uw werkende tak in de hoofdtak van de de documentatiebewaarplaats van de Adobe samen te voegen. Zorg ervoor dat de vertakking die u hebt bewerkt is geselecteerd en selecteer Contribute > pull-verzoek openen.
-
Controleer of de basis- en vergelijkingsvertakkingen correct zijn. Voeg een notitie toe aan de PR, beschrijf de update en selecteer pull-verzoek maken. Dit opent een PR om de werkende tak van uw vork in de hoofdtak van de bewaarplaats van de Adobe samen te voegen.
note tip TIP Laat de Bewerkingen door onderhoudsleiders toestaan Schakel het selectievakje in zodat het documentatieteam van de Adobe de PR kan bewerken. -
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 verzonden door de Pull-aanvragen tab in
https://github.com/AdobeDocs/experience-platform.en
.
- Bedankt! Het documentatieteam van de Adobe zal in het PR bereiken als om het even welke veranderingen worden vereist en u te laten weten wanneer de documentatie zal worden gepubliceerd.