Skip to content

Commit

Permalink
Merge pull request #3457 from KoenZomers/dev
Browse files Browse the repository at this point in the history
Fixing documentation build warnings
  • Loading branch information
KoenZomers authored Oct 1, 2023
2 parents 5462b6d + 2ab95ae commit 18e9f3d
Show file tree
Hide file tree
Showing 13 changed files with 17 additions and 34 deletions.
2 changes: 1 addition & 1 deletion documentation/Get-PnPAvailableSensitivityLabel.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Get-PnPAvailableSensitivityLabel [-Identity <Guid>] [-User <AzureADUserPipeBind>
## DESCRIPTION
This cmdlet allows retrieval of the available Microsoft Purview sensitivity labels in the currently connected tenant. You can retrieve all the labels, a specific label or all the labels available to a specific user. When connected with a delegate token, it will return the Microsoft Purview sensitivity labels for the user you logged on with. When connecting with an application token, it will return all available Microsoft Purview sensitivity labels on the tenant.

For retrieval of the available classic Site Classification, use [Get-PnPAvailableSiteClassification](Get-PnPAvailableSiteClassification.html) instead.
For retrieval of the available classic Site Classification, use [Get-PnPAvailableSiteClassification](Get-PnPAvailableSiteClassification.md) instead.

## EXAMPLES

Expand Down
2 changes: 1 addition & 1 deletion documentation/Get-PnPAvailableSiteClassification.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Get-PnPAvailableSiteClassification [-Connection <PnPConnection>]
```

## DESCRIPTION
This cmdlet allows for retrieving the configuration of the classic site classifications configured within the tenant. For the new Microsoft Purview sensitivity labels, use [Get-PnPAvailableSensitivityLabel](Get-PnPAvailableSensitivityLabel.html) instead.
This cmdlet allows for retrieving the configuration of the classic site classifications configured within the tenant. For the new Microsoft Purview sensitivity labels, use [Get-PnPAvailableSensitivityLabel](Get-PnPAvailableSensitivityLabel.md) instead.

## EXAMPLES

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Get-PnPAzureADServicePrincipalAvailableAppRole -Principal <ServicePrincipalPipeB

## DESCRIPTION

Allows retrieval of all available app roles of a specific service principals/app registration in Azure Active Directory. To retrieve the app roles currently assigned to a specific service principal/application registration, use [Get-PnPAzureADServicePrincipalAssignedAppRole](Get-PnPAzureADServicePrincipalAssignedAppRole.html) instead.
Allows retrieval of all available app roles of a specific service principals/app registration in Azure Active Directory. To retrieve the app roles currently assigned to a specific service principal/application registration, use [Get-PnPAzureADServicePrincipalAssignedAppRole](Get-PnPAzureADServicePrincipalAssignedAppRole.md) instead.

## EXAMPLES

Expand Down
2 changes: 1 addition & 1 deletion documentation/Get-PnPFolderItem.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Get-PnPFolderItem [-Identity <FolderPipeBind>] [-ItemType <String>] [-ItemName <

This cmdlet allows listing of all the content in a folder. It can be used to list all files and folders in a folder and optionally all its subfolders.

Use [Get-PnPFolderFile](Get-PnPFolderFile.html) to retrieve only files and [Get-PnPFolderFolder](Get-PnPFolderFolder.html) to retrieve only folders allowing additional properties of the returned items to be requested.
Use [Get-PnPFolderFile](Get-PnPFolderFile.md) to retrieve only files and [Get-PnPFolderFolder](Get-PnPFolderFolder.md) to retrieve only folders allowing additional properties of the returned items to be requested.

## EXAMPLES

Expand Down
4 changes: 2 additions & 2 deletions documentation/Grant-PnPAzureADAppSitePermission.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Grant-PnPAzureADAppSitePermission -AppId <Guid> -DisplayName <String> -Permissio

## DESCRIPTION

This cmdlet adds permissions for a given Azure Active Directory application registration in a site collection. It is used in conjunction with the Azure Active Directory SharePoint application permission Sites.Selected. Notice that this cmdlet allows for fewer permissions compared to updating rights through [Set-PnPAzureADAppSitePermission](Set-PnPAzureADAppSitePermission.html). If you wish to i.e. assign FullControl permissions, you need to add read or write permissions through this cmdlet first and then update it to FullControl.
This cmdlet adds permissions for a given Azure Active Directory application registration in a site collection. It is used in conjunction with the Azure Active Directory SharePoint application permission Sites.Selected. Notice that this cmdlet allows for fewer permissions compared to updating rights through [Set-PnPAzureADAppSitePermission](Set-PnPAzureADAppSitePermission.md). If you wish to i.e. assign FullControl permissions, you need to add read or write permissions through this cmdlet first and then update it to FullControl.

## EXAMPLES

Expand Down Expand Up @@ -88,7 +88,7 @@ Accept wildcard characters: False
```
### -Permissions
Specifies the permissions to set for the Azure Active Directory application registration which can either be Read or Write. Use [Set-PnPAzureADAppSitePermission](Set-PnPAzureADAppSitePermission.html) after initially adding these permissions to update it to Manage or FullControl permissions.
Specifies the permissions to set for the Azure Active Directory application registration which can either be Read or Write. Use [Set-PnPAzureADAppSitePermission](Set-PnPAzureADAppSitePermission.md) after initially adding these permissions to update it to Manage or FullControl permissions.
```yaml
Type: String
Expand Down
4 changes: 2 additions & 2 deletions documentation/Set-PnPAzureADAppSitePermission.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Set-PnPAzureADAppSitePermission -PermissionId <String> -Permissions <Read|Write|

## DESCRIPTION

This cmdlet updates permissions for a given Azure Active Directory application registration in a site collection. It is used in conjunction with the Azure Active Directory SharePoint application permission Sites.Selected. Notice that this cmdlet allows for more permissions compared for when initially setting rights through [Grant-PnPAzureADAppSitePermission](Grant-PnPAzureADAppSitePermission.html).
This cmdlet updates permissions for a given Azure Active Directory application registration in a site collection. It is used in conjunction with the Azure Active Directory SharePoint application permission Sites.Selected. Notice that this cmdlet allows for more permissions compared for when initially setting rights through [Grant-PnPAzureADAppSitePermission](Grant-PnPAzureADAppSitePermission.md).

## EXAMPLES

Expand Down Expand Up @@ -60,7 +60,7 @@ Accept wildcard characters: False
```
### -PermissionId
The permission with the specified id will be updated. Use [Get-PnPAzureADAppSitePermission](Get-PnPAzureADAppSitePermission.html) to discover currently set permissions which can be updated.
The permission with the specified id will be updated. Use [Get-PnPAzureADAppSitePermission](Get-PnPAzureADAppSitePermission.md) to discover currently set permissions which can be updated.
```yaml
Type: String
Expand Down
4 changes: 2 additions & 2 deletions documentation/Set-PnPList.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ Sets the default sensitivity label for a document library to Confidential.
## PARAMETERS

### -BreakRoleInheritance
If used the security inheritance is broken for this list from its parent, the web in which it resides. Permissions can be added using [Set-PnPListPermission](Set-PnPListPermission.html).
If used the security inheritance is broken for this list from its parent, the web in which it resides. Permissions can be added using [Set-PnPListPermission](Set-PnPListPermission.md).

```yaml
Type: SwitchParameter
Expand All @@ -125,7 +125,7 @@ Accept wildcard characters: False
```
### -ResetRoleInheritance
If used the security inheritance is reset for this list meaning it will not copy the permissions from its parent, but will start with an empty list of permissions. Permissions can be added using [Set-PnPListPermission](Set-PnPListPermission.html).
If used the security inheritance is reset for this list meaning it will not copy the permissions from its parent, but will start with an empty list of permissions. Permissions can be added using [Set-PnPListPermission](Set-PnPListPermission.md).
```yaml
Type: SwitchParameter
Expand Down
2 changes: 1 addition & 1 deletion documentation/Set-PnPListPermission.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Set-PnPListPermission -Identity <ListPipeBind> -User <String> [-AddRole <String>
```

## DESCRIPTION
Allows changing permissions on a SharePoint list. In case you would like to break the permission inheritance on a list from its parent, you can use [Set-PnPList -BreakRoleInheritance](Set-PnPList.html#-breakroleinheritance).
Allows changing permissions on a SharePoint list. In case you would like to break the permission inheritance on a list from its parent, you can use [Set-PnPList -BreakRoleInheritance](Set-PnPList.md#-breakroleinheritance).

## EXAMPLES

Expand Down
2 changes: 1 addition & 1 deletion documentation/Set-PnPSiteClassification.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Set-PnPSiteClassification -Identity <String> [-Connection <PnPConnection>]
```

## DESCRIPTION
This cmdlet allows for setting a classic site classification on the currently connected to site. If the site has a Microsoft 365 Group behind it, the classification will be placed on the Microsoft 365 Group and will require either Directory.Read.All or Directory.ReadWrite.All application permissions on Microsoft Graph. If it does not have a Microsoft 365 Group behind it, it will set the site classification on the SharePoint Online site and will not require Microsoft Graph permissions. Use [Get-PnPAvailableSiteClassification](Get-PnPAvailableSiteClassification.html) to get an overview of the available site classifications on the tenant. For the new Microsoft Purview sensitivity labels, use [Set-PnPSiteSensitivityLabel](Set-PnPSiteSensitivityLabel.html) instead.
This cmdlet allows for setting a classic site classification on the currently connected to site. If the site has a Microsoft 365 Group behind it, the classification will be placed on the Microsoft 365 Group and will require either Directory.Read.All or Directory.ReadWrite.All application permissions on Microsoft Graph. If it does not have a Microsoft 365 Group behind it, it will set the site classification on the SharePoint Online site and will not require Microsoft Graph permissions. Use [Get-PnPAvailableSiteClassification](Get-PnPAvailableSiteClassification.md) to get an overview of the available site classifications on the tenant. For the new Microsoft Purview sensitivity labels, use [Set-PnPSiteSensitivityLabel](Set-PnPSiteSensitivityLabel.md) instead.

## EXAMPLES

Expand Down
4 changes: 2 additions & 2 deletions documentation/Set-PnPSiteSensitivityLabel.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ This cmdlet allows for setting a Microsoft Purview sensitivity label on the curr

It may take up to a few minutes for a change to the sensitivity label to become visible in SharePoint Online and Azure Active Directory.

Use [Get-PnPAvailableSensitivityLabel](Get-PnPAvailableSensitivityLabel.html) to get an overview of the available Microsoft Purview sensitivity labels on the tenant.
Use [Get-PnPAvailableSensitivityLabel](Get-PnPAvailableSensitivityLabel.md) to get an overview of the available Microsoft Purview sensitivity labels on the tenant.

For the classic classification labels, use [Set-PnPSiteClassification](Set-PnPSiteClassification.html) instead.
For the classic classification labels, use [Set-PnPSiteClassification](Set-PnPSiteClassification.md) instead.

## EXAMPLES

Expand Down
4 changes: 2 additions & 2 deletions pages/Build-Site.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Try {
$aliasCmdletsCount = $aliasCmdlets.Length

Write-Host "- Retrieving alias template page"
$aliasTemplatePageContent = Get-Content -Path "./dev/pages/cmdlets/alias.md" -Raw
$aliasTemplatePageContent = Get-Content -Path "./dev/pages/cmdlets/alias.template" -Raw

ForEach($aliasCmdlet in $aliasCmdlets)
{
Expand Down Expand Up @@ -115,7 +115,7 @@ foreach ($nightlycmdlet in $nightlycmdlets) {
# Generate cmdlet toc
Write-Host "Retrieving all cmdlet pages"

$cmdletPages = Get-ChildItem -Path "./dev/pages/cmdlets/*.md" -Exclude "index.md","alias.md"
$cmdletPages = Get-ChildItem -Path "./dev/pages/cmdlets/*.md" -Exclude "index.md","alias.template"
$toc = ""
foreach ($cmdletPage in $cmdletPages) {
$toc = $toc + "- name: $($cmdletPage.BaseName)`n href: $($cmdletPage.Name)`n"
Expand Down
17 changes: 0 additions & 17 deletions pages/cmdlets/alias.md

This file was deleted.

2 changes: 1 addition & 1 deletion powershell
Submodule powershell updated from a7a08d to f14e38

0 comments on commit 18e9f3d

Please sign in to comment.