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: documentation/development-docs/help-generation.md
+5-6Lines changed: 5 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ All MAML files containing the help content for cmdlets have been removed from th
6
6
7
7
## Installing `platyPS`
8
8
9
-
In order to use the cmdlets necessary to update the markdown help files (or generate MAML help locally from these markdown files), you must first install the `platyPS` module mentioned previously.
9
+
In order to use the cmdlets necessary to update the markdown help files (or generate MAML help locally from these markdown files), you must first install the `platyPS` module mentioned previously. You will need to install a minimum version of 0.11.0.
10
10
11
11
To do so, you can can follow the below steps (which are outlined in the [**Quick start**](https://github.com/PowerShell/platyPS#quick-start) section of the `platyPS` README):
12
12
@@ -62,13 +62,10 @@ $PathToModuleManifest = "../../<module.psd1" # Full path to the module manifest
62
62
Import-Module -Name $PathToModuleManifest
63
63
64
64
$PathToHelpFolder = "../../help" # Full path to help folder containing markdown files to be updated
Because the -UseFullTypeName parameter is not yet available in Update-MarkdownHelpModule (it will be enabled in the upcoming release of PlatyPS), you will need to run this command to modify the help files to use full type names:
If you would like to update the inputs/outputs for a markdown file, please run this cmdlet with the -UpdateInputOutput parameter. Keep in mind that this will overwrite any customized descriptions of inputs and outputs, so you will need to add these descriptions back if still relevant.
72
69
73
70
This will update all of the markdown files with public interface changes made to corresponding cmdlets, add markdown files for any new cmdlets, remove markdown files for any deleted cmdlets, and update the module page (_e.g.,_`AzureRM.Profile.md`) with any added or removed cmdlets.
74
71
@@ -86,6 +83,8 @@ $PathToMarkdownFile = "../../<cmdlet>.md" # Full path to the markdown file to be
If you would like to update the inputs/outputs for a markdown file, please run this cmdlet with the -UpdateInputOutput parameter. Keep in mind that this will overwrite any customized descriptions of inputs and outputs, so you will need to add these descriptions back if still relevant.
87
+
89
88
#### Generating and viewing the MAML help
90
89
91
90
During the build, the MAML help will be generated from the markdown files in the repository. If you would like to generate the MAML help and preview what the help content will look like for each of your cmdlets, you can do so with two more commands.
0 commit comments