Skip to content

Move SPO-PS info from sp-dev-docs page to separate reference topics #361

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
VesaJuvonen merged 18 commits into from
Mar 19, 2018
Merged

Move SPO-PS info from sp-dev-docs page to separate reference topics #361

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
3617ac5
Created new topic, added content
Mar 6, 2018
002297f
Added YAML draft scripts; updated TOC page
Mar 6, 2018
a50dc92
Synced this page with TOC
Mar 6, 2018
d72d0b8
Updated YAML sections
Mar 7, 2018
64a4d43
Removed brackets on false headings, updated Example text
Mar 13, 2018
9771f4a
Attempt to fix error
Mar 13, 2018
1dd5f73
Attempt to fix errors #2
Mar 13, 2018
27bdde3
Attempt to fix error #3
Mar 13, 2018
0c16141
Commented out bad code
Mar 13, 2018
ce3bd6d
Formatted NOTEs and added headings
Mar 13, 2018
4ad264a
Attempt to fix error #5
Mar 13, 2018
2c2525d
Removed bad topic
Mar 13, 2018
ebcb2a9
Added DESCRIPTION section
Mar 13, 2018
4a7d875
Fixed broken links
Mar 13, 2018
84249e3
Fixed parameter bugs
Mar 13, 2018
3e0f589
Merge branch 'master' into master
Mar 13, 2018
cb83aa5
Removed extra H2s when not appearing right
Mar 14, 2018
b6681ae
Merge branch 'master' of https://github.com/Linda-Editor/office-docs-…
Mar 14, 2018
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
Prev Previous commit
Next Next commit
Removed brackets on false headings, updated Example text 
Changed example text from "The following example..." to "This example..."
  • Loading branch information
Linda Caputo committed Mar 13, 2018
commit 64a4d43fab0c2e73e0e31df1b7ca9f902fff8eb1
10 changes: 5 additions & 5 deletions sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteDesign.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### [-Description]
### -Description
The display description of the site design.

```yaml
Expand All @@ -87,7 +87,7 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### [-PreviewImageUrl]
### -PreviewImageUrl
The URL of a preview image. If none is specified, SharePoint uses a generic image.

```yaml
Expand All @@ -102,7 +102,7 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### [-PreviewImageAltText]
### -PreviewImageAltText
The alt text description of the image for accessibility.

```yaml
Expand All @@ -117,7 +117,7 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### [-IsDefault]
### -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).

```yaml
Expand All @@ -136,7 +136,7 @@ Accept wildcard characters: False

### Example 1

The following example creates a new site design.
This example creates a new site design.

```powershell
C:\> Add-SPOSiteDesign `
Copy link
Contributor

@davidchesnut davidchesnut Mar 13, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove the "C:>" prompts. Makes it easier for PowerShell devs to copy paste the code.

Copy link
Author

@ghost ghost Mar 13, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated.

Copy link
Author

@ghost ghost Mar 13, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated all instances of C: throughout docs

Expand Down
4 changes: 2 additions & 2 deletions sharepoint/sharepoint-ps/sharepoint-online/Add-SPOSiteScript.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### [-Description]
### -Description
A description of the script.

```yaml
Expand All @@ -73,7 +73,7 @@ Accept wildcard characters: False

### Example 1

The following example adds a new site logo from the following script in a file.
This example adds a new site logo from the following script in a file.

```json
{
Expand Down
4 changes: 2 additions & 2 deletions sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesign.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Get-SPOSiteDesign

## PARAMETERS

### [-Identity]
### -Identity
The ID of the site design to retrieve.

```yaml
Expand All @@ -40,7 +40,7 @@ Accept wildcard characters: False

### Example 1

The following example and sample response shows how to get site design details.
This example and sample response show how to get site design details.

```powershell
PS C:\> Get-SPOSiteDesign 44252d09-62c4-4913-9eb0-a2a8b8d7f863
Copy link
Contributor

@davidchesnut davidchesnut Mar 13, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove "PS C:>" prompt.

Expand Down
4 changes: 2 additions & 2 deletions sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteDesignRights.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Get-SPOSiteDesignRights

## PARAMETERS

### [-Identity]
### -Identity
The ID of the site design to get scoping information.

```yaml
Expand All @@ -40,7 +40,7 @@ Accept wildcard characters: False

### Example 1

The following example gets the rights for a site design.
This example gets the rights for a site design.

```powershell
PS C:\> Get-SPOSiteDesignRights 607aed52-6d61-490a-b692-c0f58a6981a1
Expand Down
4 changes: 2 additions & 2 deletions sharepoint/sharepoint-ps/sharepoint-online/Get-SPOSiteScript.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Get-SPOSiteScript

## PARAMETERS

### [-Identity]
### -Identity
The ID of the site script to get information about.

```yaml
Expand All @@ -40,7 +40,7 @@ Accept wildcard characters: False

### Example 1

The following example shows how to get script information for a specific script ID.
This example shows how to get script information for a specific script ID.

```powershell
PS C:\scripts> Get-SPOSiteScript 07702c07-0485-426f-b710-4704241caad9
Copy link
Contributor

@davidchesnut davidchesnut Mar 13, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove the "PS C:\scripts>" prompt

Expand Down
4 changes: 2 additions & 2 deletions sharepoint/sharepoint-ps/sharepoint-online/Grant-SPOSiteDesignRights.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Grant-SPOSiteDesignRights

## PARAMETERS

### [-Identity]
### -Identity
The ID of the site design to get scoping information.

```yaml
Expand Down Expand Up @@ -72,7 +72,7 @@ Accept wildcard characters: False

### Example 1

The following example shows how to grant view rights on a site design to Nestor (a user at the fictional Contoso site).
This example shows how to grant view rights on a site design to Nestor (a user at the fictional Contoso site).

```powershell
PS C:\> Grant-SPOSiteDesignRights `
Expand Down
4 changes: 2 additions & 2 deletions sharepoint/sharepoint-ps/sharepoint-online/Invoke-SPOSiteDesign.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Invoke-SPOSiteDesign

## PARAMETERS

### [-Identity]
### -Identity
The ID of the site design to apply.

```yaml
Expand Down Expand Up @@ -56,7 +56,7 @@ Accept wildcard characters: False

### Example 1

The following example applies a site design whose script creates two lists, formats several of the columns, adds the lists to the site navigation, and then joins the site to an existing hub site.
This example applies a site design whose script creates two lists, formats several of the columns, adds the lists to the site navigation, and then joins the site to an existing hub site.

```powershell
C:\> Invoke-SPOSiteDesign -Identity 501z8c32-4147-44d4-8607-26c2f67cae82 -WebUrl "https://contoso.sharepoint.com/sites/projectgo”
Copy link
Contributor

@davidchesnut davidchesnut Mar 13, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove the "C:>" prompt

Expand Down
4 changes: 2 additions & 2 deletions sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteDesign.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Removes a site design. It no longer appears in the UI for creating a new site.

## PARAMETERS

### [-Identity]
### -Identity
The ID of the site design to remove.

```yaml
Expand All @@ -41,7 +41,7 @@ Accept wildcard characters: False

### Example 1

The following example shows how to remove a site design.
This example shows how to remove a site design.

```powershell
C:\> Remove-SPOSiteDesign 21209d88-38de-4844-9823-f1f600a1179a
Copy link
Contributor

@davidchesnut davidchesnut Mar 13, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove the "C:>" prompt.

Expand Down
2 changes: 1 addition & 1 deletion sharepoint/sharepoint-ps/sharepoint-online/Remove-SPOSiteScript.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Remove-SPOSiteScript

## PARAMETERS

### [-Identity]
### -Identity
The ID of the site script to remove.

```yaml
Expand Down
4 changes: 2 additions & 2 deletions sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOSiteDesignRights.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Revoke-SPOSiteDesignRights

## PARAMETERS

### [-Identity]
### -Identity
The ID of the site design from which to revoke rights.

```yaml
Expand Down Expand Up @@ -56,7 +56,7 @@ Accept wildcard characters: False

### Example 1

The following example shows how to revoke rights to a site design for Nestor.
This example shows how to revoke rights to a site design for Nestor.

```powershell
PS C:\> Revoke-SPOSiteDesignRights 44252d09-62c4-4913-9eb0-a2a8b8d7f863 `
Expand Down
17 changes: 8 additions & 9 deletions sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteDesign.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ Updates a previously uploaded site design.

```powershell
Set-SPOSiteDesign
-Identity <SPOSiteDesignPipeBind[]>
[-Title <string>]
[-WebTemplate <string>]
[-SiteScripts <SPOSiteScriptPipeBind[]>]
Expand All @@ -36,7 +35,7 @@ Type: String
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Expand All @@ -51,7 +50,7 @@ Type: String
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Expand All @@ -66,14 +65,14 @@ Type: SPOSiteScriptPipeBind
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online
Required: True
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### [-Description]
### -Description
The display description of the site design.

```yaml
Expand All @@ -88,7 +87,7 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### [-PreviewImageUrl]
### -PreviewImageUrl
The URL of a preview image. If none is specified, SharePoint uses a generic image.

```yaml
Expand All @@ -103,7 +102,7 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### [-PreviewImageAltText]
### -PreviewImageAltText
The alt text description of the image for accessibility.

```yaml
Expand All @@ -118,7 +117,7 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### [-IsDefault]
### -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).

```yaml
Expand All @@ -137,7 +136,7 @@ Accept wildcard characters: False

### Example 1

The following example updates a previously created site design.
This example updates a previously created site design.

```powershell
C:\> Set-SPOSiteDesign `
Expand Down
4 changes: 2 additions & 2 deletions sharepoint/sharepoint-ps/sharepoint-online/Set-SPOSiteScript.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### [-Description]
### -Description
A description of the script.

```yaml
Expand All @@ -72,7 +72,7 @@ Accept wildcard characters: False

### Example 1

The following example updates a previously created site script. Any site designs referencing it will execute the updated script.
This example updates a previously created site script. Any site designs referencing it will execute the updated script.

```json
{
Expand Down
1 change: 1 addition & 0 deletions sharepoint/sharepoint-ps/sharepoint-online/sharepoint-online.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Locale: en-US
The following cmdlet references are for SharePoint Online.

## sharepoint-online Cmdlets

### [Add-SPOGeoAdministrator](Add-SPOGeoAdministrator.md)
{{Manually Enter Add-SPOGeoAdministrator Description Here}}

Expand Down