The instructions on this page show you how to use a text editor to work in your local environment 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.
Refer also to the supporting documentation in Adobe’s contributor guide:
In your browser, navigate to
To fork the repository, click Fork as shown below. This creates a copy of the Experience Platform repository in your own GitHub account.
Clone the repository to your local machine. Select Code > HTTPS > Open with GitHub Desktop, as shown below. Make sure you have GitHub Desktop installed. For further reference, read Create a local clone of the repository in the Adobe contributor guide.
In your local file structure, navigate to
[...] is the desired category for your destination. For example, if you are adding a personalization destination to Experience Platform, select the
yourdestination-template.mdto the directory mentioned in step 4 above. Rename the file
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
adobe markdown authoring. Select the extension and click Install.
[...]is the desired category for your destination. For example, if you are adding a personalization destination to Experience Platform, select the
personalizationfolder. Create a new folder for your destination and save your images here. You must link to them from the page you are authoring. See instructions how to link to images.
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.
In GitHub Desktop, commit your work, as shown below.
In GitHub Desktop, push your work to the remote branch, as shown below.
In the GitHub web interface, open a pull request (PR) to merge your working branch into the master branch of the Adobe documentation repository. Make sure the branch you worked on is selected and select Contribute > Open pull request.
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.
Leave the Allow edits by maintainers checkbox selected so that the Adobe documentation team can make edits to the PR.
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.
You can confirm that the pull request has been submitted by inspecting the Pull requests tab in
To add images and links to your documentation, and for any other questions around Markdown, read Using Markdown in Adobe’s collaborative writing guide.