Skip to content

Commit 3ed00b7

Browse files
committed
Fixes formatting of metadata.
1 parent 516ef55 commit 3ed00b7

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

repo_docs/NEW_CMDLETS.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,31 +10,48 @@
1010
- Skype for Business Online: `New-MarkdownHelp -module tmp_byivwzpq.e1k -OutputFolder .\docs`.
1111
4. Find the new cmdlet and you will see the stubbed markdown.
1212
5. Add correct metadata, see other similar cmdlets for examples.
13+
1314
You will need to add the title and also applicable metadata for the cmdlet and also for each parameter.
1415

1516
**Example metadata at top of cmdlet:**
1617

1718
external help file: Microsoft.OutlookApps.StaffHub.PowershellCmdlets.dll-Help.xml
19+
1820
Module Name: Microsoft.OutlookApps.StaffHub.PowershellCmdlets
21+
1922
online version:
23+
2024
**applicable: Microsoft StaffHub**
25+
2126
**title: Get-StaffHubUsersForTenant**
27+
2228
schema: 2.0.0
2329

2430

31+
2532
**Example metadata for each parameter:**
2633

2734
Type: String
35+
2836
Parameter Sets: (All)
37+
2938
Aliases:
39+
3040
**Applicable: Microsoft StaffHub**
41+
3142
Required: False
43+
3244
Position: 1
45+
3346
Default value: None
47+
3448
Accept pipeline input: False
49+
3550
Accept wildcard characters: False
3651

37-
6. Add the correct Applicable tags to the top metadata and also the parameters for the cmdlet. See others for details.
52+
53+
6. Add the correct Applicable tags to the top metadata and also the parameters for the cmdlet.
54+
See others for details.
3855
This is important since when the XML is generated to go back into the product the applicable is what is used for which content goes into which product.
3956
7. Add the cmdlet to TOC. TOC file is the name of the module.
4057
For example, for all Skype cmdlets the TOC file is skype.md.

0 commit comments

Comments
 (0)