Skip to content

Commit 073e25a

Browse files
committed
Fixes formatting and adds note.
1 parent ea19287 commit 073e25a

File tree

1 file changed

+17
-18
lines changed

1 file changed

+17
-18
lines changed

repo_docs/NEW_CMDLETS.md

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,16 @@
22
**SECTION IN PROGRESS**
33

44
1. Open PowerShell as Administrator.
5-
2. Import the module you want to document.
6-
- Skype for Business Online: https://technet.microsoft.com/en-us/library/dn362795(v=ocs.15).aspx
7-
- Microsoft Teams: https://blogs.technet.microsoft.com/skypehybridguy/2017/11/07/microsoft-teams-powershell-support/
8-
Hint: Might need to use Upgrade-Module and also Uninstall-Module depending on version and if you already have a version installed.
9-
3. Use PlatyPS to generate Markdown.
10-
- Skype for Business Online: `New-MarkdownHelp -module tmp_byivwzpq.e1k -OutputFolder .\docs`.
11-
4. Find the new cmdlet and you will see the stubbed markdown.
12-
5. Add correct metadata, see other similar cmdlets for examples.
5+
1. Import the module you want to document.
6+
- Skype for Business Online: https://technet.microsoft.com/en-us/library/dn362795(v=ocs.15).aspx
7+
- Microsoft Teams: https://blogs.technet.microsoft.com/skypehybridguy/2017/11/07/microsoft-teams-powershell-support/
8+
Hint: Might need to use Upgrade-Module and also Uninstall-Module depending on version and if you already have a version installed.
9+
1. Use PlatyPS to generate Markdown.
10+
- Skype for Business Online: `New-MarkdownHelp -module tmp_byivwzpq.e1k -OutputFolder .\docs`.
11+
1. Find the new cmdlet and you will see the stubbed markdown.
12+
1. Add the correct Applicable tags to the top metadata and also the parameters for the cmdlet.
13+
See others for details.
14+
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.
1315

1416
You will need to add the title and also applicable metadata for the cmdlet and also for each parameter.
1517

@@ -38,21 +40,18 @@
3840
Accept wildcard characters: False
3941
```
4042
41-
6. Add the correct Applicable tags to the top metadata and also the parameters for the cmdlet.
42-
See others for details.
43-
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.
44-
7. Add the cmdlet to TOC. TOC file is the name of the module.
45-
For example, for all Skype cmdlets the TOC file is skype.md.
46-
8. Submit a Pull Request into the repo in appropriate place with adding the new cmdlet. aka.ms/office-powershell
4743
44+
1. Add the cmdlet to TOC. TOC file is the name of the module.
45+
For example, for all Teams cmdlets the TOC file is teams.md.
46+
You can fill in a description or remove the template text line.
47+
However, if you leave the template text line make sure it is exactly in the right format so that it will not render as a template text.
48+
1. Submit a Pull Request into the repo in appropriate place with adding the new cmdlet. aka.ms/office-powershell
4849
4950
50-
If you want to merge multiple versions into a single version then use the PlatyPS merge command.
51-
52-
Make sure to update the TOC file. Exact format required so that the template text doesn't show up.
5351
54-
Add metadata to the file so it shows in the correct reports. See these scripts to do it or you can do it manually too.
52+
If you want to merge multiple versions into a single version then use the PlatyPS merge command.
5553
54+
Note: If this is a brand new product you need to add metadata at the global level in order for it to show up in reporting.
5655
5756
References:
5857
https://docs.microsoft.com/en-us/powershell/module/powershellget/install-module?view=powershell-6

0 commit comments

Comments
 (0)