Skip to content

Updated file paths and text changes based on new foundation head repo #988

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.

Sign up for GitHub

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

Merged
markvanaalst merged 1 commit into from
Apr 2, 2025
Merged

Updated file paths and text changes based on new foundation head repo #988

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 62 additions & 20 deletions .../accelerate/xm-cloud/pre-development/sprint-zero/setup-content-serialization.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,36 @@ The `sitecore.json` file is located in the root folder of the solution. It comes
```json
{
"$schema": "./.sitecore/schemas/RootConfigurationFile.schema.json",
"modules": ["src/*/*.module.json"]
"modules": [
"authoring/items/**/*.module.json"
],
"plugins": [
"Sitecore.DevEx.Extensibility.Serialization@5.2.113",
"Sitecore.DevEx.Extensibility.Publishing@5.2.113",
"Sitecore.DevEx.Extensibility.Indexing@5.2.113",
"Sitecore.DevEx.Extensibility.ResourcePackage@5.2.113",
"Sitecore.DevEx.Extensibility.XMCloud@1.1.99"
],
"serialization": {
"defaultMaxRelativeItemPathLength": 100,
"defaultModuleRelativeSerializationPath": "items",
"removeOrphansForRoles": true,
"removeOrphansForUsers": true,
"continueOnItemFailure": false,
"excludedFields": []
},
"settings": {
"telemetryEnabled": false,
"cacheAuthenticationToken": true,
"versionComparisonEnabled": true,
"apiClientTimeoutInMinutes": 5
}
}
```

Under `modules`, we can see that all files located in the src folder ending with `.module.json` are considered to check what items should be serialized and what to be excluded.

In the starter kit there is already a file called `renderinghost.module.json` located in `src` folder of the foundation head repository.
In the starter kit there is already a file called `nextjs-starter.module.json` located in `authoring\items` folder of the foundation head repository.

In here, we can find a configuration what items shall be serialized. You can have multiple of these `module.json` files. Just make sure that the namespace field is unique.

Expand Down Expand Up @@ -68,12 +91,31 @@ Items are required to be serialized when they are created by developers and the

### Setup

Please check [`template.module.json`](/learn/accelerate/xm-cloud/appendix-ii/example-code/template-module-json)
Please check [`template.module.json`](/learn/accelerate/xm-cloud/appendix-ii/example-code/template-module-json) It is an example Sitecore Content Serialization (SCS) file that can be used when defining a site collection and site in XM Cloud

Replace the placeholders marked with `<>` with your own data.
Replace the placeholder namespace values with with your own data.

- `<SITE_COLLECTION_NAME>` = your Site Collection Name
- `<SITE_NAME>` = your Site name
- `Project.<SITE_COLLECTION_NAME>` = your Site Collection Name
- `Project.<SITE_NAME>` = your Site name

An example of the foundation head nextjs-starter.module.json is

```json
{
"$schema": "../../.sitecore/schemas/ModuleFile.schema.json",
"namespace": "nextjs-starter",
"items": {
"path": "nextjs-starter",
"includes": [
{
"name": "DefaultRenderingHost",
"path": "/sitecore/system/Settings/Services/Rendering Hosts/Default",
"scope": "singleItem"
}
]
}
}
```

You can include several sites and site collections as needed.

Expand All @@ -95,17 +137,17 @@ This pertains to items intended for developer control and should not be modified

```json
{
"deployItems: {
"modules": [ "Multisite", "Localization", ... ]
},
...
"deployItems: {
"modules": [ "Multisite", "Localization", ... ]
},
...
}
```

<br /><br />
In the given code example, we use `deployItems` to define which module definitions (like `Multisite.module.json`) from our solution will be deployed as Items as Resources (IAR) onto the XM Cloud file system. It is important to remember that you can use wildcards, to simplify the configuration of items.
In the given code example, we use `deployItems` to define which module definitions from our solution will be deployed as Items as Resources (IAR) onto the XM Cloud file system. It is important to remember that you can use wildcards, to simplify the configuration of items.

Here are some examples of items that developers should configure and deploy on the file system:
Here are some examples of items that developers should configure and deploy on the file system (similar to the Sitecore Item paths listed above):

- Modules
- Templates
Expand All @@ -132,14 +174,14 @@ To set up items for the Content Management database, you will need to modify the

```json
{
...,
"postActions": {
"actions": {
"scsModules": {
"modules": [ ... ]
}
}
}
...,
"postActions": {
"actions": {
"scsModules": {
"modules": [ ... ]
}
}
}
}
```

Expand Down