DocumentationExperience PlatformDestinations Guide

Use the GitHub web interface to create a destination documentation page github-interface

Last update: Wed Nov 01 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • User
  • Admin
  • Leader

The instructions below show you how to use the GitHub web interface to author documentation and submit a pull request (PR). Before going through the steps indicated here, make sure you read Document your destination in Adobe Experience Platform Destinations.

TIP
Refer also to the supporting documentation in Adobe’s contributor guide:

Set up your GitHub authoring environment set-up-environment

  1. In your browser, navigate to https://github.com/AdobeDocs/experience-platform.en.

  2. To fork the repository, click Fork as shown below. This creates a copy of the Experience Platform repository in your own GitHub account.

    Fork Adobe documentation repository

  3. In your fork of the repository, create a new branch for your project, as shown below. Use this new branch for your work.

    Create new GitHub branch

  4. In the GitHub folder structure of the forked repository, navigate to experience-platform.en/help/destinations/catalog/[...], where [...] is the desired category for your destination. For example, if you are adding a personalization destination to Experience Platform, select the personalization category. Select Add file > Create new file.

    Add new file

  5. Name your destination YOURDESTINATION.md, where YOURDESTINATION is the name of your destination in Adobe Experience Platform. For example, if your company is called Moviestar, you would name your file moviestar.md.

Author the documentation page for your destination author-documentation

  1. You will create the content of your destination page based on the documentation self-service template. Download the template and unzip it to extract the .md file template.

  2. Paste and edit the content of the template with relevant information for your destination in an online markdown editor, such as dillinger.io. Follow the instructions in the template for details on what you should fill in and which paragraphs can be removed.

    note tip
    TIP
    You can close your browser window at any time and reopen later. Your work is saved automatically and will be waiting for you when you reopen the browser.

    3. Copy the content from the markdown editor into your new file in GitHub.

  3. For any screenshots or images that you plan on using, use the GitHub interface to upload the files to experience-platform.en/help/destinations/assets/catalog/[...], where [...] is the desired category for your destination. For example, if you are adding a personalization destination to Experience Platform, select the personalization category. You need to link to the images from the page you are authoring. See instructions how to link to images.

    Upload image to GitHub

  4. When you are ready, save the file in your branch.

Confirm file creation

Submit your documentation for review submit-review

TIP
Note that there is nothing you can break here. By following the instructions in this section, you are simply suggesting a documentation update. Your suggested update will be approved or edited by the Adobe Experience Platform documentation team.
  1. After you saved the file and uploaded your desired images, you can open a pull request (PR) to merge your working branch into the master branch of the Adobe documentation repository. Make sure the branch that you worked on is selected and select Contribute > Open pull request.

Create pull request

  1. Make sure that the base and compare branches are correct. Add a note to the PR, describing your update, and select Create pull request. This opens a PR to merge the working branch of your fork into the master branch of the Adobe repository.

    note tip
    TIP
    Leave the Allow edits by maintainers checkbox selected so that the Adobe documentation team can make edits to the PR.

    Create pull request to Adobe documentation repository

  2. At this point, a notification appears that prompts you to sign the Adobe Contributor License Agreement (CLA). This is a mandatory step. After you sign the CLA, refresh the PR page and submit the pull request.

  3. You can confirm that the pull request has been submitted by inspecting the Pull requests tab in https://github.com/AdobeDocs/experience-platform.en.

    PR successful

  4. Thank you! The Adobe documentation team will reach out in the PR in case any edits are required and to let you know when the documentation will be published.

TIP
To add images and links to your documentation, and for any other questions around Markdown, read Using Markdown in Adobe’s collaborative writing guide.
recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6