AEM Authoring with Edge Delivery Services edge-dev-getting-started
This guide will get you up-and-running with a new Adobe Experience Manager site using Edge Delivery Services and the Universal Editor for content authoring.
Prerequisites prerequisites
Before beginning this guide, you should already be familiar with the basics of and have access to Edge Delivery Services including:
- You have completed the Edge Delivery Service tutorial.
- You have access to an AEM Cloud Service sandbox.
- You have enabled the Universal Editor on the same sandbox environment.
Pick the Right Editor editor-choice
AEM offers two different content editors and the choice of which to use depends on your situation.
- Universal Editor - This should be the default choice for new sites.
- AEM Page Editor - This should be chosen for an existing AEM Sites migration to Edge Delivery Services.
This guide focuses on AEM projects on Edge Delivery Services using the Universal Editor. See the document Developing for Edge Delivery Services for more details on choosing the right editor and the migration of existing AEM sites to Edge Delivery Services.
Getting Started with AEM Authoring nd Edge Delivery Services getting-started
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 create-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.yaml
and then the Edit this file icon. -
Replace the default mappings 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.
Create and Edit a New AEM Site create-aem-site
Now that you have a GitHub project, you must create a new AEM site that the project can use.
-
Request the latest AEM Authoring with Edge Delivery Services site template from Adobe Engineering via your project Slack channel.
-
Sign in to your AEM as a Cloud Service authoring instance and navigate to the Sites console and tap or click Create -> Site from template.
-
On the Select a site template tab of the create site wizard, click the Import button to import a new template.
-
Upload the AEM Authoring with Edge Delivery Services site template provided to you by Adobe Engineering.
-
Once the template is imported, it appears in the wizard. Tap or click to select it and then tap or click Next.
-
Provide the following fields and tap or click Create.
- Site title - Add a descriptive title for the site.
- Site title - Use the
<site-name>
that you defined in the previous step. - GitHub URL - Use the URL of the GitHub project you created in the previous step.
-
AEM confirms the site creation with a dialog. Tap or click OK to dismiss.
-
On the sites console, navigate to the
index.html
of the newly-created site and tap or click Edit in the toolbar. -
The Universal Editor opens in a new tab. You may need to tap or click Sign in with Adobe to authenticate to edit your page.
You can now edit your site using the Universal Editor. See the Universal Editor documentation for more information.
Publishing Your New Site publishing
Once you are finished editing your new site using the Universal Editor, you can publish your content.
-
On the sites console, select all of the pages you created for your new site and tap or click Quick publish in the toolbar.
-
Tap or click Publish in the confirmation dialog to start the process.
-
Open a new tab in the same browser and navigate to the URL of your new site.
https://main--<site-name>--<owner>.hlx.page
-
See your content published.
Next Steps next-steps
Now that you have a working AEM wuthoring with Edge Delivery Services project, you can begin creating and styling your own blocks.
Please see the guide Creating Blocks Instrumented for use with the Universal Editor for more information.