Gebruik de GitHub Webinterface om een pagina van de bestemmingsdocumentatie tot stand te brengen github-interface
De instructies tonen hieronder u hoe te om de het Webinterface van GitHub aan auteursdocumentatie te gebruiken en een trekkingsverzoek (PR) voor te leggen. Voordat u de hier aangegeven stappen doorloopt, moet u ervoor zorgen dat u Uw doel documenteren in Adobe Experience Platform-doelen.
Opstelling uw GitHub 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.
-
Maak op uw vork van de repository een nieuwe vertakking voor uw project, zoals hieronder wordt weergegeven. Gebruik deze nieuwe vertakking voor uw werk.
-
In de de omslagstructuur van GitHub van de forked bewaarplaats, navigeer aan
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
categorie. Selecteren Bestand toevoegen > Nieuw bestand maken. -
Geef uw bestemming een naam
YOURDESTINATION.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
.
Auteur de documentatiepagina voor uw bestemming author-documentation
-
U maakt de inhoud van de doelpagina op basis van de zelfservicesjabloon voor documentatie. Downloaden de sjabloon uit en decomprimeer deze om de
.md
bestandssjabloon. -
Plak en bewerk de inhoud van de sjabloon met relevante informatie voor uw doel in een online markeringseditor, zoals dillinger.io. Volg de instructies in de sjabloon voor meer informatie over wat u moet invullen en welke alinea's kunnen worden verwijderd.
note tip TIP U kunt uw browservenster op elk gewenst moment sluiten en later opnieuw openen. Uw werk wordt automatisch opgeslagen en u zult op u wachten wanneer u browser opnieuw opent. 3. Kopieer de inhoud van de prijsverhogingsredacteur in uw nieuw dossier in GitHub.
-
Voor om het even welke screenshots of beelden die u op het gebruiken van plan bent, gebruik de interface GitHub om de dossiers te uploaden aan
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
categorie. U moet een koppeling maken naar de afbeeldingen op de pagina die u maakt. Zie instructies voor het koppelen naar afbeeldingen. -
Sla het bestand op in de vertakking als u klaar bent.
De documentatie ter controle verzenden submit-review
- Nadat u het bestand hebt opgeslagen en de gewenste afbeeldingen hebt geĆ¼pload, 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 vertakking is geselecteerd waaraan u hebt gewerkt 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.