Skip to content
24 changes: 24 additions & 0 deletions src/main/archetype/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,30 @@ A ClientLib will consist of the following files and directories:
- `js.txt` (tells AEM the order and names of files in `js/` so they can be merged
- `resources/`: Source maps, non-entrypoint code chunks (resulting from code splitting), static assets (e.g. icons), etc.


## Maintenance Window Configuration

The generated project includes a default Maintenance Window configuration to support scheduled operations using AEM’s Granite Maintenance Framework.

### Location

The file is located at: ```ui.content/src/main/content/jcr_root/conf/${projectName}/settings/granite/operations/maintenance/default.maintenancewindow.json```

### Default Schedule

- **Day:** Sunday
- **Time:** 3:00 AM to 4:00 AM UTC
- **Applies to:** Both Author and Publish instances via context-aware configuration

This window enables the automated scheduling of maintenance tasks like version purging or workflow purging.

### Customization

You can modify this file to change the schedule or define additional windows. For more information on how AEM handles maintenance tasks, see Adobe’s documentation:

👉 [AEM Maintenance Tasks and Windows](https://experienceleague.adobe.com/docs/experience-manager-65/administering/operations/maintenance-tasks.html)


## Maven settings

The project comes with the auto-public repository configured. To setup the repository in your Maven settings, refer to:
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"task.enabled": true,
"task.name": "${projectName} Version Purge",
"versionpurge.paths": ["/content"],
"versionpurge.maxAgeInDays": 30,
"scheduler.expression": "0 0 3 ? * SUN *"
}
19 changes: 19 additions & 0 deletions src/main/archetype/ui.content/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,22 @@ The ui.content module, like the ui.apps module, uses the FileVault Package plugi
## filter.xml

The `filter.xml` file for the ui.content module is found at `<src>/<project>/ui.content/src/main/content/META-INF/vault/filter.xml` and contains the paths that will be included and installed with the ui.content package. Notice that a `mode="merge"` attribute is added to the path. This ensures that the configurations deployed with a code deployment do not automatically override content or configurations that have been authored on the AEM instance directly.

## Maintenance Window Configuration

This module includes a default Maintenance Window definition used for scheduling automated tasks within AEM.

### File Location

`src/main/content/jcr_root/conf/${projectName}/settings/granite/operations/maintenance/default.maintenancewindow.json`


### Purpose

This file defines a weekly maintenance window that runs every **Sunday from 3:00 AM to 4:00 AM UTC**, allowing AEM to execute registered maintenance tasks such as version purging or workflow cleanup.

It is a context-aware configuration and applies to both Author and Publish instances.

You can customize this JSON to define your own maintenance schedules based on your deployment needs.

📘 For more info, refer to [Adobe’s official documentation on Maintenance Tasks](https://experienceleague.adobe.com/docs/experience-manager-65/administering/operations/maintenance-tasks.html).
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"enabled": true,
"recurrence": "FREQ=WEEKLY;BYDAY=SU",
"start": "03:00:00.000Z",
"duration": "01:00:00"
}