Skip to content

Commit 99bdbcb

Browse files
authored
Update site-design-overview.md (SharePoint#7269)
- Removed all instances of "site design" unless it appears in script - Removed images and instructions from the old create comm site flow - Removed images of the site script banner (outdated) - Turned parameter scripts into a table for easy reading
1 parent bea4447 commit 99bdbcb

File tree

1 file changed

+29
-39
lines changed

1 file changed

+29
-39
lines changed

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

Lines changed: 29 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
2-
title: SharePoint site design and site script overview
3-
description: Use SharePoint site scripts and site designs to provide custom configurations to apply when new sites are created.
2+
title: SharePoint site template and site script overview
3+
description: Use SharePoint site scripts and site templates to provide custom configurations to apply when new sites are created.
44
ms.date: 06/14/2021
55
localization_priority: Priority
66
---
77

8-
# SharePoint site design and site script overview
8+
# SharePoint site template and site script overview
99

1010
> [!NOTE]
11-
> - Site designs and site scripts are currently only supported by SharePoint Online.
11+
> - Site templates and site scripts are currently only supported by SharePoint Online.
1212
> - In previous versions of SharePoint, site templates were called site designs but will be referred to as site templates moving forward.
1313
> - SharePoint has a new site template experience that will be available to all SharePoint user with permissions to create SharePoint sites. [Learn more about the new site template experience](https://support.microsoft.com/office/apply-and-customize-sharepoint-site-templates-39382463-0e45-4d1b-be27-0e96aeec8398?ui=en-US&rs=en-US&ad=US).
1414
> - As of today, the site template experience cannot be disabled.
@@ -35,33 +35,16 @@ You create site templates and register them in SharePoint to one of the modern t
3535

3636
3. Choose **Communication site**.
3737

38-
The Communication site has a **Choose a design** box, which comes with the following site templates:
38+
- SharePoint will automatically create a communication site using the **Topic** site template.
39+
- Had you chosen the default Team site, SharePoint will create a new site useing the **Team collaboration** template.
3940

40-
- Topic
41-
- Showcase
42-
- Blank
41+
For more information about how you can change the default site templates, see [Customize a default site template](customize-default-site-design.md).
4342

44-
These are the default site templates. For each site template, there is a title, description, and image.
43+
When a site template is selected, SharePoint creates the new site, and runs site scripts for the site template. The site scripts provide the details for the template such as creating new lists or applying a theme. These script actions are run in the background. When the scripts are complete the page will refresh to display the site script details.
4544

46-
![Default site design title, description, and image on Communication site template](images/site-designs-listed-on-communication-site-template.png)
45+
The site template information panel can be invoked by a site owner at any time to see what site templates have been applied to the site (and their script details) as well as to apply new or updated site templates. When the actions in the scripts are completed, SharePoint displays detailed results of those actions in a progress pane.
4746

48-
Had you chosen the Team site template, it contains only one default site template named **Team site**.
49-
50-
For more information about how you can change the default site templates, see [Customize a default site design](customize-default-site-design.md).
51-
52-
When a site template is selected, SharePoint creates the new site, and runs site scripts for the site design. The site scripts detail the work such as creating new lists or applying a theme. These script actions are run in the background. A notification bar will be displayed, which the site creator can click to view the status of the actions being applied.
53-
54-
![Notification bar showing application of script actions in progress](images/site-design-notification-bar-in-progress-state.png)
55-
56-
When the scripts are complete the notification bar message will change - allowing the site creator to either refresh the page to see the results of the applied scripts or to view the site script details.
57-
58-
![Notification bar showing application of script actions is complete](images/site-design-notification-bar-completed-state.png)
59-
60-
The site template information panel can be invoked by a site owner at any time to see what site templates have been applied to the site (and their script details) as well as to apply new or updated site templates.
61-
62-
When the actions in the scripts are completed, SharePoint displays detailed results of those actions in a progress pane.
63-
64-
![Site Design Information Panel](images/site-design-information-panel-applied-site-designs.png)
47+
![Site template Information Panel](images/site-design-information-panel-applied-site-designs.png)
6548

6649
> [!NOTE]
6750
> Site templates can now be applied to previously created modern site collections. For more information, see the [REST API](site-design-rest-api.md) and [PowerShell](site-design-powershell.md) articles.
@@ -244,14 +227,21 @@ RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScri
244227

245228
<br/>
246229

247-
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-SPOSiteDesign** cmdlet or **CreateSiteDesign** REST API.
230+
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-SPOSiteDesign** cmdlet or **CreateSiteDesign** REST API.
231+
232+
| Parameter | Value | Site template type |
233+
| :------------------- | :------------------- |:----------------|
234+
| WebTemplate | 64 | Team site template |
235+
| WebTemplate 1 | 64 | Team site (with group creation disabled) |
236+
| WebTemplate | 68 | Communication site template |![image](https://user-images.githubusercontent.com/55893502/130493853-b72bb035-eb03-4d9a-b5f2-87c38d942a11.png)
237+
248238

249-
The **WebTemplate** parameter set to the value 64 indicates registering this site design with the Team site template. If you have disabled modern Group creation, then publish your site designs using WebTemplate 1 so that they display for the "Group-less" Team site template. The value 68 would indicate registering with the Communication site template. The **Title** and **Description** parameters are displayed when a user views site designs as they create a new Team site.
239+
For step-by-step information about creating a site template, see [Get started creating site templates](get-started-create-site-design.md).
250240

251241
> [!NOTE]
252-
> A site template can run multiple scripts. The script IDs are passed in an array, and they run in the order listed.
242+
> - A site template can run multiple scripts. The script IDs are passed in an array, and they run in the order listed.
243+
> - The former term for site templates may still appear in certain cmdlet and script labels as "site design."
253244
254-
For step-by-step information about creating a site template, see [Get started creating site designs](get-started-create-site-design.md).
255245

256246
## PnP provisioning and customization using Power Automate
257247

@@ -273,7 +263,7 @@ The process works as follows:
273263

274264
4. The Azure function runs your custom script, such as the PnP provisioning engine, to apply your custom configurations.
275265

276-
For a step-by-step tutorial about how to configure your own Power Automate flow with PnP provisioning, see [Build a complete site design using the PnP provisioning engine](site-design-pnp-provisioning.md).
266+
For a step-by-step tutorial about how to configure your own Power Automate flow with PnP provisioning, see [Build a complete site template using the PnP provisioning engine](site-design-pnp-provisioning.md).
277267

278268
## Scoping
279269

@@ -286,7 +276,7 @@ The following example shows how to add Nestor (a user at the fictional Contoso s
286276
```powershell
287277
Grant-SPOSiteDesignRights `
288278
-Identity 44252d09-62c4-4913-9eb0-a2a8b8d7f863 `
289-
-Principals "nestorw@contoso.onmicrosoft.com" `
279+
-Principals "[email protected]" `
290280
-Rights View
291281
```
292282

@@ -296,13 +286,13 @@ RestRequest("/_api/Microsoft.SharePoint.Utilities.WebTemplateExtensions.SiteScri
296286
```
297287
-->
298288

299-
For more information about working with scopes, see [Scoping access to site designs](site-design-scoping.md).
289+
For more information about working with scopes, see [Scoping access to site templates](site-design-scoping.md).
300290

301291
## See also
302292

303293
- [Get started creating site template](get-started-create-site-design.md)
304-
- [Apply a scope to your site design](site-design-scoping.md)
305-
- [Site design JSON schema](site-design-json-schema.md)
306-
- [PowerShell cmdlets for SharePoint site designs and site scripts](site-design-powershell.md)
307-
- [Site design and site script REST API](site-design-rest-api.md)
308-
- [Site design examples](https://github.com/SharePoint/sp-dev-site-scripts)
294+
- [Apply a scope to your site template](site-design-scoping.md)
295+
- [Site template JSON schema](site-design-json-schema.md)
296+
- [PowerShell cmdlets for SharePoint site templates and site scripts](site-design-powershell.md)
297+
- [Site template and site script REST API](site-design-rest-api.md)
298+
- [Site template examples](https://github.com/SharePoint/sp-dev-site-scripts)

0 commit comments

Comments
 (0)