-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
6f1b1b9
commit 41605a5
Showing
28 changed files
with
1,177 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions
4
public/images/implementation/headless-architecture-source.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions
4
public/images/implementation/implementation-overview-source.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file was deleted.
Oops, something went wrong.
16 changes: 16 additions & 0 deletions
16
src/content/docs/implementation/discovery/data-export-validation.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
--- | ||
title: Data export validation | ||
description: Learn how to validate data exports from your Adobe Commerce backend to your storefront. | ||
--- | ||
|
||
Data export synchronizes data between an Adobe Commerce instance and connected storefront services. | ||
|
||
Validating the data export is crucial to ensure that the data is correctly synchronized and available for the storefront. You can use the [Data Management Dashboard](https://experienceleague.adobe.com/en/docs/commerce-admin/systems/data-transfer/data-dashboard) to monitor the data sync progress for each service. | ||
|
||
:::tip[Self-service data export validation] | ||
See the [_SaaS Data Export Guide_](https://experienceleague.adobe.com/en/docs/commerce-merchant-services/saas-data-export/overview) for details and troubleshooting. | ||
::: | ||
|
||
Use GraphQL to validate that all products were synchronized and product lookup and search are working. See [GraphQL queries](https://developer.adobe.com/commerce/services/graphql/catalog-service/products/) and [Postman sample collection](https://github.com/magento/adobe-commerce-catalog-service) for queries. | ||
|
||
For more complex catalogs, reach out to the Adobe team on Slack to validate that the exported data is correct. This might require you to provide a database dump or direct access. Please also reach out to the Adobe team if you encounter any currently un-supported use cases, so that they can be enabled in the future. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
--- | ||
title: Discovery and preparation | ||
description: Learn about Adobe Commerce on Edge Delivery Services project requirements, data validation, dropins, and Luma Bridge. | ||
--- | ||
|
||
Before starting any Adobe Commerce on Edge Delivery Services project, you must conduct a discovery phase to scope the project and ensure that there are no major roadblocks or risks. | ||
|
||
The discovery phase is important because Adobe Commerce is a highly customizable platform with a large thid-party extension ecosystem. Migrating an Adobe Commerce storefront to Edge Delivery Services is similar to migrating to a headless storefront (like [PWA Studio](https://developer.adobe.com/commerce/pwa-studio)). | ||
|
||
:::note[Important] | ||
The key requirement for a headless storefront implementation is that all required data is provided by APIs. Adobe Commerce provides all of the API coverage that you need for a successful implementation. | ||
::: | ||
|
||
## Review Commerce requirements | ||
|
||
Before starting the project, ensure that your Adobe Commerce backend meets the following requirements: | ||
|
||
* **Product license**: Cloud or on-premises (Magento Open Source is not supported) | ||
* **Version**: v2.4.7 | ||
* **PHP**: 8.3/8.2 for Adobe Commerce 2.4.7 | ||
* **Storefront services**: Ensure that the following services are installed and configured: | ||
* Data Connection service | ||
* Services Connector | ||
* Catalog Sync service | ||
* Catalog Service | ||
* Live Search | ||
* Product Recommendations | ||
|
||
See [Commerce requirements](/implementation/discovery/requirements/) for more information. | ||
|
||
## Identify extensions | ||
|
||
Before starting the project, use the following list to create an inventory of the Adobe Commerce extensions that are actively being used. This will help you understand which extensions can be replaced by out-of-the-box Adobe Commerce functionality. | ||
|
||
* What extensions are currently in use? | ||
|
||
* What type of data do the extensions provide (for example, reviews)? | ||
|
||
* Is the data required on the frontend? | ||
|
||
* How do the extensions expose the data (for example, GraphQL, REST API)? | ||
|
||
* Do the extensions expose an API to access data (for example, [Amasty Labels](https://amasty.com/docs/doku.php?id=magento_2:product_labels))? If not, create an action item to expose the required data through an API. Options include: | ||
|
||
* Customize the Adobe Commerce Catalog Service exporter to export additional custom data to Catalog Service | ||
* Create a custom Adobe Commerce GraphQL query | ||
* Use [API Mesh for Adobe Developer App Builder](https://developer.adobe.com/graphql-mesh-gateway/) | ||
|
||
* Are any of the extensions for delivery options (for example, shipping/BOPIS), payments, or tax providers? If you use third-party solutions, clarify if they expose APIs on the frontend and if they provide their own set of dropin components for the frontend integration. | ||
|
||
## Validate option for dropins/widgets | ||
|
||
Dropins are re-useable components that define the storefront shopping experience. They are framework agnostic and can be used in any context (Edge Delivery Services, AEM, Luma). However, this documentation focuses on the use of dropins in Edge Delivery Services projects using the [boilerplate template](https://github.com/hlxsites/aem-boilerplate-commerce). The dropin development roadmap is synchronised with Adobe Commerce APIs, so new API features are automatically available in dropins and widgets. | ||
|
||
Storefront widgets in Adobe Commerce Live Search are tools that enhance the search functionality on your site. Widgets are designed to improve the user experience by making search results more accessible and relevant. There are two main types of widgets: | ||
|
||
* **[Live Search Popover](https://experienceleague.adobe.com/en/docs/commerce-merchant-services/live-search/live-search-storefront/storefront-popover)**: This widget appears as a box under the search field, displaying search results dynamically as users type their queries. | ||
* **[Product Listing Page (PLP)](https://experienceleague.adobe.com/en/docs/commerce-merchant-services/live-search/live-search-storefront/plp-styling)**: This widget provides a searchable product listing page with facets and synonym support, making it easier for users to find products. | ||
|
||
:::note | ||
See the [dropins overview](/dropins/all/introduction/) for a list of all available dropins. | ||
::: | ||
|
||
### Use cases and requirements | ||
|
||
Document your use cases and requirements. If there are gaps, the Adobe team can help you understand how to fill them. | ||
|
||
The Live Search Popover and PLP has two integration paths: | ||
|
||
* Using the out-of-the-box hosted option where Adobe hosts the JavaScript file | ||
|
||
* Automatic updates for fixes and small features | ||
* Small upgrades available for major or breaking features | ||
* Can change some styling | ||
|
||
* Using the customized option where Adobe provides a reference implementation for the components | ||
|
||
* Full control of customization and look and feel | ||
* You host the library and own the total cost of ownership |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
title: Luma Bridge | ||
description: Learn how to implement the Luma Bridge for your Adobe Commerce on Edge Delivery Services project. | ||
--- | ||
|
||
This section provides guidance on how to implement the Luma Bridge for your Adobe Commerce on Edge Delivery Services project. | ||
|
||
Before starting an implementation, clarify the following: | ||
|
||
* Architecture of the cart, checkout, and account pages | ||
* Complexity of the cart, checkout, and account pages | ||
* Requirements for customization of the cart, checkout, and account pages | ||
|
||
This information will help you decide whether to use Luma Bridge or a headless implementation for the cart, checkout, and account pages. | ||
|
||
## What is Luma Bridge? | ||
|
||
Luma bridge is an implementation for Adobe Commerce on Edge Delivery Services projects where the complex transactional part of the store (cart, checkout, account) is reused instead of being rebuilt during the project. | ||
|
||
If the previous discovery steps led to the conclusion that dropins can be used for cart, checkout, and account experiences, Luma Bridge is not necessary or can be reduced to parts that are not covered by dropins (for example, complex customizations). If existing headless implementations for cart, checkout, and account ([PWA Studio](https://github.com/magento/pwa-studio), [Vue Storefront](https://vuestorefront.io/)) are available, Luma Bridge is not necessary. | ||
|
||
Rebuilding the cart, checkout, and account pages as part of a project is usually not feasible. Instead, Adobe recommends reusing existing cart, checkout, and account pages based on Luma PHP. You can use Luma Bridge to route the shopper to the PHP-based cart, checkout, and account pages. | ||
|
||
:::note | ||
Be aware that with a side-by-side/Luma Bridge implementation, you will not achieve a 100 Lighthouse score on cart, checkout, and account pages. | ||
::: | ||
|
||
## Where can I get it? | ||
|
||
Luma Bridge is available from the following providers: | ||
|
||
* Adobe Consulting (reach out via Slack) | ||
* Atwix (https://www.atwix.com/) | ||
* Atama ([open source](https://github.com/AtamaCo/luma-bridge), https://www.atama.co/) | ||
|
||
:::tip | ||
When using Luma Bridge, ensure that you have engineers on the project with backend PHP knowledge on Adobe Commerce. | ||
::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.