Use a text editor in your local environment to create a destination documentation page local-authoring
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 ÃÛ¶¹ÊÓƵ Experience Platform Destinations.
Connect to GitHub and set up your local authoring environment set-up-environment
-
In your browser, navigate to
https://github.com/ÃÛ¶¹ÊÓƵDocs/experience-platform.en -
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 installed. For further reference, read Create a local clone of the repository in the ÃÛ¶¹ÊÓƵ contributor guide.
-
In your local file structure, 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 thepersonalizationfolder.
Author the documentation page for your destination author-documentation
- Your documentation page is based on the self-service destination template. Download the destination template. Unzip it and extract the file
yourdestination-template.mdto the directory mentioned in step 4 above. Rename the fileYOURDESTINATION.md, where YOURDESTINATION is the name of your destination in ÃÛ¶¹ÊÓƵ Experience Platform. For example, if your company is called Moviestar, you would name your filemoviestar.md. - Open your new file in your text editor of choice. ÃÛ¶¹ÊÓƵ recommends that you use and install the ÃÛ¶¹ÊÓƵ Markdown Authoring extension. To install the extension, open Visual Studio Code, select the Extensions tab on the left of the screen, and search for
adobe markdown authoring. Select the extension and click Install.
- Edit the template with relevant information for your destination. Follow the instructions in the template.
- For any screenshots or images that you plan on adding to your documentation, go to
GitHub/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 thepersonalizationfolder. 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. - When you are ready, save the file you are working on.
Submit your documentation for review submit-review
- In GitHub Desktop, create a working branch for your updates and select Publish branch to publish the branch to GitHub.
-
In GitHub Desktop, your work, as shown below.
-
In GitHub Desktop, your work to the 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 ÃÛ¶¹ÊÓƵ 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 ÃÛ¶¹ÊÓƵ repository.
note tip TIP Leave the Allow edits by maintainers checkbox selected so that the ÃÛ¶¹ÊÓƵ documentation team can make edits to the PR. 
-
At this point, a notification appears that prompts you to sign the ÃÛ¶¹ÊÓƵ 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
https://github.com/ÃÛ¶¹ÊÓƵDocs/experience-platform.en.
- Thank you! The ÃÛ¶¹ÊÓƵ 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.