DocumentatieExperience PlatformHandleiding voor bestemmingen

Een teksteditor in uw lokale omgeving gebruiken om een doeldocumentatiepagina te maken local-authoring

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Gemaakt voor:

  • Beheerder
  • Gebruiker

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.

TIP
Raadpleeg ook de ondersteunende documentatie in de handleiding voor contribuanten van de Adobe:

Verbind met GitHub en opstelling uw lokale auteursmilieu set-up-environment

  1. Blader in uw browser naar https://github.com/AdobeDocs/experience-platform.en

  2. Aan vorkde bewaarplaats, klik Fork zoals hieronder getoond. Dit leidt tot een exemplaar van de bewaarplaats van het Experience Platform in uw eigen rekening GitHub.

    de documentatiebewaarplaats van de Adobe van het Fork

  3. 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, leest een lokale kloon van de bewaarplaatsin de de bijdragegids van de Adobe creëren.

    de documentatiebewaarplaats van de Adobe van de Kloon aan lokaal milieu

  4. 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 het Experience Platform, selecteert u de map personalization .

Auteur de documentatiepagina voor uw bestemming author-documentation

  1. 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 in YOURDESTINATION.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 naam moviestar.md .
  2. Open uw nieuw dossier in uw tekstredacteur van keus. De Adobe adviseert dat u Code van Visual Studiogebruikt en de Authoring van de Markeringen van de Adobe uitbreiding 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 .
    installeer de uitbreiding van de Authoring van de Markeringen van de Adobe
  3. Bewerk de sjabloon met relevante informatie voor uw doel. Volg de instructies in de sjabloon.
  4. 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 het Experience Platform, selecteert u de map personalization . 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.
  5. Sla het bestand waaraan u werkt op als u klaar bent.

De documentatie ter controle verzenden submit-review

TIP
U kunt hier niets breken. Door de instructies in deze sectie te volgen, stelt u eenvoudig een documentupdate voor. Uw voorgestelde update wordt goedgekeurd of bewerkt door het Adobe Experience Platform-documentatieteam.
  1. In de Desktop van GitHub, creeer een werkende tak voor uw updates en selecteer tak van Publish om de tak aan GitHub te publiceren.

Nieuwe vertakking lokale

  1. In de Desktop van GitHub, begaatuw werk, zoals hieronder getoond.

    lokale Vastleggen

  2. In Desktop GitHub, duwuw werk aan de verretak, zoals hieronder getoond.

    duw uw begaat

  3. 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 de tak u aan werkte wordt geselecteerd en selecteert Contribute > Open trekkingsverzoek.

    creeer trektrekverzoek

  4. 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 de Adobe samen te voegen.

    note tip
    TIP
    Verlaat uitgeeft door instandhouders geselecteerde checkbox toestaat zodat het de documentatieteam van de Adobe aan PR kan uitgeven.

    creeer trekkingsverzoek aan de documentatiebewaarplaats van de Adobe

  5. 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.

  6. 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.

PR succesvol

  1. 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.
TIP
Om beelden en verbindingen aan uw documentatie toe te voegen, en voor een andere vragen rond Markering, lees Gebruikend Markdownin de samenwerkingsgids van de Adobe het schrijven gids.
recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6