Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(sites-29416): [Xwalk] Add support for importing non-image assets #19

Merged
merged 10 commits into from
Mar 6, 2025
37 changes: 7 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ A helpful companion for importing your site to AEM.

- Run large [import](#import) jobs with AEM Import as a Service ([API docs](https://opensource.adobe.com/spacecat-api-service/#tag/import)).
- [Bundle](#bundle) your import scripts.
- Develop import scripts with ease using AI-assisted [commands](#assistant).
- [Import Crosswalk Content](#importing-content-into-AEM) to your AEM author.

## Install
Expand Down Expand Up @@ -74,7 +73,7 @@ Once the import job is complete, the import result will be downloaded from S3, e

## AEM Authoring (Crosswalk) Imports

To perform an Crosswalk import, you will need to provide additional parameters to the invocation. The models, filters, and definition files are
To perform a Crosswalk import, you will need to provide additional parameters to the invocation. The models, filters, and definition files are
required. You must also specify the import `type` as `xwalk` and provide the `siteName` and `assetFolder`.


Expand Down Expand Up @@ -127,29 +126,19 @@ Saving credentials...
Login successful! Credentials saved securely.
```


#### Uploading content to AEM

Run the following command to upload content package (JCR pages) and asociated images to your AEM author:
Run the following command to upload content package (JCR pages) and associated assets to your AEM author:

```
npm run aem-upload
npm run aem-upload -- --zip /path/to/zip.zip --asset-mapping /path/to/asset-mapping.json
```

You’ll be prompted to provide the following details:

* Absolute Path to the Content Package: Path to the .zip file containing JCR pages, generated by the importer tool.
* Absolute Path to the Image Mapping File: Path to `image-mapping.json`, which contains mappings for image urls and their corresponding JCR paths.
The command takes in two arguments:
* zip: Absolute path to the content package ZIP file containing the JCR pages, generated by the importer tool.
* asset-mapping: Absolute Path to the asset mapping file (`asset-mapping.json`), which contains mappings for asset urls and their corresponding JCR paths.


The result will be similar to the following:
```
Checking for credentials...
✔ Enter the absolute path to the content package: /Users/maji/Desktop/test/xwalkdemo.zip
✔ Enter the absolute path to the image-mapping.json file: /Users/maji/Desktop/test/image-mapping.json
```

Ensure that the content and images are successfully uploaded to your AEM instance. Verify the uploaded content through your AEM Author environment.
Ensure that the content and assets are successfully uploaded to your AEM instance. Verify the uploaded content through your AEM Author environment.

## Bundling Multiple Import Scripts

Expand All @@ -168,15 +157,3 @@ npm run bundle -- --importjs tools/importer/import.js
```


## Assistant

Run AI-enabled commands to assist with your import script development.

Add an npm script entry to your Edge Delivery project's `package.json`:

```
"assistant": "aem-import-helper assistant"
```

See [Import Assistant](./docs/import-assistant.md) for usage.

67 changes: 0 additions & 67 deletions docs/import-assistant.md

This file was deleted.

Loading