Skip to content

Commit 9dd9c38

Browse files
davidchesnutdavidchesnut
committed
powershell article cleanup
1 parent c4dfc8e commit 9dd9c38

File tree

3 files changed

+53
-16
lines changed

3 files changed

+53
-16
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ You create site designs and register them in SharePoint to one of the modern tem
2424

2525
1. Choose **Communication site**.
2626

27-
The communication site has a **Choose a design** box in which the following three site designs are available out-of-the-box.
27+
The communication site has a **Choose a design** box in which comes with the following site designs.
2828

2929
- Topic
3030
- Showcase
@@ -34,7 +34,7 @@ These are the default site designs. For each site design there is a title, descr
3434

3535
![Default site design title, description, and image on communication site template](images/site-designs-listed-on-communication-site-template.png)
3636

37-
Had you chosen the team site template, it contains only one default site design named **Team site**. For additional information on how you can change the default site designs, see [Applying a site design to a default SharePoint template](customize-default-site-design.md).
37+
Had you chosen the team site template, it contains only one default site design named **Team site**. For additional information on how you can change the default site designs, see [Customize a default site design](customize-default-site-design.md).
3838

3939
Once a site design 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. When the actions in the scripts are completed, SharePoint displays detailed results of those actions in a progress pane.
4040

@@ -230,13 +230,13 @@ By default a site design can be viewed by everyone when it is created. Scopes ar
230230
```powershell
231231
Grant-SPOSiteDesignRights `
232232
-Identity 44252d09-62c4-4913-9eb0-a2a8b8d7f863 `
233-
-Principals "nestorw@contoso.sharepoint.com" `
233+
-Principals "nestorw@contoso.onmicrosoft.com" `
234234
-Rights View
235235
```
236236

237237
<!--
238238
```javascript
239-
RestRequest("/_api/Microsoft.Sharepoint.Utilities.WebTemplateExtensions.SiteScriptUtility.GrantSiteDesignRights", {id:"44252d09-62c4-4913-9eb0-a2a8b8d7f863", principalNames:["nestorw@contoso.sharepoint.com”], grantedRights:1});
239+
RestRequest("/_api/Microsoft.Sharepoint.Utilities.WebTemplateExtensions.SiteScriptUtility.GrantSiteDesignRights", {id:"44252d09-62c4-4913-9eb0-a2a8b8d7f863", principalNames:["nestorw@contoso.onmicrosoft.com”], grantedRights:1});
240240
```
241241
-->
242242
For more information on working with scopes, see [Scoping access to site designs](site-design-scoping.md).

‎docs/declarative-customization/site-design-powershell.md

Lines changed: 47 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Add-SPOSiteDesign
6767
|[-Description] | The display description of site design. |
6868
|[-PreviewImageUrl] | The URL of a preview image. If none is specified SharePoint will use a generic image. |
6969
|[-PreviewImageAltText] | The alt text description of the image for accessibility. |
70-
|[-IsDefault] | A switch that if provided, applies the site design to the default site template. <!-- For more information see [Applying a site design to a default SharePoint template](site-design-apply-default-template.md) --> |
70+
|[-IsDefault] | A switch that if provided, applies the site design to the default site template. For more information see [Customize a default site design](customize-default-site-design.md) |
7171

7272
Here's an example of creating a new site design.
7373

@@ -83,7 +83,8 @@ C:\> Add-SPOSiteDesign `
8383

8484
## **Add-SPOSiteScript**
8585

86-
Uploads a new site script to the gallery for use either directly or in a site design. This cmdlet will support inline script; file
86+
Uploads a new site script to the gallery for use either directly or in a site design.
87+
<!-- TBD does it really appear in the gallery? -->
8788

8889
```powershell
8990
Add-SPOSiteScript
@@ -134,9 +135,7 @@ Here's an example and sample response of getting site design details.
134135

135136
```powershell
136137
PS C:\> Get-SPOSiteDesign 44252d09-62c4-4913-9eb0-a2a8b8d7f863
137-
```
138138
139-
```
140139
Id : 44252d09-62c4-4913-9eb0-a2a8b8d7f863
141140
Title : Contoso - Team Project
142141
WebTemplate : 64
@@ -165,12 +164,10 @@ Here's an example of getting the rights for a site design.
165164

166165
```powershell
167166
PS C:\> Get-SPOSiteDesignRights 607aed52-6d61-490a-b692-c0f58a6981a1
168-
```
169167
170-
```
171168
DisplayName PrincipalName Rights
172169
----------- ------------- ------
173-
Nestor Wilke i:0#.f|membership|nestorw@contoso.sharepoint.com View
170+
Nestor Wilke i:0#.f|membership|nestorw@contoso.onmicrosoft.com View
174171
```
175172

176173
## Get-SPOSiteScript
@@ -189,6 +186,28 @@ Get-SPOSiteScript
189186
|--------------|--------------|
190187
| [-Identity] | The ID of the site script to get information about. |
191188

189+
Here's an example that shows how to get script information for a specific script ID.
190+
191+
```powershell
192+
PS C:\scripts> Get-SPOSiteScript 07702c07-0485-426f-b710-4704241caad9
193+
194+
Id : 07702c07-0485-426f-b710-4704241caad9
195+
Title : Contoso theme
196+
Description :
197+
Content : {
198+
"$schema": "schema.json",
199+
"actions": [
200+
{
201+
"verb": "applyTheme",
202+
"themeName": "Custom Cyan"
203+
}
204+
],
205+
"bindata": { },
206+
"version": 1
207+
}
208+
Version : 1
209+
```
210+
192211
## Grant-SPOSiteDesignRights
193212

194213
Used to apply permissions to set of users or security group, effectively scoping visibility of site design in UX. They start off public. But once you set permissions, only those groups or users with permissions can access the site design.
@@ -214,7 +233,7 @@ Here's an example of how to grant view rights on a site design to Nestor (a user
214233
```powershell
215234
PS C:\> Grant-SPOSiteDesignRights `
216235
-Identity 44252d09-62c4-4913-9eb0-a2a8b8d7f863 `
217-
-Principals "nestorw@contoso.sharepoint.com" `
236+
-Principals "nestorw@contoso.onmicrosoft.com" `
218237
-Rights View
219238
```
220239

@@ -234,6 +253,12 @@ Removes a site design. It will no longer appear in the UI for creating a new sit
234253
|--------------|--------------|
235254
| [-Identity] | The ID of the site design to remove. |
236255

256+
Here's an example that shows how to remove a site design.
257+
258+
```powershell
259+
260+
```
261+
237262
## Remove-SPOSiteScript
238263

239264
Removes a site script. <!-- TBD how is dependency problem handled so you don't delete a script that a design depends on. this currently creates an error when running the design.) -->
@@ -250,6 +275,10 @@ Remove-SPOSiteScript
250275
|--------------|--------------|
251276
| [-Identity] | The ID of the site script to remove. |
252277

278+
```powershell
279+
C:\> Remove-SPOSiteDesign 21209d88-38de-4844-9823-f1f600a1179a
280+
```
281+
253282
## Revoke-SPOSiteDesignRights
254283

255284
Revokes rights for specified principals from a site design.
@@ -268,12 +297,20 @@ Revoke-SPOSiteDesignRights
268297
| [-Identity] | The ID of the site design from which to revoke rights. |
269298
| -Principals | One or more principals to revoke rights on the specified site design. |
270299

300+
Here's an example that shows how to revoke rights to a site design for Nestor.
301+
302+
```powershell
303+
PS C:\> Revoke-SPOSiteDesignRights 44252d09-62c4-4913-9eb0-a2a8b8d7f863 `
304+
-Principals "[email protected]"
305+
```
306+
271307
<!--
272308
## Set-SPOSiteDesign (TBD)
273309
274310
## Set-SPOSiteScript (TBD)
275311
-->
276312

277-
Developers can also use the SharePoint [REST API](site-design-rest-api.md) to handle theme management tasks.
313+
## See also
278314

279-
For information about how themes are defined and stored, see the [JSON schema reference](site-design-json-schema.md).
315+
- [JSON schema reference](site-design-json-schema.md)
316+
- [REST API](site-design-rest-api.md)Apply a scope to your site design](site-design-scoping.md)

‎docs/declarative-customization/site-design-scoping.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Here's an example of how to grant view rights on a site design to Nestor (a user
4747
```powershell
4848
PS C:\> Grant-SPOSiteDesignRights `
4949
-Identity 44252d09-62c4-4913-9eb0-a2a8b8d7f863 `
50-
-Principals "nestorw@contoso.sharepoint.com" `
50+
-Principals "nestorw@contoso.onmicrosoft.com" `
5151
-Rights View
5252
```
5353

@@ -62,7 +62,7 @@ PS C:\> Get-SPOSiteDesignRights 607aed52-6d61-490a-b692-c0f58a6981a1
6262
```
6363
DisplayName PrincipalName Rights
6464
----------- ------------- ------
65-
Nestor Wilke i:0#.f|membership|nestorw@contoso.sharepoint.com View
65+
Nestor Wilke i:0#.f|membership|nestorw@contoso.onmicrosoft.com View
6666
```
6767

6868
## Revoking rights from a site design

0 commit comments

Comments
 (0)