Some documentation fixes (#3793)

* Update Update-PnPApp.md * Update Unregister-PnPHubSite.md * Update Unpublish-PnPApp.md * Removed WhatIf parameter * Update Test-PnPSite.md Added Connection parameter * Update Sync-PnPAppToTeams.md * Added Connection parameter * Update Test-PnPSite.md * Update Stop-PnPFlowRun.md * Update Set-PnpTeamsChannelUser.md * Added parameter descriptions --------- Co-authored-by: Gautam Sheth <[email protected]>
pnp · Feb 28, 2024 · bbfbf82 · bbfbf82
1 parent 489e8c9
commit bbfbf82
Show file tree

Hide file tree

Showing 9 changed files with 76 additions and 53 deletions.
diff --git a/documentation/Set-PnPWikiPageContent.md b/documentation/Set-PnPWikiPageContent.md
@@ -10,7 +10,7 @@ online version: https://pnp.github.io/powershell/cmdlets/Set-PnPWikiPageContent.
 # Set-PnPWikiPageContent
 
 ## SYNOPSIS
-Sets the contents of a wikipage
+Sets the contents of a wiki page.
 
 ## SYNTAX
 
@@ -27,7 +27,7 @@ Set-PnPWikiPageContent -Path <String> -ServerRelativePageUrl <String>
 ```
 
 ## DESCRIPTION
-This cmdlet updates the content of the specified wikipage to the value specified either in a string or a file.
+This cmdlet updates the content of the specified wiki page to the value specified either in a string or a file.
 
 ## EXAMPLES
 
@@ -42,8 +42,7 @@ Sets the content of OurWikiPage to the content of sampleblog.html file.
 $htmlContent = "<div>test</div>"
 Set-PnPWikiPageContent -ServerRelativePageUrl /sites/PnPWikiCollection/SitePages/OurWikiPage.aspx -Content $htmlContent
 ```
-
-Sets the content of OurWikiPage as "test". 
+Sets the content of OurWikiPage as "test". The existing content of the wiki page will be replaced with the new content provided.
 
 ## PARAMETERS
 
@@ -62,7 +61,7 @@ Accept wildcard characters: False
 ```
 
 ### -Content
-
+HTML markup that represents the desired content of the wiki page. The HTML markup can include text, images, links, tables, formatting elements, and any other HTML elements supported by SharePoint's wiki pages. 
 ```yaml
 Type: String
 Parameter Sets: STRING
@@ -75,6 +74,7 @@ Accept wildcard characters: False
 ```
 
 ### -Path
+The local file path of the HTML file containing the content for the wiki page.
 
 ```yaml
 Type: String
@@ -88,7 +88,7 @@ Accept wildcard characters: False
 ```
 
 ### -ServerRelativePageUrl
-Site Relative Page Url
+The server-relative URL of the wiki page whose content should be updated.
 
 ```yaml
 Type: String

diff --git a/documentation/Set-PnpTeamsChannelUser.md b/documentation/Set-PnpTeamsChannelUser.md
@@ -20,7 +20,7 @@ Updates the role of a user in an existing Microsoft Teams private channel.
 ## SYNTAX
 
 ```powershell
-Set-PnPTeamsChannelUser -Team <TeamsTeamPipeBind> -Channel <TeamsChannelPipeBind> -Identity <TeamsChannelMemberPipeBind> -Role <String> 
+Set-PnPTeamsChannelUser -Team <TeamsTeamPipeBind> -Channel <TeamsChannelPipeBind> -Identity <TeamsChannelMemberPipeBind> -Role <String> [-Connection <PnPConnection>]
 ```
 
 ## DESCRIPTION
@@ -33,18 +33,30 @@ Allows to update the role of a user in an existing Microsoft Teams private chann
 ```powershell
 Set-PnPTeamsChannelUser -Team 4efdf392-8225-4763-9e7f-4edeb7f721aa -Channel "19:[email protected]" -Identity MCMjMiMjMDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAwIyMxOTowMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMEB0aHJlYWQuc2t5cGUjIzAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMA== -Role Owner
 ```
-
 Updates the user with specific membership ID as owner of the specified Teams private channel.
 
 ### EXAMPLE 2
 ```powershell
 Set-PnPTeamsChannelUser -Team "My Team" -Channel "My Private Channel" -Identity [email protected] -Role Member
 ```
-
 Updates the user [email protected] as member of the specified Teams private channel.
 
 ## 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)
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -Team
 Specify the group id, mailNickname or display name of the team to use.
 
@@ -88,7 +100,7 @@ Accept wildcard characters: False
 ```
 
 ### -Role
-Specify the role of the user
+Specify the role of the user.
 
 ```yaml
 Type: String
@@ -104,4 +116,4 @@ Accept wildcard characters: False
 
 ## RELATED LINKS
 
-[Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp)
+[Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp)
diff --git a/documentation/Stop-PnPFlowRun.md b/documentation/Stop-PnPFlowRun.md
@@ -19,7 +19,7 @@ Stops/cancels a specific run of a Microsoft flow.
 ## SYNTAX
 
 ```powershell
-Stop-PnPFlowRun -Environment <PowerAutomateEnvironmentPipeBind> -Flow <PowerAutomateFlowPipeBind> -Identity <PowerAutomateFlowRunPipeBind> [-Force] 
+Stop-PnPFlowRun -Environment <PowerAutomateEnvironmentPipeBind> -Flow <PowerAutomateFlowPipeBind> -Identity <PowerAutomateFlowRunPipeBind> [-Force] [-Connection <PnPConnection>]
 ```
 
 ## DESCRIPTION
@@ -32,18 +32,32 @@ This cmdlet cancels a running Power Automate flow run.
 $environment = Get-PnPPowerPlatformEnvironment
 Stop-PnPFlowRun -Environment $environment -Flow fba63225-baf9-4d76-86a1-1b42c917a182 -Identity 08585531682024670884771461819CU230
 ```
-This cancels the specified flow run of the specified flow
+This cancels the specified flow run of the specified flow.
 
 
 ### Example 2
 ```powershell
 $environment = Get-PnPPowerPlatformEnvironment
 Stop-PnPFlowRun -Environment $environment -Flow fba63225-baf9-4d76-86a1-1b42c917a182 -Identity 08585531682024670884771461819CU230 -Force
 ```
-This cancels the specified flow run of the specified flow without confirmation
+This cancels the specified flow run of the specified flow without confirmation.
 
 ## 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)
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -Environment
 The name of the Power Platform environment or an Environment object to retrieve the available flows for.
 

diff --git a/documentation/Sync-PnPAppToTeams.md b/documentation/Sync-PnPAppToTeams.md
@@ -10,7 +10,7 @@ online version: https://pnp.github.io/powershell/cmdlets/Sync-PnPAppToTeams.html
 # Sync-PnPAppToTeams
 
 ## SYNOPSIS
-Synchronize an app from the tenant app catalog to the Microsoft Teams app catalog
+Synchronize an app from the tenant app catalog to the Microsoft Teams app catalog.
 
 ## SYNTAX
 
@@ -20,7 +20,7 @@ Sync-PnPAppToTeams [-Identity] <AppMetadataPipeBind> [-Connection <PnPConnection
 
 ## DESCRIPTION
 
-Allows to Synchronize an app from the tenant app catalog to the Microsoft Teams app catalog.
+Allows to synchronize an app from the tenant app catalog to the Microsoft Teams app catalog.
 
 ## EXAMPLES
 
@@ -29,7 +29,7 @@ Allows to Synchronize an app from the tenant app catalog to the Microsoft Teams
 Sync-PnPAppToTeams -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe
 ```
 
-This will synchronize the given app with the Microsoft Teams app catalog
+This will synchronize the given app with the Microsoft Teams app catalog.
 
 ## PARAMETERS
 
@@ -48,7 +48,7 @@ Accept wildcard characters: False
 ```
 
 ### -Identity
-Specifies the Id of the Add-In Instance
+Specifies the Id of the Add-In Instance.
 
 ```yaml
 Type: AppMetadataPipeBind

diff --git a/documentation/Test-PnPSite.md b/documentation/Test-PnPSite.md
@@ -20,7 +20,7 @@ Checks the site collection and its contents.
 ## SYNTAX
 
 ```powershell
-Test-PnPSite -Identity <SitePipeBind> [-RuleId <Guid>]
+Test-PnPSite -Identity <SitePipeBind> [-RuleId <Guid>] [-Connection <PnPConnection>]
 ```
 
 ## DESCRIPTION
@@ -45,6 +45,20 @@ This example runs the Missing Galleries Check rule in test mode on the https://c
 
 ## 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)
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -Identity
 Specifies the SharePoint Online site collection on which to run the repairs.
 

diff --git a/documentation/Test-PnPTenantTemplate.md b/documentation/Test-PnPTenantTemplate.md
@@ -10,13 +10,12 @@ online version: https://pnp.github.io/powershell/cmdlets/Test-PnPTenantTemplate.
 # Test-PnPTenantTemplate
 
 ## SYNOPSIS
-Tests a tenant template for invalid references
+Tests a tenant template for invalid references.
 
 ## SYNTAX
 
 ```powershell
 Test-PnPTenantTemplate -Template <ProvisioningHierarchy> [-Connection <PnPConnection>]  
- 
 ```
 
 ## DESCRIPTION
@@ -30,7 +29,7 @@ Allows to check if the tenant template has invalid references.
 Test-PnPTenantTemplate -Template $myTemplate
 ```
 
-Checks for valid template references
+Checks for valid template references.
 
 ## PARAMETERS
 
@@ -49,7 +48,7 @@ Accept wildcard characters: False
 ```
 
 ### -Template
-The in-memory template to test
+The in-memory template to test.
 
 ```yaml
 Type: ProvisioningHierarchy
@@ -62,21 +61,6 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -WhatIf
-Shows what would happen if the cmdlet runs. The cmdlet is not run.
-
-```yaml
-Type: SwitchParameter
-Parameter Sets: (All)
-Aliases: wi
-
-Required: False
-Position: Named
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
 ## RELATED LINKS
 
 [Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp)

diff --git a/documentation/Unpublish-PnPApp.md b/documentation/Unpublish-PnPApp.md
@@ -10,7 +10,7 @@ online version: https://pnp.github.io/powershell/cmdlets/Unpublish-PnPApp.html
 # Unpublish-PnPApp
 
 ## SYNOPSIS
-Unpublishes/retracts an available add-in from the app catalog
+Unpublishes/retracts an available add-in from the app catalog.
 
 ## SYNTAX
 
@@ -21,7 +21,7 @@ Unpublish-PnPApp [-Identity] <AppMetadataPipeBind> [-Scope <AppCatalogScope>] [-
 
 ## DESCRIPTION
 
-Allows to unpublish an available add-in from the site.
+Allows to unpublish an available add-in from the site collection app catalog or tenant app catalog.
 
 ## EXAMPLES
 
@@ -30,14 +30,14 @@ Allows to unpublish an available add-in from the site.
 Unpublish-PnPApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe
 ```
 
-This will retract, but not remove, the specified app from the tenant app catalog
+This will retract, but not remove, the specified app from the tenant app catalog.
 
 ### EXAMPLE 2
 ```powershell
 Unpublish-PnPApp -Identity 99a00f6e-fb81-4dc7-8eac-e09c6f9132fe -Scope Site
 ```
 
-This will retract, but not remove, the specified app from the site collection app catalog
+This will retract, but not remove, the specified app from the site collection app catalog.
 
 ## PARAMETERS
 
@@ -56,7 +56,7 @@ Accept wildcard characters: False
 ```
 
 ### -Identity
-Specifies the Id of the Addin Instance
+Specifies the Id of the Addin Instance.
 
 ```yaml
 Type: AppMetadataPipeBind
@@ -70,7 +70,7 @@ Accept wildcard characters: False
 ```
 
 ### -Scope
-Defines which app catalog to use. Defaults to Tenant
+Defines which app catalog to use. Defaults to Tenant.
 
 ```yaml
 Type: AppCatalogScope

diff --git a/documentation/Unregister-PnPHubSite.md b/documentation/Unregister-PnPHubSite.md
@@ -15,7 +15,7 @@ online version: https://pnp.github.io/powershell/cmdlets/Unregister-PnPHubSite.h
 
 * SharePoint: Access to the SharePoint Tenant Administration site
 
-Unregister a site as a hubsite
+Unregister a site as a hubsite.
 
 ## SYNTAX
 
@@ -34,7 +34,7 @@ Allows to unregister a site as a hubsite.
 Unregister-PnPHubSite -Site "https://tenant.sharepoint.com/sites/myhubsite"
 ```
 
-This example unregister the specified site as a hubsite
+This example unregisters the specified site as a hubsite.
 
 ## PARAMETERS
 
@@ -53,7 +53,7 @@ Accept wildcard characters: False
 ```
 
 ### -Site
-The site to unregister as a hubsite
+The site to unregister as a hubsite.
 
 ```yaml
 Type: SitePipeBind