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. Alvorens door de hier vermelde stappen te gaan, zorg ervoor u Document uw bestemming in de Doelen van Adobe Experience Platformleest.
- installeer Git en de Authoring hulpmiddelen van de Prijsverhoging
- {de plaats van de Git van de opstelling plaatselijk voor documentatie 🔗
- GitHub bijdragewerkschema voor belangrijke veranderingen.
Verbind met GitHub en opstelling uw lokale auteursmilieu set-up-environment
-
Blader in uw browser naar
https://github.com/AdobeDocs/experience-platform.en
-
Aan vorkde bewaarplaats, klik Fork zoals hieronder getoond. Dit leidt tot een exemplaar van de bewaarplaats van Experience Platform in uw eigen rekening GitHub.
-
Kloont de opslagplaats naar uw lokale computer. Selecteer Code > HTTPS > Open met Desktop GitHub, zoals hieronder getoond. Zorg ervoor u 🔗 geïnstalleerde Desktop GitHub hebt. Voor verdere verwijzing, lees een lokale kloon van de bewaarplaatsin de de contributorgids van Adobe creëren.
-
Navigeer in uw lokale bestandsstructuur naar
experience-platform.en/help/destinations/catalog/[...]
, waar[...]
de gewenste categorie voor uw doel is. Als u bijvoorbeeld een aanpassingsdoel toevoegt aan Experience Platform, selecteert u de mappersonalization
.
Auteur de documentatiepagina voor uw bestemming author-documentation
- Uw documentatiepagina is gebaseerd op het zelfbedienings bestemmingsmalplaatje. Download het bestemmingsmalplaatje. Pak het uit en extraheer het bestand
yourdestination-template.md
naar de map die in stap 4 hierboven is vermeld. Wijzig de naam van het bestand inYOURDESTINATION.md
, waarbij UW BESTEMMING de naam van uw bestemming in Adobe Experience Platform is. Als uw bedrijf bijvoorbeeld Moviestar heet, geeft u het bestand de naammoviestar.md
. - Open uw nieuw dossier in uw tekstredacteur van keus. Adobe adviseert dat u Code van Visual Studiogebruikt en de Verkennende uitbreiding van de Markeringen van Adobe installeert. Als u de extensie wilt installeren, opent u Visual Studio-code, selecteert u het tabblad Extensions links van het scherm en zoekt u 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 aan de documentatie wilt toevoegen naar
GitHub/experience-platform.en/help/destinations/assets/catalog/[...]
, waar[...]
de gewenste categorie voor uw doel is. Als u bijvoorbeeld een aanpassingsdoel toevoegt aan Experience Platform, selecteert u de mappersonalization
. 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 hoe te om aan beeldente verbinden. - 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 werkende tak voor uw updates en selecteer publiceer tak om de tak aan GitHub te publiceren.
-
In de Desktop van GitHub, begaatuw werk, zoals hieronder getoond.
-
In Desktop GitHub, duwuw werk aan de verretak, zoals hieronder getoond.
-
Open in de GitHub-webinterface een pull-aanvraag (PR) om uw werkende vertakking samen te voegen in de hoofdvertakking van de Adobe-documentatieopslagplaats. Zorg ervoor de tak u aan werkte wordt geselecteerd en selecteert bijdraagt > Open trekkingsverzoek.
-
Controleer of de basis- en vergelijkingsvertakkingen correct zijn. Voeg een nota aan PR toe, beschrijvend uw update, en selecteer creeer trekkingsverzoek. Dit opent een PR om de werkende tak van uw vork in de hoofdtak van de bewaarplaats van Adobe samen te voegen.
note tip TIP Verlaat uitgeeft door instandhouders geselecteerde checkbox toestaat zodat het de documentatieteam van Adobe aan PR kan uitgeven. -
Op dit moment wordt een melding weergegeven waarin u wordt gevraagd de Adobe Contributor License Agreement (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 de verzoeken van de Trek tabel in
https://github.com/AdobeDocs/experience-platform.en
te inspecteren.
- Bedankt! Het Adobe-documentatieteam zal de PR bereiken voor het geval er wijzigingen nodig zijn en u laten weten wanneer de documentatie zal worden gepubliceerd.