You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: repo_docs/NEW_CMDLETS.md
+13-13Lines changed: 13 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -53,7 +53,7 @@ You probably know how to do this already, but the available workloads and connec
53
53
54
54
- 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.
55
55
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 available to administrators by default, but some aren't (for example, the "Mailbox Search" and "Mailbox Import Export" roles).
57
57
58
58
## Step 3: Load platyPS in the PowerShell environment
59
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:
@@ -63,7 +63,7 @@ Import-Module platyPS
63
63
```
64
64
65
65
### Step 4: Find your module name
66
-
**Note**: This step is required only if you're interested in creaing cmdlet reference topics for **all** available cmdlets in your product (the _Module_ parameter in `New-MarkdownHelp`). If you're going to manually specify the cmdlet names (the _Command_ parameter in `New-MarkdownHelp`), you can skip this step.
66
+
**Note**: This step is required only if you're interested in creating cmdlet reference topics for **all** available cmdlets in your product (the _Module_ parameter in `New-MarkdownHelp`). If you're going to manually specify the cmdlet names (the _Command_ parameter in `New-MarkdownHelp`), you can skip this step.
67
67
68
68
platyPS needs the name of the loaded PowerShell module or snap-in that contains the cmdlets you want to update. To find the name, run the following command:
69
69
@@ -152,7 +152,7 @@ Check the details of your connection instructions, but your session information
152
152
### Step 6: Run platyPS to generate topic files
153
153
You have two choices:
154
154
155
-
- **Dump _all_ cmdlets in the module/snap-in to files**: This is simple, but could take a while, and you'll end up with dozens or possibly hundreds of cmdlets files you don't need. The basic sytax is:
155
+
- **Dump _all_ cmdlets in the module/snap-in to files**: This is simple, but could take a while, and you'll end up with dozens or possibly hundreds of cmdlets files you don't need. The basic syntax is:
- \<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)_.
178
178
179
-
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.
179
+
Failure to use the _Session_ parameter in remote PowerShell environments leads to weird results: multiple syntax blocks/parameter sets aren't recognized and are collapsed into one big block, the Type value is Object for all parameters, the Required value is False for all parameters, etc.
180
180
181
181
- If the \<Path\> location doesn't exist, it's created for you.
182
182
@@ -219,7 +219,7 @@ These are the basic topic elements that require your attention, regardless of th
219
219
220
220
- **A description for every parameter in each parameter section**
221
221
222
-
We highly enourage you to plagerize existing content and formatting from other cmdlet topics in the product or service. Many parameters are common across a wide variety of cmdlets.
222
+
We highly encourage you to plagiarize existing content and formatting from other cmdlet topics in the product or service. Many parameters are common across a wide variety of cmdlets.
223
223
224
224
#### Metadata in the new cmdlet
225
225
Less obvious but still important information that's often manually required in every topic is **cmdlet metadata** at the top of the topic and **parameter metadata** in every parameter section.
@@ -236,7 +236,7 @@ Here's an example of the cmdlet metadata that's required at the top of every top
236
236
schema: 2.0.0
237
237
```
238
238
239
-
- **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.
239
+
- **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 availability of the help topic at the command line.
240
240
241
241
- **Module Name**: Not used in Exchange topics (remove it). For other products, this is the module name of the product.
242
242
@@ -263,7 +263,7 @@ Here's an example of the parameter metadata that's present in every parameter se
263
263
Accept wildcard characters: False
264
264
```
265
265
266
-
Most of the atrributes and values are generated automatically by platyPS. The ones that require manual intervention are:
266
+
Most of the attributes and values are generated automatically by platyPS. The ones that require manual intervention are:
267
267
268
268
- **Applicable**: You need to add this attribute and value yourself. Notice the capital 'A'. See other topics for available values (same available values as the **applicable** attribute at the top of the topic). Don't invent new values here. The value **must** come from the list of predefined values.
269
269
@@ -272,11 +272,11 @@ Most of the atrributes and values are generated automatically by platyPS. The on
272
272
### Step 8: Add the new cmdlet topic files to the repository
273
273
When you're done editing the topics, upload them to GitHub.
274
274
275
-
1. Go to the correct location in the appropriate GiHub repository:
275
+
1. Go to the correct location in the appropriate GitHub repository:
For Exchage, you also need to go one level deepter into an appropriate subfolder. Choose wisely based on the surrounding cmdlet topics. Don't create new folders.
279
+
For Exchange, you also need to go one level deeper into an appropriate subfolder. Choose wisely based on the surrounding cmdlet topics. Don't create new folders.
280
280
281
281
- Office Web Apps: [https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/officewebapps/officewebapps-ps/officewebapps](https://github.com/MicrosoftDocs/office-docs-powershell/tree/master/officewebapps/officewebapps-ps/officewebapps)
282
282
@@ -298,7 +298,7 @@ When you're done editing the topics, upload them to GitHub.
298
298
299
299

300
300
301
-
3. After you're done adding files, go to the **Propose file change** area at the bottom of the page. Enter a title and optional description informaton and then click **Propose file change**.
301
+
3. After you're done adding files, go to the **Propose file change** area at the bottom of the page. Enter a title and optional description information and then click **Propose file change**.
302
302
303
303
4. On the next screen, click **Create pull request**.
304
304
@@ -358,7 +358,7 @@ After you're done editing the TOC file:
358
358
359
359
**Notes**:
360
360
361
-
- The target folder/path must already exsist.
361
+
- The target folder/path must already exist.
362
362
363
363
- The command will create two new folders in the target path:
364
364
@@ -380,7 +380,7 @@ After you're done editing the TOC file:
0 commit comments