Download and install AEM Sites templates (Cloud services)
This guide provides step-by-step instructions to set up and configure the latest AEM Guides template for generating AEM Sites pages in a cloud environment. Follow these steps to install the required packages, create and configure presets, and generate AEM Sites.
Prerequisites
Before proceeding with the setup, ensure the following pre-requisites are met:
-
Adobe Experience Manager (AEM) Cloud: A running instance of AEM as a Cloud Service with AEM Guides 2502 or later versions.
-
Required Permissions: You must have the following permissions:
- Access to Cloud Manager to deploy packages.
- Access to Git Repository associated with your environment.
- Permissions to create and modify presets in AEM Guides.
-
Download Packages: Download the following packages from Software Distribution Portal:
- Components package: guides-components.all-1.x.0.zip
- Sites template: aemg-docs-1.x.0.zip
Package installation via Cloud deployment
Install the Components Package (guides-components.all-1.x.x.zip) and perform the following steps
-
Clone Git repository:
-
Navigate to Repositories in the left panel of Cloud Manager.
-
Select Access Repo Info and copy the git clone command.
-
Clone the repository to your local system using the provided username and password (generate password if required).
-
-
Add Package to Maven Bundle:
-
In your locally cloned repository, create a new Maven bundle or add to an existing one.
-
Ensure the structure /jcr_root/apps/fmdita/install exists in the Maven project.
-
Place the downloaded guides-components.all-1.x.x.zip file in the install folder.
-
-
Update filters.xml:
-
Open the filters.xml file located in the META-INF folder of the parent content directory.
-
Add the following filter: filter root=“https://experienceleague.adobe.com/apps/fmdita?lang=en” mode=“merge”/
-
-
Configure pom.xml: Update the pom.xml file as per your environment requirements.
-
Push changes and run Pipeline:
- Push the changes to the main Git repository.
- Navigate to Pipelines in Cloud Manager and run the pipeline for the desired environment.
-
Verify installation: Once the deployment is complete, the components package will be installed on the AEM Cloud environment.
Create Site using installed templates
-
Import Sites Template:
- Go to the AEM Sites page (servername/sites.html/content).
- Select Create > Site from Template.
- Import the sites template aemg-docs-1.x.x.zip using the Import option.
-
Select Template: Select AEMG Docs 1.x.x and then select Next.
-
Enter Site Details: Enter the Site Title and Site Name.
-
Select Create.
Create AEM Site Preset
-
Create a new preset:
-
Open a DITA map in AEM Guides and navigate to the Output panel.
-
Select Create Preset.
-
Select the type as AEM Sites.
-
Enter a name for the preset.
-
Uncheck the Use legacy component mapping setting.
-
Select Add to create the preset.
-
-
Configure AEM Site Preset: There are two options to configure the out-of-the-box (OOTB) site:
Option 1: Use the Site Dropdown
-
Select Site as the one created above (e.g., AEMG Docs Site).
-
Verify that the Publish path and Topic page template are automatically set to:
- Publish path: /content/AEMG-Docs-Site/en/docs/product
- Topic page template: Topic Page
Option 2: Use the Site Path
-
Set the Site path manually as /content/AEMG-Docs-Site/en/docs/product.
-
Verify that the Topic page template is automatically set to Topic Page.
-
-
Save the preset: Save the changes made to the preset.
Generate AEM Sites
-
Generate Site:
- With the preset configured, generate the AEM Site for the corresponding DITA map.
- The generated site will be available at the path: /content/AEMG-Docs-Site/en/docs/product.
-
Change the Default Generation Path (Optional): If you want to change the default path for site generation, perform the following steps:
-
Navigate to AEM Sites.
-
Create a new product page under the OOTB site structure.
-
Navigate to AEMG Docs > English > Docs.
-
Select the Home page tile and then select Next.
-
Enter the Title and Name for the page.
-
Select Create.
-
Refer to the official Deploying to AEM as a Cloud Service documentation for additional details.