Skip to content

Commit ba6da21

Browse files
Minor documentation fixes (#3853)
* Added connection parameter description * Added connection parameter description * Update Set-PnPStructuralNavigationCacheWebState.md * Update Set-PnPStructuralNavigationCacheWebState.md * Update Set-PnPStructuralNavigationCacheWebState.md * Update Set-PnPStructuralNavigationCacheSiteState.md * Removed WhatIf parameter description * Update Set-PnPSiteVersionPolicy.md --------- Co-authored-by: Gautam Sheth <gautamdsheth@outlook.com>
1 parent 9d4856a commit ba6da21

File tree

6 files changed

+149
-106
lines changed

6 files changed

+149
-106
lines changed

documentation/Set-PnPSiteVersionPolicy.md

Lines changed: 57 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ online version: https://pnp.github.io/powershell/cmdlets/Set-PnPSiteVersionPolic
1010
# Set-PnPSiteVersionPolicy
1111

1212
## SYNOPSIS
13-
Set file version policy related properties on the site.
13+
Sets file version policy related properties on the site.
1414

1515
## SYNTAX
1616

@@ -27,98 +27,109 @@ Set-PnPSiteVersionPolicy
2727
[-Connection <PnPConnection>]
2828
```
2929

30+
## DESCRIPTION
31+
Configures the versioning policy for a SharePoint Online site collection.
32+
3033
## EXAMPLES
3134

3235
### EXAMPLE 1
3336
```powershell
3437
Set-PnPSiteVersionPolicy -EnableAutoExpirationVersionTrim $true
3538
```
3639

37-
Set AutoExpiration file version trim mode for a site. The new document libraries will use this version setting. Also create a request to set the file version trim mode as AutoExpiration for existing document libraries that enabled versioning.
40+
This example sets AutoExpiration file version trim mode for a site. The new document libraries will use this version setting. Also creates a request to set the file version trim mode as AutoExpiration for existing document libraries that enabled versioning.
3841

3942
### EXAMPLE 2
4043
```powershell
4144
Set-PnPSiteVersionPolicy -EnableAutoExpirationVersionTrim $false -MajorVersions 100 -MajorWithMinorVersions 10 -ExpireVersionsAfterDays 200
4245
```
4346

44-
Set ExpireAfter file version trim mode for a site. The new document libraries will use this version setting. Also create a request to set the file version trim mode as ExpireAfter for existing document libraries that enabled versioning.
47+
This example sets ExpireAfter file version trim mode for a site. The new document libraries will use this version setting. Also creates a request to set the file version trim mode as ExpireAfter for existing document libraries that enabled versioning.
4548

4649
### EXAMPLE 3
4750
```powershell
4851
Set-PnPSiteVersionPolicy -EnableAutoExpirationVersionTrim $false -MajorVersions 300 -MajorWithMinorVersions 20 -ExpireVersionsAfterDays 0
4952
```
5053

51-
Set NoExpiration file version trim mode for a site. The new document libraries will use this version setting. Also create a request to set the file version trim mode as NoExpiration for existing document libraries that enabled versioning.
54+
Example 3 sets NoExpiration file version trim mode for a site. The new document libraries will use this version setting. Also creates a request to set the file version trim mode as NoExpiration for existing document libraries that enabled versioning.
5255

5356
### EXAMPLE 4
5457
```powershell
5558
Set-PnPSiteVersionPolicy -InheritFromTenant
5659
```
5760

58-
Clear the file version setting on a site. The new document libraries will use the tenant level setting.
61+
Example 4 clears the file version setting on a site. The new document libraries will use the tenant level setting.
5962

6063
### EXAMPLE 5
6164
```powershell
6265
Set-PnPSiteVersionPolicy -EnableAutoExpirationVersionTrim $true -ApplyToNewDocumentLibraries
6366
```
6467

65-
Set AutoExpiration file version trim mode for a site. The new document libraries will use this version setting.
68+
This example sets AutoExpiration file version trim mode for a site. The new document libraries will use this version setting.
6669

6770
### EXAMPLE 6
6871
```powershell
6972
Set-PnPSiteVersionPolicy -EnableAutoExpirationVersionTrim $false -MajorVersions 100 -ExpireVersionsAfterDays 200 -ApplyToNewDocumentLibraries
7073
```
7174

72-
Set ExpireAfter file version trim mode for a site. The new document libraries will use this version setting.
75+
This example sets ExpireAfter file version trim mode for a site. The new document libraries will use this version setting.
7376

7477
### EXAMPLE 7
7578
```powershell
7679
Set-PnPSiteVersionPolicy -EnableAutoExpirationVersionTrim $false -MajorVersions 300 -ExpireVersionsAfterDays 0 -ApplyToNewDocumentLibraries
7780
```
7881

79-
Set NoExpiration file version trim mode for a site. The new document libraries will use this version setting.
82+
Example 7 sets NoExpiration file version trim mode for a site. The new document libraries will use this version setting.
8083

8184
### EXAMPLE 8
8285
```powershell
8386
Set-PnPSiteVersionPolicy -EnableAutoExpirationVersionTrim $true -ApplyToExistingDocumentLibraries
8487
```
8588

86-
Create a request to set the file version trim mode as AutoExpiration for existing document libraries that enabled versioning.
89+
Example 8 creates a request to set the file version trim mode as AutoExpiration for existing document libraries that enabled versioning.
8790

8891
### EXAMPLE 9
8992
```powershell
9093
Set-PnPSiteVersionPolicy -EnableAutoExpirationVersionTrim $false -MajorVersions 100 -MajorWithMinorVersions 5 -ExpireVersionsAfterDays 200 -ApplyToExistingDocumentLibraries
9194
```
9295

93-
Create a request to set the file version trim mode as ExpireAfter for existing document libraries that enabled versioning.
96+
This example creates a request to set the file version trim mode as ExpireAfter for existing document libraries that enabled versioning.
9497

9598
### EXAMPLE 10
9699
```powershell
97100
Set-PnPSiteVersionPolicy -EnableAutoExpirationVersionTrim $false -MajorVersions 100 -MajorWithMinorVersions 5 -ExpireVersionsAfterDays 0 -ApplyToExistingDocumentLibraries
98101
```
99102

100-
Create a request to set the file version trim mode as NoExpiration for existing document libraries that enabled versioning.
103+
Example 10 creates a request to set the file version trim mode as NoExpiration for existing document libraries that enabled versioning.
101104

102105
### EXAMPLE 11
103106
```powershell
104107
Set-PnPSiteVersionPolicy -CancelForExistingDocumentLibraries
105108
```
106109

107-
Cancel the existing request which sets the file version trim mode for existing document libraries on a site.
110+
This example cancels the existing request which sets the file version trim mode for existing document libraries on a site.
108111

109112
## PARAMETERS
110113

111-
### -EnableAutoExpirationVersionTrim
112-
Enable or disable AutoExpiration version trim for the document libraries on the site. Set to $true to enable, $false to disable.
114+
### -ApplyToNewDocumentLibraries
115+
Sets site version policy for new document libraries. Works with parameters EnableAutoExpirationVersionTrim, ExpireVersionsAfterDays, MajorVersions and MajorWithMinorVersions.
113116

114-
Parameter ExpireVersionsAfterDays is required when EnableAutoExpirationVersionTrim is false. Set it to 0 for NoExpiration, set it to greater or equal to 30 for ExpireAfter.
117+
```yaml
118+
Type: SwitchParameter
119+
Parameter Sets: Set Properties
115120

116-
Parameter MajorVersions is required when EnableAutoExpirationVersionTrim is false.
121+
Required: False
122+
Position: Named
123+
Default value: None
124+
Accept pipeline input: False
125+
Accept wildcard characters: False
126+
```
117127
118-
Parameter MajorWithMinorVersions is required when EnableAutoExpirationVersionTrim is false and the setting is for document libraries that including existing ones. It is used when minor version is enabled on the document libraries.
128+
### -ApplyToExistingDocumentLibraries
129+
Creates a request to set the file version trim mode for existing document libraries that enabled versioning. Works with parameters EnableAutoExpirationVersionTrim, ExpireVersionsAfterDays, MajorVersions and MajorWithMinorVersions.
119130
120131
```yaml
121-
Type: Boolean
132+
Type: SwitchParameter
122133
Parameter Sets: Set Properties
123134

124135
Required: False
@@ -128,11 +139,11 @@ Accept pipeline input: False
128139
Accept wildcard characters: False
129140
```
130141
131-
### -ExpireVersionsAfterDays
132-
Expire the version after the days. Work with parameter EnableAutoExpirationVersionTrim. Please see description in EnableAutoExpirationVersionTrim.
142+
### -CancelForExistingDocumentLibraries
143+
Cancels the existing request which sets the file version trim mode for existing document libraries on a site.
133144
134145
```yaml
135-
Type: UInt32
146+
Type: SwitchParameter
136147
Parameter Sets: Set Properties
137148

138149
Required: False
@@ -142,12 +153,12 @@ Accept pipeline input: False
142153
Accept wildcard characters: False
143154
```
144155
145-
### -MajorVersions
146-
Maximum major versions to keep. Work with parameter EnableAutoExpirationVersionTrim. Please see description in EnableAutoExpirationVersionTrim.
156+
### -Connection
157+
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.
147158
148159
```yaml
149-
Type: UInt32
150-
Parameter Sets: Set Properties
160+
Type: PnPConnection
161+
Parameter Sets: (All)
151162

152163
Required: False
153164
Position: Named
@@ -156,11 +167,17 @@ Accept pipeline input: False
156167
Accept wildcard characters: False
157168
```
158169
159-
### -MajorWithMinorVersions
160-
Maximum major versions for which to keep minor versions. Work with parameter EnableAutoExpirationVersionTrim. Please see description in EnableAutoExpirationVersionTrim.
170+
### -EnableAutoExpirationVersionTrim
171+
Enables or disables AutoExpiration version trim for the document libraries on the site. Set to $true to enable, $false to disable.
172+
173+
Parameter ExpireVersionsAfterDays is required when EnableAutoExpirationVersionTrim is false. Set it to 0 for NoExpiration, set it to greater or equal to 30 for ExpireAfter.
174+
175+
Parameter MajorVersions is required when EnableAutoExpirationVersionTrim is false.
176+
177+
Parameter MajorWithMinorVersions is required when EnableAutoExpirationVersionTrim is false and the setting is for document libraries that including existing ones. It is used when minor version is enabled on the document libraries.
161178
162179
```yaml
163-
Type: UInt32
180+
Type: Boolean
164181
Parameter Sets: Set Properties
165182

166183
Required: False
@@ -170,11 +187,11 @@ Accept pipeline input: False
170187
Accept wildcard characters: False
171188
```
172189
173-
### -InheritFromTenant
174-
Clear the file version setting on a site. The new document libraries will use the tenant level setting.
190+
### -ExpireVersionsAfterDays
191+
Expires the version after the days. Works with parameter EnableAutoExpirationVersionTrim. Please see description in EnableAutoExpirationVersionTrim.
175192
176193
```yaml
177-
Type: SwitchParameter
194+
Type: UInt32
178195
Parameter Sets: Set Properties
179196

180197
Required: False
@@ -184,8 +201,8 @@ Accept pipeline input: False
184201
Accept wildcard characters: False
185202
```
186203
187-
### -ApplyToNewDocumentLibraries
188-
Set site version policy for new document libraries. Work with parameters EnableAutoExpirationVersionTrim, ExpireVersionsAfterDays, MajorVersions and MajorWithMinorVersions.
204+
### -InheritFromTenant
205+
Clears the file version setting on a site. The new document libraries will use the tenant level setting.
189206
190207
```yaml
191208
Type: SwitchParameter
@@ -198,11 +215,11 @@ Accept pipeline input: False
198215
Accept wildcard characters: False
199216
```
200217
201-
### -ApplyToExistingDocumentLibraries
202-
Create a request to set the file version trim mode for existing document libraries that enabled versioning. Work with parameters EnableAutoExpirationVersionTrim, ExpireVersionsAfterDays, MajorVersions and MajorWithMinorVersions.
218+
### -MajorVersions
219+
Maximum major versions to keep. Works with parameter EnableAutoExpirationVersionTrim. Please see description in EnableAutoExpirationVersionTrim.
203220
204221
```yaml
205-
Type: SwitchParameter
222+
Type: UInt32
206223
Parameter Sets: Set Properties
207224

208225
Required: False
@@ -212,11 +229,11 @@ Accept pipeline input: False
212229
Accept wildcard characters: False
213230
```
214231
215-
### -CancelForExistingDocumentLibraries
216-
Cancel the existing request which sets the file version trim mode for existing document libraries on a site.
232+
### -MajorWithMinorVersions
233+
Maximum major versions for which to keep minor versions. Works with parameter EnableAutoExpirationVersionTrim. Please see description in EnableAutoExpirationVersionTrim.
217234
218235
```yaml
219-
Type: SwitchParameter
236+
Type: UInt32
220237
Parameter Sets: Set Properties
221238

222239
Required: False
@@ -226,6 +243,7 @@ Accept pipeline input: False
226243
Accept wildcard characters: False
227244
```
228245
246+
229247
## RELATED LINKS
230248
231249
[Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp)

documentation/Set-PnPStorageEntity.md

Lines changed: 4 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -30,19 +30,19 @@ Allows to set Storage Entities / Farm Properties in either the tenant scoped app
3030
Set-PnPStorageEntity -Key MyKey -Value "MyValue" -Comment "My Comment" -Description "My Description"
3131
```
3232

33-
Sets an existing or adds a new storage entity / farm property at tenant level.
33+
Sets an existing or adds a new storage entity / farm property at the tenant level.
3434

3535
### EXAMPLE 2
3636
```powershell
3737
Set-PnPStorageEntity -Scope Site -Key MyKey -Value "MyValue" -Comment "My Comment" -Description "My Description"
3838
```
3939

40-
Sets an existing or adds a new storage entity site collection level.
40+
Sets an existing or adds a new storage entity at the site collection level.
4141

4242
## PARAMETERS
4343

4444
### -Comment
45-
The comment to set.
45+
Specifies additional comments related to the storage entity being set.
4646

4747
```yaml
4848
Type: String
@@ -107,7 +107,7 @@ Accepted values: Site, Tenant
107107

108108
Required: False
109109
Position: Named
110-
Default value: None
110+
Default value: Tenant
111111
Accept pipeline input: False
112112
Accept wildcard characters: False
113113
```
@@ -126,20 +126,6 @@ Accept pipeline input: False
126126
Accept wildcard characters: False
127127
```
128128
129-
### -WhatIf
130-
Shows what would happen if the cmdlet runs. The cmdlet is not run.
131-
132-
```yaml
133-
Type: SwitchParameter
134-
Parameter Sets: (All)
135-
Aliases: wi
136-
137-
Required: False
138-
Position: Named
139-
Default value: None
140-
Accept pipeline input: False
141-
Accept wildcard characters: False
142-
```
143129
144130
## RELATED LINKS
145131

documentation/Set-PnPStructuralNavigationCacheSiteState.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,14 @@ The Set-PnPStructuralNavigationCacheSiteState cmdlet can be used to enable or di
2323

2424
## EXAMPLES
2525

26-
### Example 1
26+
### EXAMPLE 1
2727
```powershell
2828
Set-PnPStructuralNavigationCacheSiteState -IsEnabled $true -SiteUrl "https://contoso.sharepoint.com/sites/product/"
2929
```
3030

3131
This example enables caching for all webs in the site collection https://contoso.sharepoint.com/sites/product/.
3232

33-
### Example 2
33+
### EXAMPLE 2
3434
```powershell
3535
Set-PnPStructuralNavigationCacheSiteState -IsEnabled $false -SiteUrl "https://contoso.sharepoint.com/sites/product/"
3636
```
@@ -39,41 +39,41 @@ This example disables caching for all webs in the site collection https://contos
3939

4040
## PARAMETERS
4141

42-
### -IsEnabled
43-
$true to enable caching, $false to disable caching.
42+
### -Connection
43+
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.
4444

4545
```yaml
46-
Type: Boolean
46+
Type: PnPConnection
4747
Parameter Sets: (All)
48-
Aliases:
49-
Required: True
48+
49+
Required: False
5050
Position: Named
5151
Default value: None
5252
Accept pipeline input: False
5353
Accept wildcard characters: False
5454
```
5555
56-
### -SiteUrl
57-
Specifies the absolute URL for the site collection's root web that needs its caching state to be set.
56+
### -IsEnabled
57+
$true to enable caching, $false to disable caching.
5858
5959
```yaml
60-
Type: String
60+
Type: Boolean
6161
Parameter Sets: (All)
6262
Aliases:
63-
Required: False
63+
Required: True
6464
Position: Named
6565
Default value: None
6666
Accept pipeline input: False
6767
Accept wildcard characters: False
6868
```
6969
70-
### -Connection
71-
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.
70+
### -SiteUrl
71+
Specifies the absolute URL for the site collection's root web that needs its caching state to be set.
7272
7373
```yaml
74-
Type: PnPConnection
74+
Type: String
7575
Parameter Sets: (All)
76-
76+
Aliases:
7777
Required: False
7878
Position: Named
7979
Default value: None

0 commit comments

Comments
 (0)