Skip to content

Commit feaf923

Browse files
authored
Update site-design-overview.md
Updates for spring release in progress. Do not publish to live branch until after 4/9 (confirm w/ Sean and Vesa)
1 parent 463e41d commit feaf923

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

docs/declarative-customization/site-design-overview.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
---
1+
--
22
title: SharePoint site design and site script overview
33
description: Use SharePoint site scripts and site designs to automate provisioning new SharePoint sites with custom configurations.
4-
ms.date: 01/08/2018
4+
ms.date: 04/08/2018
55
---
66

77
# SharePoint site design and site script overview
@@ -13,7 +13,7 @@ Use site designs and site scripts to automate provisioning new or existing moder
1313

1414
## How site designs work
1515

16-
Site designs are like a template. They can be used each time a new site is created to apply a consistent set of actions. They can also be applied to existing modern sites (Group-connected Team and communication). Most actions typically affect the site itself, such as setting the theme, or creating lists. But a site design can also include other actions, such as recording the new site URL to a log, or sending a tweet.
16+
Site designs are like a template. They can be used each time a new site is created to apply a consistent set of actions. They can also be applied to existing modern sites (Group-connected Team and Communication). Most actions typically affect the site itself, such as setting the theme, or creating lists. But a site design can also include other actions, such as recording the new site URL to a log, or sending a tweet.
1717

1818
You create site designs and register them in SharePoint to one of the modern template sites: the team site, or communication site. You can see how this works in the following steps.
1919

@@ -94,7 +94,6 @@ Site scripts are JSON files that specify an ordered list of actions to run when
9494
]
9595
}
9696
],
97-
"bindata": { },
9897
"version": 1
9998
}
10099
```
@@ -103,17 +102,25 @@ Each action in a site script is specified by a **verb** value in the JSON. In th
103102

104103
Available actions include:
105104

106-
- Creating a new list
105+
- Creating a new list or library (or modifying the default one created with the site)
106+
- Creating site columns, content types, and configuring other list settings
107107
- Applying a theme
108108
- Setting a site logo
109109
- Adding navigation
110-
- Triggering a Microsoft flow
110+
- Triggering a Microsoft Flow
111+
- Installing a deployed solution from the app catalog
112+
- Setting regional settings for the site
113+
- Setting external sharing capability for the site
114+
115+
For a complete list of available actions and their parameters, check out the JSON schema: https://docs.microsoft.com/en-us/sharepoint/dev/declarative-customization/site-design-json-schema
111116

112-
Site scripts can be run again on the same site after provisioning. This can only be done programmatically. Site scripts are non-destructive, so when they run again, they ensure that the site matches the configuration in the script. For example, if the site already has a list with the same name that the site script is creating, the site script will only add missing fields to the existing list. Also, please note that site scripts are limited to 30 cumulative actions (across one or more scripts that may be called in a site design).
117+
Site scripts can be run again on the same site after provisioning. This can only be done programmatically. Site scripts are non-destructive, so when they run again, they ensure that the site matches the configuration in the script. For example, if the site already has a list with the same name that the site script is creating, the site script will only add missing fields to the existing list. Also, please note that site scripts are limited to 30 cumulative actions (across one or more scripts that may be called in a site design). This includes subactions.
113118

114119
## Using PowerShell or REST to work with site designs and site scripts
115120

116-
You can create site designs and site scripts by using PowerShell, or the REST API. The following example creates a site script and a site design that uses the site script. <!-- The PowerShell example loads the script from a file, while the REST example has the script inline. -->
121+
You can create site designs and site scripts by using PowerShell, or the REST API. The following example creates a site script and a site design that uses the site script.
122+
123+
<!-- The PowerShell example loads the script from a file, while the REST example has the script inline. -->
117124

118125
```powershell
119126
C:\> Get-Content 'c:\scripts\site-script.json' `
@@ -194,6 +201,7 @@ RestRequest("/_api/Microsoft.Sharepoint.Utilities.WebTemplateExtensions.SiteScri
194201
}
195202
});
196203
```
204+
197205
-->
198206

199207
In the previous example, the **Add-SPOSiteScript** cmdlet, or **CreateSiteScript** REST API returns a site script id. This is used for the **SiteScripts** parameter in the subsequent call to the **Add-SPO-SiteDesign** cmdlet, or **CreateSiteDesign** REST API.

0 commit comments

Comments
 (0)