Skip to content

Commit 8ccba32

Browse files
committed
more work on overview site design
1 parent 508451a commit 8ccba32

File tree

3 files changed

+45
-34
lines changed

3 files changed

+45
-34
lines changed

docs/declarative-customization/get-started-create-site-design.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Get started customizing sites by using site designs
1+
# Get started creating site designs
22

33
Build site designs to provide reusable lists, themes, layouts, pages, or custom actions so that your users can quickly build new SharePoint sites with the features they need. In this article you'll build a simple site design that adds a SharePoint list for tracking customer orders. Then you'll use the site design to create a new SharePoint site with the custom list.
44

Loading
Lines changed: 44 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,39 @@
11
---
2-
# Mandatory fields. See more on aka.ms/skyeye/meta.
3-
title: Site designs and site scripts
2+
title: SharePoint site design and site script overview
43
description: Use site scripts and site designs to automate provisioning new SharePoint sites with custom configurations.
54
ms.date: 11/19/2017
65
---
76

8-
# Overview of site design
9-
When people in your organization create new SharePoint sites, you often need to ensure proper branding and theming is applied to each new site. People and teams may need a set of standard configurations that they can use repeatedly for each new site. You may also have complicated site provisioning scripts that need to be repeated each time a new site is created. You can use site designs and site scripts to automate provioning new SharePoint sites using your own custom configurations.
7+
# SharePoint site design and site script overview
8+
9+
Use site designs and site scripts to automate provisioning new SharePoint sites using your own custom configurations. When people in your organization create new SharePoint sites, you often need to ensure some level of consistency. For example, you may need proper branding and theming applied to each new site. You may also have detailed site provisioning scripts, such as using the PnP provisioning engine, that need to be applied each time a new site is created. This article describes how you can use site designs and site scripts to provide custom configurations to apply when new sites are created.
10+
11+
## How site designs work
12+
13+
You create site designs and register them in SharePoint to one of the modern template sites; the team site, or communication site. Site designs appear in a drop down list when someone creates a new site from one of the templates. Each site design has a title, description, and will run one or more scripts to create the new site as specified in the design.
14+
15+
![site designs appear in drop down list under communication site](images/site-designs-listed-on-communication-site-template.png)
16+
17+
Once a site design is selected, SharePoint creates the new site, and then runs any scripts registered with the site design. The script performs actions such as creating new lists, or applying a theme. Each action is recorded in a local list. When the scripts are done, SharePoint displays the results from the list in a progress pane.
18+
19+
![Progress pane listing completed actions from a site design](images/progress-pane.png)
20+
21+
You can create a site design by using PowerShell, CSOM, or the REST API. Here's an example of creating a new site design for the purpose of applying company branding.
1022

1123
```
12-
TBD need overview image
24+
TBD Powershell example of creating site design for brand (show isdefault)
1325
```
1426

27+
You can also make a site design the default for the team or communication site template. Then when someone chooses only the template, you can still apply a custom design. This is done by setting the **IsDefault** property to true as shown previously.
28+
29+
For more information, see [Get started creating site designs](get-started-create-site-design.md)
30+
1531
## Anatomy of a site script
1632

1733
Site scripts are JSON files that specify an ordered list of actions to run when creating the new site. Here's an example of a script with only one action that simply applies the blue yonder theme.
1834

19-
```javascript
20-
var site_script = {
35+
```json
36+
{
2137
"$schema": "schema.json",
2238
"actions": [
2339
{
@@ -30,57 +46,52 @@ var site_script = {
3046
}
3147
```
3248

33-
Site scripts can apply themes, create lists, create pages, add navigation links, and set the logo. They can also trigger a Microsoft Flow in which you can specify any additional custom action you want.
49+
Each action in a site script is specified by a **verb** in the JSON.
3450

35-
You can create site scripts by using PowerShell, CSOM, or the REST API. The following example shows how to create a new site script.
51+
Actions include:
3652

37-
```
38-
TBD: example powershell creating site script
39-
```
53+
- Creating a new list
54+
- Applying a theme
55+
- Creating a page
56+
- Setting a site logo
57+
- Adding navigation
58+
- Triggering a Microsoft flow
4059

41-
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.
42-
43-
## How site designs work
44-
45-
Site designs incorporate site scripts into the SharePoint user interface for creating new sites. They appear in a dropdown list when creating either a team site, or communication site. A site design has a title, and description, and specify one or more scripts to run.
46-
47-
![site designs appear in drop down list under communication site](images/site-designs-listed-on-communication-site-template.png)
48-
49-
You can create a site design by using PowerShell, CSOM, or the REST API. The following example shows how to create a new site design for the team site template.
60+
You can create site scripts by using PowerShell, CSOM, or the REST API. Here's an example of how to create a site script that applies the Blue Yonder theme.
5061

5162
```
52-
TBD powershell example creating a new site design
63+
TBD PowerShell example create a script for blue yonder theme
5364
```
5465

55-
When someone creates a new site, and selects a site design, SharePoint creates the new site, and then runs any scripts registered with the site design. Each action is recorded in a local list. When the scripts are done, SharePoint displays the results from the list in a progress pane.
66+
For more information, see [Get started creating site designs](get-started-create-site-design.md)
5667

57-
```
58-
TBD image of progress pane
59-
```
68+
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.
6069

6170
## PnP Provisioning and customization using Microsoft Flow
6271

63-
If you use the PnP provisioning engine to automate site creation you can integrate with site designs to maintain your current provisioning scripts. Site designs provide an action to trigger a Microsoft flow. This allows you to run any custom action you want, including running the PnP provisioning engine.
72+
One action provided by site scripts is the ability to trigger a Microsoft flow. This allows you to specify any custom action you need beyond the actions provided natively in site scripts.
73+
74+
If you use the PnP provisioning engine to automate site creation, then you can use a Microsoft flow to integrate with site designs. You can continue maintaining all of your existing provisioning scripts as well as creating new customizations using this technique.
6475

6576
![process of triggering a Microsoft flow](images/process-for-triggering-a-custom-flow.png)
6677

6778
The process works as follows:
79+
6880
1. The script instantiates your Microsoft flow using a URL with additional details.
6981
1. The flow sends a message to an Azure storage queue that you have configured.
7082
1. The message triggers a call to an Azure function that you have configured.
7183
1. The Azure function runs your custom script, such as the PnP provisioning engine, to apply your custom configurations.
7284

73-
For a step-by-step tutorial on how to configure this, see [Build a complete site design using the PnP provisioning engine](site-design-pnp-provisioning)
85+
For a step-by-step tutorial on how to configure your own Microsoft flow with PnP provisioning, see [Build a complete site design using the PnP provisioning engine](site-design-pnp-provisioning)
7486

7587
## Scoping
7688

77-
You can configure site designs to only appear for specific groups or people in your organization. This is useful to ensure that people only see the site designs intended for them. For example, the accounting department can see only site designs that apply to them.
89+
You can configure site designs to only appear for specific groups or people in your organization. This is useful to ensure that people only see the site designs intended for them. For example, you may want the accounting department to only see site designs specific for them. And the accounting site designs may not make sense to show to anyone else.
7890

79-
Scopes are applied when you register a site design. You can specify the scope by user, Office 365 group, or a mail-enabled security group. The following example shows how to register a site design for just the accounting Office 365 group.
91+
Scopes are applied when you register a site design. You can specify the scope by user, Office 365 group, or a mail-enabled security group. Here is an example of registering a site design for only the accounting Office 365 group:
8092

8193
```
82-
TBD powershell example scope
94+
TBD: PowerShell example register a scoped site design
8395
```
8496

85-
For more information, see
86-
* TBD(links to PowerShell cmdlet, CSOM, and REST refs)
97+
For more information, see [Apply a scope to your site design](site-design-scopes.md).

0 commit comments

Comments
 (0)