Minor documentation fixes (#3893)

* Update Set-PnPSiteTemplateMetadata.md * Added Connection parameter description * Update Set-PnPSiteGroup.md * Update Set-PnPSiteDesign.md * Update Set-PnPSearchSettings.md * Update Set-PnPRoleDefinition.md * Update Set-PnPRetentionLabel.md * Removed common parameters * Added connection parameter description * Removed common parameters * Update Set-PnPPageWebPart.md * Removed [] from mandatory parameters --------- Co-authored-by: Gautam Sheth <[email protected]>
pnp · Apr 24, 2024 · 0c17265 · 0c17265
1 parent 0d9c4ad
commit 0c17265
Show file tree

Hide file tree

Showing 12 changed files with 198 additions and 160 deletions.
diff --git a/documentation/Set-PnPMinimalDownloadStrategy.md b/documentation/Set-PnPMinimalDownloadStrategy.md
@@ -27,7 +27,7 @@ Set-PnPMinimalDownloadStrategy [-Off] [-Force] [-Connection <PnPConnection>]
 ```
 
 ## DESCRIPTION
-Activates or deactivates the minimal download strategy feature of a site
+Activates or deactivates the minimal download strategy feature of a site.
 
 ## EXAMPLES
 
@@ -76,7 +76,7 @@ Accept wildcard characters: False
 ```
 
 ### -Off
-Turn minimal download strategy off
+Turn minimal download strategy off.
 
 ```yaml
 Type: SwitchParameter
@@ -90,7 +90,7 @@ Accept wildcard characters: False
 ```
 
 ### -On
-Turn minimal download strategy on
+Turn minimal download strategy on.
 
 ```yaml
 Type: SwitchParameter

diff --git a/documentation/Set-PnPPage.md b/documentation/Set-PnPPage.md
@@ -10,12 +10,12 @@ online version: https://pnp.github.io/powershell/cmdlets/Set-PnPPage.html
 # Set-PnPPage
 
 ## SYNOPSIS
-Sets parameters of a page
+Sets parameters of a page.
 
 ## SYNTAX
 
 ```powershell
-Set-PnPPage [-Identity] <PagePipeBind> [-Name <String>] [-Title <String>]
+Set-PnPPage -Identity <PagePipeBind> [-Name <String>] [-Title <String>]
  [-LayoutType <PageLayoutType>] [-PromoteAs <PagePromoteType>] [-CommentsEnabled]
  [-Publish] [-HeaderType <PageHeaderType>] [-HeaderLayoutType <PageHeaderLayoutType>] [-ScheduledPublishDate <DateTime>] 
  [-RemoveScheduledPublish] [-ContentType <ContentTypePipeBind>] [-ThumbnailUrl <String>] [-ShowPublishDate <Boolean>]
@@ -34,49 +34,49 @@ Sets parameters of a page. All pages must be located inside the Site Pages libra
 Set-PnPPage -Identity "MyPage" -LayoutType Home -Title "My Page"
 ```
 
-Updates the properties of the page named 'MyPage'
+Updates the properties of the page named 'MyPage'.
 
 ### EXAMPLE 2
 ```powershell
 Set-PnPPage -Identity "MyPage" -CommentsEnabled
 ```
 
-Enables the comments on the page named 'MyPage'
+Enables the comments on the page named 'MyPage'.
 
 ### EXAMPLE 3
 ```powershell
 Set-PnPPage -Identity "MyPage" -CommentsEnabled:$false
 ```
 
-Disables the comments on the page named 'MyPage'
+Disables the comments on the page named 'MyPage'.
 
 ### EXAMPLE 4
 ```powershell
 Set-PnPPage -Identity "hr/MyPage" -HeaderType Default
 ```
 
-Sets the header of the page called MyPage located in the folder hr inside the Site Pages library to the default header
+Sets the header of the page called MyPage located in the folder hr inside the Site Pages library to the default header.
 
 ### EXAMPLE 5
 ```powershell
 Set-PnPPage -Identity "MyPage" -HeaderType None
 ```
 
-Removes the header of the page
+Removes the header of the page.
 
 ### EXAMPLE 6
 ```powershell
 Set-PnPPage -Identity "MyPage" -HeaderType Custom -ServerRelativeImageUrl "/sites/demo1/assets/myimage.png" -TranslateX 10.5 -TranslateY 11.0
 ```
 
-Sets the header of the page to custom header, using the specified image and translates the location of the image in the header given the values specified
+Sets the header of the page to custom header, using the specified image and translates the location of the image in the header given the values specified.
 
 ### EXAMPLE 7
 ```powershell
 Set-PnPPage -Identity "MyPage" -ScheduledPublishDate (Get-Date).AddHours(1)
 ```
 
-Schedules the page "MyPage" to be published in one hour from now
+Schedules the page "MyPage" to be published in one hour from now.
 
 ### EXAMPLE 8
 ```powershell
@@ -103,24 +103,24 @@ Creates the necessary translated page for the specified languages in the site co
 ```powershell
 Set-PnPPage -Identity "MyPage" -ShowPublishDate $true -Publish
 ```
-Display the date when the page was published in the header section of the page
+Display the date when the page was published in the header section of the page.
 
 ### EXAMPLE 12
 ```powershell
 Set-PnPPage -Identity "MyPage.aspx" -Like
 ```
-Likes the page
+Likes the page.
 
 ### EXAMPLE 11
 ```powershell
 Set-PnPPage -Identity "MyPage.aspx" -Like:$false
 ```
-Unlikes the page
+Unlikes the page.
 
 ## PARAMETERS
 
 ### -CommentsEnabled
-Enables or Disables the comments on the page
+Enables or disables the comments on the page.
 
 ```yaml
 Type: SwitchParameter
@@ -162,7 +162,7 @@ Accept wildcard characters: False
 ```
 
 ### -DemoteNewsArticle
-Demotes an existing news post to a regular page
+Demotes an existing news post to a regular page.
 
 ```yaml
 Type: SwitchParameter
@@ -176,7 +176,7 @@ Accept wildcard characters: False
 ```
 
 ### -HeaderType
-Sets the page header type
+Sets the page header type.
 
 ```yaml
 Type: PageHeaderType
@@ -191,7 +191,7 @@ Accept wildcard characters: False
 ```
 
 ### -HeaderLayoutType
-Sets the page header layout type
+Sets the page header layout type.
 
 ```yaml
 Type: PageHeaderLayoutType
@@ -249,7 +249,7 @@ Accept wildcard characters: False
 ```
 
 ### -PromoteAs
-Allows to promote the page for a specific purpose (None | HomePage | NewsArticle | Template)
+Allows to promote the page for a specific purpose (None | HomePage | NewsArticle | Template).
 
 ```yaml
 Type: PagePromoteType
@@ -278,7 +278,7 @@ Accept wildcard characters: False
 ```
 
 ### -ThumbnailUrl
-Thumbnail Url
+Specifies the URL of a thumbnail image.
 
 ```yaml
 Type: String
@@ -292,7 +292,7 @@ Accept wildcard characters: False
 ```
 
 ### -ShowPublishDate
-Show Published Date in Header
+Shows Published Date in the header.
 
 ```yaml
 Type: Boolean
@@ -348,7 +348,7 @@ Accept wildcard characters: False
 ```
 
 ### -Translate
-Creates multilingual pages for all the languages specified in the site collection
+Creates multilingual pages for all the languages specified in the site collection.
 
 ```yaml
 Type: SwitchParameter
@@ -376,7 +376,7 @@ Accept wildcard characters: False
 ```
 
 ### -Like
-Likes the page, if parameter is set to false then it Unlikes the page
+Likes the page, if parameter is set to false then it Unlikes the page.
 
 ```yaml
 Type: SwitchParameter

diff --git a/documentation/Set-PnPPageTextPart.md b/documentation/Set-PnPPageTextPart.md
@@ -10,17 +10,17 @@ online version: https://pnp.github.io/powershell/cmdlets/Set-PnPPageTextPart.htm
 # Set-PnPPageTextPart
 
 ## SYNOPSIS
-Set text part properties
+Sets text part properties.
 
 ## SYNTAX
 
 ```powershell
-Set-PnPPageTextPart [-Page] <PagePipeBind> -InstanceId <Guid> -Text <String>
+Set-PnPPageTextPart -Page <PagePipeBind> -InstanceId <Guid> -Text <String>
  [-Connection <PnPConnection>] 
 ```
 
 ## DESCRIPTION
-Sets the rendered text in existing client side text component
+Sets the rendered text in existing client side text component.
 
 ## EXAMPLES
 
@@ -48,7 +48,7 @@ Accept wildcard characters: False
 ```
 
 ### -InstanceId
-The instance id of the text component
+The instance id of the text component.
 
 ```yaml
 Type: Guid
@@ -62,7 +62,7 @@ Accept wildcard characters: False
 ```
 
 ### -Page
-The name of the page
+The name of the page.
 
 ```yaml
 Type: PagePipeBind
@@ -76,7 +76,7 @@ Accept wildcard characters: False
 ```
 
 ### -Text
-Text to set
+Text to set.
 
 ```yaml
 Type: String

diff --git a/documentation/Set-PnPPageWebPart.md b/documentation/Set-PnPPageWebPart.md
@@ -10,12 +10,12 @@ online version: https://pnp.github.io/powershell/cmdlets/Set-PnPPageWebPart.html
 # Set-PnPPageWebPart
 
 ## SYNOPSIS
-Set Web Part properties
+Sets web part properties.
 
 ## SYNTAX
 
 ```powershell
-Set-PnPPageWebPart [-Page] <PagePipeBind> -Identity <WebPartPipeBind>
+Set-PnPPageWebPart -Page <PagePipeBind> -Identity <WebPartPipeBind>
  [-Title <String>] [-PropertiesJson <String>] [-Connection <PnPConnection>]
  
 ```
@@ -56,7 +56,7 @@ Accept wildcard characters: False
 ```
 
 ### -Identity
-The identity of the web part. This can be the web part instance id or the title of a web part
+The identity of the web part. This can be the web part instance id or the title of a web part.
 
 ```yaml
 Type: WebPartPipeBind
@@ -70,7 +70,7 @@ Accept wildcard characters: False
 ```
 
 ### -Page
-The name of the page
+The name of the page.
 
 ```yaml
 Type: PagePipeBind

diff --git a/documentation/Set-PnPPlannerPlan.md b/documentation/Set-PnPPlannerPlan.md
@@ -21,13 +21,12 @@ Updates an existing Planner plan.
 
 ### By Group
 ```powershell
-Set-PnPPlannerPlan -Group <PlannerGroupPipeBind> -Plan <PlannerPlanPipeBind> -Title <String>
-  
+Set-PnPPlannerPlan -Group <PlannerGroupPipeBind> -Plan <PlannerPlanPipeBind> -Title <String> [-Connection <PnPConnection>]
 ```
 
 ### By Plan Id
 ```powershell
-Set-PnPPlannerPlan -PlanId <String> -Title <String>  
+Set-PnPPlannerPlan -PlanId <String> -Title <String>  [-Connection <PnPConnection>]
 ```
 
 ## DESCRIPTION
@@ -44,6 +43,22 @@ This example renames the "Conference" plan to "Conference 2020".
 
 ## PARAMETERS
 
+### -Connection
+Optional connection to be used by the cmdlet.
+Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.
+
+```yaml
+Type: PnPConnection
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -Group
 Specify the group id or name of the group owning the plan.
 
@@ -104,9 +119,6 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### CommonParameters
-This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
-
 ## RELATED LINKS
 
 [Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp)