Skip to content

Commit 70a4f40

Browse files
committed
Last updates to New_CMDLETS and UPDATE_CMDLETS
1 parent cb76438 commit 70a4f40

File tree

2 files changed

+74
-110
lines changed

2 files changed

+74
-110
lines changed

repo_docs/NEW_CMDLETS.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Install-Module -Name platyPS -Scope CurrentUser
2626

2727
- Windows 7
2828

29-
If you need to install platyPS on an older version of Windows (for example, a server running a product that lacks support for WMF 5.x or its requirements), see the Install platyPS on older versions of Windows section at the end of this topic.
29+
If you need to install platyPS on an older version of Windows (for example, a server running a product that lacks support for WMF 5.x or its requirements), see the [Install platyPS on older versions of Windows](#install-platyps-on-older-versions-of-windows) section at the end of this topic.
3030

3131
## Step 2: Connect to the PowerShell environment that has the cmdlet
3232
You probably know how to do this already, but the available workloads and connection methods are:
@@ -43,7 +43,7 @@ You probably know how to do this already, but the available workloads and connec
4343

4444
- Exchange Online: [Connect to Exchange Online PowerShell](https://docs.microsoft.com/powershell/exchange/exchange-online/connect-to-exchange-online-powershell/connect-to-exchange-online-powershell)
4545

46-
- Office 365 Security & Compliance Center Power: [Connect to Office 365 Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/office-365-scc/connect-to-scc-powershell/connect-to-scc-powershell)
46+
- Office 365 Security & Compliance Center: [Connect to Office 365 Security & Compliance Center PowerShell](https://docs.microsoft.com/powershell/exchange/office-365-scc/connect-to-scc-powershell/connect-to-scc-powershell)
4747

4848
- Exchange Online Protection: [Connect to Exchange Online Protection PowerShell](https://docs.microsoft.com/powershell/exchange/exchange-eop/connect-to-exchange-online-protection-powershell)
4949

@@ -53,10 +53,10 @@ You probably know how to do this already, but the available workloads and connec
5353

5454
- You might need to connect to the service in an elevated Windows PowerShell prompt (required for Skype for Business Online and Teams, but not Exchange). The connection instructions topic should contain this and other connection requirements.
5555

56-
- In Exchange environments, the cmdlets available to you are controlled by role-based access control (RBAC). Most cmdlets and parameters are avaialble to administrators by default, but some aren't (for example, the Mailbox Search and Mailbox Import Export roles).
56+
- In Exchange environments, the cmdlets available to you are controlled by role-based access control (RBAC). Most cmdlets and parameters are avaialble to administrators by default, but some aren't (for example, the "Mailbox Search" and "Mailbox Import Export" roles).
5757

5858
## Step 3: Load platyPS in the PowerShell environment
59-
After you've connected in PowerShell to the server or service \(either in a regular Windows PowerShell window or from a specific PowerShell console shortcut\), run the following command to make the platyPS cmdlets available in your session:
59+
After you've connected in PowerShell to the server or service (either in a regular Windows PowerShell window or from a specific PowerShell console shortcut), run the following command to make the platyPS cmdlets available in your session:
6060

6161
```
6262
Import-Module platyPS
@@ -107,7 +107,7 @@ Either way, take note of your module name. You'll need it in the next steps.
107107

108108
Check the details of your connection instructions, but your session information is stored in a variable. For example, in the Exchange connection instructions, the variable is `$Session`. You'll use this variable name in later steps.
109109

110-
If you connected via a custom script or your remote PowerShell session variable isn't apparent, do the following steps:
110+
**If you connected via a custom script or your remote PowerShell session variable isn't apparent, do the following steps**:
111111

112112
1. Run the following command to find your session:
113113

@@ -142,7 +142,7 @@ If you connected via a custom script or your remote PowerShell session variable
142142
For example, using the sample output in the previous step:
143143
144144
```
145-
$x = Get-PSSession 1
145+
$Session = Get-PSSession 1
146146
```
147147
148148
The variable name you choose doesn't matter, but you'll use it in later steps.
@@ -155,7 +155,7 @@ You have two choices:
155155
New-MarkdownHelp -Module <ModuleName> -OutputFolder "<Path"> [-Session <PSSessionVariableName>]
156156
```
157157
158-
- **Dump specific cmdlets to files**: This is a bit harder to setup, but the output is much quicker, and there are no extra topic files created. The basic syntax is:
158+
- **Dump specific cmdlets to files**: This is a bit harder to set up, but the output is much quicker, and there are no extra topic files created. The basic syntax is:
159159
160160
```
161161
New-MarkdownHelp -Command <Cmdlet> -OutputFolder "<Path"> [-Session <PSSessionVariableName>]
@@ -172,11 +172,11 @@ You have two choices:
172172
173173
- \<ModuleName\> is the value you found in [Step 4](#step-4-find-your-module-name) (for example, `tmp_byivwzpq.e1k` or `Microsoft.Online.SharePoint.PowerShell`).
174174
175-
- \<PSSessionVariableName\> is the remote PowerShell session variable from [Step 5](#step-5-verify-your-your-pssession-variable-name) (for example, `$Session`) *and is required only if the connection instructions used remote PowerShell (one or more **xxx-xxxSession** commands)*.
175+
- \<PSSessionVariableName\> is the remote PowerShell session variable from [Step 5](#step-5-verify-your-your-pssession-variable-name) (for example, `$Session`) _and is required only if the connection instructions used remote PowerShell (one or more **xxx-xxxSession** commands)_.
176176
177-
Failure to use the _Session_ parameter and value in remote PowerShell environments leads to weird results: multiple syntax blocks/parameter sets aren't recogonized and are collapsed into one big block, the Type value is Object for all parameters, the Required value is False for all parameters, etc.
177+
Failure to use the _Session_ parameter in remote PowerShell environments leads to weird results: multiple syntax blocks/parameter sets aren't recogonized and are collapsed into one big block, the Type value is Object for all parameters, the Required value is False for all parameters, etc.
178178
179-
- If the <Path> location doesn't exist, it's created for you.
179+
- If the \<Path\> location doesn't exist, it's created for you.
180180
181181
#### Dump all cmdlets in the module/snap-in to files
182182
This example creates topic files for all available cmdlets in the Skype for Business Online PowerShell session where the module is `tmp_byivwzpq.e1k` and the session variable is `$Session` in the folder C:\My Docs\SfBO.
@@ -192,7 +192,7 @@ This example create a topic file for the cmdlet named Get-CoolFeature in the Exc
192192
New-MarkdownHelp -Command "Get-CoolFeature" -OutputFolder "C:\My Docs\ExO" -Session $Session
193193
```
194194
195-
This example creates topic files for the cmdlets Get-CoolFeature, New-CoolFeature, Remove-CoolFeature, and Set-CoolFeature from the Exchange Online session where the session variable is `$Session` in the folder C:\My Docs\ExO.
195+
This example creates topic files for the Get-CoolFeature, New-CoolFeature, Remove-CoolFeature, and Set-CoolFeature cmdlets from the Exchange Online session where the session variable is `$Session` in the folder C:\My Docs\ExO.
196196
197197
The first command stores the cmdlet names in a variable. The second command uses that variable to identify the cmdlets and write the output files.
198198
@@ -234,7 +234,7 @@ Here's an example of the cmdlet metadata that's required at the top of every top
234234
schema: 2.0.0
235235
```
236236
237-
- **external help file**: Defines which MAML/XML file the cmdlet help topic goes in for `Get-Help` at the command line. This value very product-specific. Some products (Skype) use only one XML file that's well-known and the same for all cmdlets; others (Exchange, SharePoint) use multiple XML files. See other topics for available values.
237+
- **external help file**: Defines which MAML/XML file the cmdlet help topic goes in for `Get-Help` at the command line. This value very product-specific, and the location is specified somewhere in product code. Some products (Skype) use only one XML file that's well-known and the same for all cmdlets; others (Exchange, SharePoint) use multiple XML files. See other topics for available values. Don't guess; a wrong value here will affect the avaialbility of the help topic at the command line.
238238
239239
- **Module Name**: Not used in Exchange topics (remove it). For other products, this is the module name of the product.
240240
@@ -249,7 +249,7 @@ Here's an example of the cmdlet metadata that's required at the top of every top
249249
##### Parameter metadata
250250
Here's an example of the parameter metadata that's present in every parameter section:
251251
252-
```
252+
```yaml
253253
Type: String
254254
Parameter Sets: (All)
255255
Aliases:
@@ -319,7 +319,7 @@ Add the cmdlet to Table of Contents (TOC) file in the GitHub repo. TOC file is t
319319
320320
- Whiteboard: [https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/whiteboard/whiteboard-ps/whiteboard/whiteboard.md](https://github.com/MicrosoftDocs/office-docs-powershell/blob/master/whiteboard/whiteboard-ps/whiteboard/whiteboard.md)
321321
322-
In the TOC file, you can fill in a description or remove the template text line. However, if you leave the template text line make sure it is exactly in the right format so it won't render as a template text.
322+
In the TOC file, you can fill in a description or remove the template text line. However, if you leave the template text line make sure it's in _exactly_ the right format so it won't render as a template text.
323323
324324
After you're done editing the TOC file:
325325
@@ -329,7 +329,7 @@ After you're done editing the TOC file:
329329
330330
## Appendix
331331
332-
### References
332+
### Reference
333333
* https://docs.microsoft.com/en-us/powershell/module/powershellget/install-module?view=powershell-6
334334
* https://docs.microsoft.com/en-us/powershell/module/powershellget/update-module?view=powershell-6
335335
* https://github.com/PowerShell/platyPS
@@ -359,13 +359,13 @@ After you're done editing the TOC file:
359359
360360
- PowerShellGet
361361
362-
3. Delete the following folders from your computer (or move them to a remote location for safekeeping):
362+
3. Delete the following folders from your computer or move them to a remote location for safekeeping:
363363
364364
- C:\Program Files\WindowsPowerShell\Modules\PackageManagement
365365
366366
- C:\Program Files\WindowsPowerShell\Modules\PowerShellGet
367367
368-
4. In Windows Explorer, copy the PackageManagement and PowerShellGet folders FROM \<TargetPath\> TO C:\Program Files\WindowsPowerShell\Modules\ (effectively replacing the folders you deleted in the previous step).
368+
4. In Windows Explorer, copy the PackageManagement and PowerShellGet folders FROM \<TargetPath\> TO C:\Program Files\WindowsPowerShell\Modules\ (replacing the folders you deleted in Step 3 with the new ones you downloaded in Step 2).
369369
370370
You should now have the following folders again:
371371

0 commit comments

Comments
 (0)