[templates/angular-xmcloud][templates/node-xmcloud-proxy] Angular and XM Cloud Proxy Readme updates #1989
Conversation
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
stasmaxymov
reviewed
Dec 2, 2024
packages/create-sitecore-jss/src/templates/angular-xmcloud/README.md
Outdated
Show resolved
Hide resolved
stasmaxymov
reviewed
Dec 2, 2024
packages/create-sitecore-jss/src/templates/node-xmcloud-proxy/README.md
Outdated
Show resolved
Hide resolved
mattcantcode
suggested changes
Dec 6, 2024
There was a problem hiding this comment.
Most comments relate to Angular. I added some to the Node proxy readme too, but these are mostly addressed in this Word doc: https://sitecore1-my.sharepoint.com/:w:/g/personal/matp_sitecore_net/EYtEb9QYkGFLtNAW5AcyTU8BVp8ciAuaKI4g9Qxz4eY3Tg?e=s0Koma
| @@ -1,60 +1,89 @@ | |||
| # Angular for XMCloud | |||
|
|
|||
| > Sitecore JSS Angular App for XM Cloud. For the current release this feature is experimental. | |||
| > Sitecore JSS Angular App for XM Cloud. For the current release this feature is in public beta. | |||
| > If you encounter any issues or bugs, please submit a new issue in the [Jss GitHub Repo](https://github.com/Sitecore/jss) | |||
There was a problem hiding this comment.
Angular for XMCloud>Angular for XM Cloud
| @@ -1,60 +1,89 @@ | |||
| # Angular for XMCloud | |||
|
|
|||
| > Sitecore JSS Angular App for XM Cloud. For the current release this feature is experimental. | |||
| > Sitecore JSS Angular App for XM Cloud. For the current release this feature is in public beta. | |||
There was a problem hiding this comment.
"For the current release this feature is in public beta" > "This feature is currently in public beta."
| This Single Page Application (SPA) built with Angular is designed to be fully compatible with XM Cloud, incorporating several key add-ons and features to streamline the development process and enable seamless integration. | ||
|
|
||
| The Angular XM Cloud integration consists of two parts: | ||
| - `XM Cloud Angular`: simplifies connecting the application to XM Cloud and configuring the integration of multiple composable Sitecore products, provides out of the box helper components. |
There was a problem hiding this comment.
"provides out of the box helper components." > "and provides out-of-the-box helper components."
|
|
||
| The Angular XM Cloud integration consists of two parts: | ||
| - `XM Cloud Angular`: simplifies connecting the application to XM Cloud and configuring the integration of multiple composable Sitecore products, provides out of the box helper components. | ||
| - `XM Cloud Proxy`: Adds integration with XM Cloud for the JSS SPA applications and enables editing, personalization and A/B component testing support, see [XM Cloud Proxy](../node-xmcloud-proxy/) |
There was a problem hiding this comment.
", see XM Cloud Proxy" > ". See XM Cloud Proxy for more information."
| - `XM Cloud Angular`: simplifies connecting the application to XM Cloud and configuring the integration of multiple composable Sitecore products, provides out of the box helper components. | ||
| - `XM Cloud Proxy`: Adds integration with XM Cloud for the JSS SPA applications and enables editing, personalization and A/B component testing support, see [XM Cloud Proxy](../node-xmcloud-proxy/) | ||
|
|
||
| The supported key features are as follows: |
There was a problem hiding this comment.
"The following key features are supported:"
|
|
||
| This proxy will serve as the backbone for supporting various SPA frameworks by handling server-side rendering (SSR), data queries, and middleware functionalities. | ||
| This Node.js-based proxy app is the backbone for enabling seamless integration between XM Cloud and various SPA frameworks like React, Angular, or Vue laying the groundwork for future JSS starter kits built for other front-end JavaScript frameworks. It acts as a middleware layer to handle critical functionalities such as server-side rendering (SSR), enabling editing and personalization, A/B component testing, and integrating Sitecore Forms. By serving as the rendering host, it ensures a smooth connection between Sitecore XM Cloud services and your front-end applications, making it easier to build dynamic, personalized, and localized experiences for users. |
|
|
||
| ## Features Supported | ||
|
|
||
| - `Context ID`: The Context ID environment variable simplifies setting up and configuring XM Cloud solutions. It's a unified identifier that maps to all your configured resources, such as content, sites, files, forms, and integration settings. | ||
|
|
||
| - `XM Cloud Pages editing integration`: full integration with Pages - the dynamic visual page editor of XM Cloud. | ||
|
|
||
| - `XM Cloud proxy personalization` with embedded personalization and A/B Component Test support. | ||
| - `XM Cloud proxy personalization` with embedded personalization and Component A/B Testing support. |
| > The following features and integrations are not supported by Node XM Cloud Proxy: | ||
| > - Multisite | ||
| > - XM CLoud Components application | ||
| > - BYOC components |
There was a problem hiding this comment.
As elsewhere, please confirm with Anastasia whether we need to say BYOC here as well as the components app.
| The config.ts file in this proxy app handles essential configurations for server-side rendering, data queries, and middleware functionalities. Here are the main configurations defined: | ||
| > The following features and integrations are not supported by Node XM Cloud Proxy: | ||
| > - Multisite | ||
| > - XM CLoud Components application |
There was a problem hiding this comment.
"The XM Cloud Components application"
| @@ -49,21 +58,25 @@ This configuration is designed to be flexible and secure, with dynamic settings | |||
|
|
|||
| ### Environment Variables | |||
|
|
|||
| The following environment variables can be set to configure the Proxy sample instead of modifying `config.js`. You can use the `.env` file located in the root of the app or set these directly in the environment (for example, in containers). | |||
| The following environment variables can be set to configure the Node XM Cloud Proxy app instead of modifying `config.js`. You can use the `.env` file located in the root of the app or set these directly in the environment (for example, in containers). | |||
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description / Motivation
This PR includes Angular for XM Cloud and XM Cloud Node Proxy Readme updates, according to lates feedback from PSS.
Testing Details
Types of changes