Edge Delivery Services and GitHub
Edge Delivery leverages GitHub so you can manage and deploy code directly from your GitHub repository.
Your authors can create content using either Document-based Authoring or content in AEM with the Universal Editor. Developers can customize the functionality of your site by using CSS and JavaScript in GitHub regardless of how the authors create their content.
Websites are automatically created for each of your branches from content preview to production. Every resource that you put into your GitHub repository is available on your website without a build process.
Getting Started with WYSIWYG Authoring and Edge Delivery Services
Once you have fulfilled the prerequisites and have made the choice to use the Universal Editor, you can get started on your own project.
Create Your GitHub Project
First you will need to create a new project on GitHub, based on the Adobe template.
-
Navigate to
https://github.com/adobe-rnd/aem-boilerplate-xwalk
and Click on Use this template and select Create a new repository.- You will need to be signed in to GitHub to see this option.
-
By default, the repository will be assigned to you. Change this as necessary as well as provide a repository name and description and click Create repository.
-
In a new tab in the same browser, navigate to
https://github.com/apps/aem-code-sync
and click Configure. -
Click Configure for the org where you created your new repository in the previous step.
-
On the AEM Code Sync GitHub page under Repository access, select Only select repositories, select the repository that you created in the previous step, and then click Save.
-
Once AEM Code Sync is installed, you receive a confirmation screen. Return to the browser tab of your new repository.
-
Click the
fstab.yaml
file to open it and then the Edit this file icon to edit it. -
Edit the
fstab.yaml
file to update the mount point of your project. Replace the default Google Docs URL with the URL of your AEM as a Cloud Service authoring instance and then click Commit changes….https://<aem-author>/bin/franklin.delivery/<owner>/<repository>/main
- Changing the mount point tells Edge Delivery Services where to find the content of the site.
-
Add a commit message as desired and then click Commit changes, committing them directly to the
main
branch. -
Return to the root of your repository and click on
paths.json
and then the Edit this file icon. -
The default mapping will use the name of the repository. Update the default mapping as required for your project with
/content/<site-name>/:/
and click Commit changes….- Provide your own
<site-name>
. You will need it in a later step. - The mappings tells Edge Delivery Services how to map the content in your AEM repository to the site URL.
- Provide your own
-
Add a commit message as desired and then click Commit changes, committing them directly to the
main
branch.