Fix examples for Wiki (#202)

johlju · web-flow · commit b0397fbd78cb · 2022-06-12T14:54:40.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,6 +15,8 @@ For older change log history see the [historic changelog](HISTORIC_CHANGELOG.md)
     - Updated README.md from _xHyper-V_ to _HyperVDsc
   - Renamed default branch to `main` - Fixes [Issue #198](https://github.com/dsccommunity/HyperVDsc/issues/198).
   - Moved documentation to the HyperVDsc GitHub Wiki.
+  - Updated all examples to correct folders and naming so they show up
+    in the GitHub Wiki documentation and conceptual help.
 
 ## [3.18.0] - 2022-06-04
 
diff --git a/source/DSCResources/DSC_VHD/DSC_Vhd.schema.mof b/source/DSCResources/DSC_VHD/DSC_Vhd.schema.mof
@@ -2,7 +2,7 @@
 class DSC_Vhd : OMI_BaseResource
 {
     [Key, Description("The desired VHD file name.")] String Name;
-    [Key, Description("he desired Path where the VHD will be created.")] String Path;
+    [Key, Description("The desired Path where the VHD will be created.")] String Path;
     [Write, Description("Parent VHD file path, for differencing disk.")] String ParentPath;
     [Write, Description("Maximum size of VHD to be created.")] Uint64 MaximumSizeBytes;
     [Write, Description("Virtual disk format. The default value is `Vhd`."), ValueMap{"Vhd","Vhdx"}, Values{"Vhd","Vhdx"}] String Generation;
diff --git a/source/Examples/Resources/VMHardDiskDrive/1-VMWithExtraDisk.ps1 b/source/Examples/Resources/VMHardDiskDrive/1-VMWithExtraDisk.ps1
@@ -1,4 +1,8 @@
-configuration Sample_VMHardDiskDrive_VMWithExtraDisk
+<#
+    .DESCRIPTION
+        VM with an extra disk.
+#>
+configuration Example
 {
     param
     (
diff --git a/source/Examples/Resources/VMHardDiskDrive/2-VMWith4AdditionalDisks.ps1 b/source/Examples/Resources/VMHardDiskDrive/2-VMWith4AdditionalDisks.ps1
@@ -1,4 +1,8 @@
-configuration Sample_VMHardDiskDrive_VMWith4AdditionalDisks
+<#
+    .DESCRIPTION
+        VM with 4 additional disks.
+#>
+configuration Example
 {
     param
     (
diff --git a/source/Examples/Resources/VMHost/1-Paths.ps1 b/source/Examples/Resources/VMHost/1-Paths.ps1
@@ -1,4 +1,8 @@
-Configuration Sample_VMHost_Paths
+<#
+    .DESCRIPTION
+        Set paths för the Hyper-V host.
+#>
+Configuration Example
 {
     param
     (
diff --git a/source/Examples/Resources/VMHyperV/1-Simple.ps1 b/source/Examples/Resources/VMHyperV/1-Simple.ps1
@@ -1,4 +1,8 @@
-configuration Sample_VMHyperV_Simple
+<#
+    .DESCRIPTION
+        Create a new VM.
+#>
+configuration Example
 {
     param
     (
diff --git a/source/Examples/Resources/VMHyperV/2-SimpleWithDVDDrive.ps1 b/source/Examples/Resources/VMHyperV/2-SimpleWithDVDDrive.ps1
@@ -1,4 +1,8 @@
-configuration Sample_VMHyperV_SimpleWithDvdDrive
+<#
+    .DESCRIPTION
+        Create a VM with DVD drive attached to it.
+#>
+configuration Example
 {
     param
     (
diff --git a/source/Examples/Resources/VMHyperV/3-SimpleWithNestedVirtualization.ps1 b/source/Examples/Resources/VMHyperV/3-SimpleWithNestedVirtualization.ps1
@@ -1,4 +1,8 @@
-configuration Sample_VMHyperV_SimpleWithNestedVirtualization
+<#
+    .DESCRIPTION
+        Create a VM with nested virtualization.
+#>
+configuration Example
 {
     param
     (
diff --git a/source/Examples/Resources/VMHyperV/4-Complete.ps1 b/source/Examples/Resources/VMHyperV/4-Complete.ps1
@@ -1,4 +1,8 @@
-configuration Sample_VMHyperV_Complete
+<#
+    .DESCRIPTION
+        Complete example.
+#>
+configuration Example
 {
     param
     (
diff --git a/source/Examples/Resources/VMHyperV/5-DynamicMemory.ps1 b/source/Examples/Resources/VMHyperV/5-DynamicMemory.ps1
@@ -1,4 +1,8 @@
-configuration Sample_VMHyperV_DynamicMemory
+<#
+    .DESCRIPTION
+        VM using dynamic memory.
+#>
+configuration Example
 {
     param
     (
diff --git a/source/Examples/Resources/VMHyperV/6-MultipleNICs.ps1 b/source/Examples/Resources/VMHyperV/6-MultipleNICs.ps1
@@ -1,4 +1,8 @@
-Configuration Sample_VMHyperV_MultipleNICs
+<#
+    .DESCRIPTION
+        Description not yet written.
+#>
+Configuration Example
 {
     param
     (
diff --git a/source/Examples/Resources/VMNetworkAdapter/1-ManagementOS.ps1 b/source/Examples/Resources/VMNetworkAdapter/1-ManagementOS.ps1
@@ -1,4 +1,8 @@
-Configuration Sample_VMNetworkAdapter_ManagementOS
+<#
+    .DESCRIPTION
+        Description not yet written.
+#>
+Configuration Example
 {
     Import-DscResource -ModuleName 'HyperVDsc' -Name VMNetworkAdapter
     Import-DscResource -ModuleName PSDesiredStateConfiguration
diff --git a/source/Examples/Resources/VMNetworkAdapter/2-MultipleManagementOS.ps1 b/source/Examples/Resources/VMNetworkAdapter/2-MultipleManagementOS.ps1
@@ -1,4 +1,8 @@
-Configuration Sample_VMNetworkAdapter_MultipleManagementOS
+<#
+    .DESCRIPTION
+        Description not yet written.
+#>
+Configuration Example
 {
     Import-DscResource -ModuleName 'HyperVDsc' -Name VMNetworkAdapter
     Import-DscResource -ModuleName PSDesiredStateConfiguration
diff --git a/source/Examples/Resources/VMNetworkAdapter/3-MultipleVM.ps1 b/source/Examples/Resources/VMNetworkAdapter/3-MultipleVM.ps1
@@ -1,4 +1,8 @@
-Configuration Sample_VMNetworkAdapter_MultipleVM
+<#
+    .DESCRIPTION
+        Add three network adapters to the same switch.
+#>
+Configuration Example
 {
     Import-DscResource -ModuleName 'HyperVDsc' -Name VMNetworkAdapter
     Import-DscResource -ModuleName PSDesiredStateConfiguration
diff --git a/source/Examples/Resources/VMNetworkAdapter/4-MultipleVMMACAddress.ps1 b/source/Examples/Resources/VMNetworkAdapter/4-MultipleVMMACAddress.ps1
@@ -1,4 +1,8 @@
-Configuration Sample_VMNetworkAdapter_MultipleVMMACAddress
+<#
+    .DESCRIPTION
+        Description not yet written.
+#>
+Configuration Example
 {
     Import-DscResource -ModuleName 'HyperVDsc' -Name VMNetworkAdapter
     Import-DscResource -ModuleName PSDesiredStateConfiguration
diff --git a/source/Examples/Resources/VMNetworkAdapter/5-VMStaticNetworkSettings.ps1 b/source/Examples/Resources/VMNetworkAdapter/5-VMStaticNetworkSettings.ps1
@@ -1,4 +1,8 @@
-Configuration Sample_VMNetworkAdapter_VMStaticNetworkSettings
+<#
+    .DESCRIPTION
+        Add a network adapter that is using static IP address.
+#>
+Configuration Example
 {
     Import-DscResource -ModuleName 'HyperVDsc'
 
diff --git a/source/Examples/Resources/VMNetworkAdapter/6-VMVlanTagging.ps1 b/source/Examples/Resources/VMNetworkAdapter/6-VMVlanTagging.ps1
@@ -1,4 +1,8 @@
-Configuration Sample_VMNetworkAdapter_VMVlanTagging
+<#
+    .DESCRIPTION
+        Add a network adapter that is using a VLAN tag.
+#>
+Configuration Example
 {
     Import-DscResource -ModuleName 'HyperVDsc' -Name VMNetworkAdapter
     Import-DscResource -ModuleName PSDesiredStateConfiguration
diff --git a/source/Examples/Resources/VMScsiController/Sample_VMScsiController_AddControllers.ps1 b/source/Examples/Resources/VMScsiController/Sample_VMScsiController_AddControllers.ps1
@@ -1,4 +1,8 @@
-configuration Sample_VMScsiController_AddControllers
+<#
+    .DESCRIPTION
+        Add a SCSI controller to a VM.
+#>
+configuration Example
 {
     param
     (
diff --git a/source/Examples/Resources/VMSwitch/1-External.ps1 b/source/Examples/Resources/VMSwitch/1-External.ps1
@@ -1,4 +1,8 @@
-configuration Sample_VMSwitch_External
+<#
+    .DESCRIPTION
+        Creates a switch of the type External.
+#>
+configuration Example
 {
     param
     (
diff --git a/source/Examples/Resources/VMSwitch/2-ExternalSET_LBMode.ps1 b/source/Examples/Resources/VMSwitch/2-ExternalSET_LBMode.ps1
@@ -1,4 +1,8 @@
-Configuration Sample_VMSwitch_ExternalSET_LBMode
+<#
+    .DESCRIPTION
+        Creates a switch that is of type External and using load balancing.
+#>
+Configuration Example
 {
     param
     (
diff --git a/source/Examples/Resources/VMSwitch/3-ExternalSET.ps1 b/source/Examples/Resources/VMSwitch/3-ExternalSET.ps1
@@ -1,4 +1,8 @@
-Configuration Sample_VMSwitch_ExternalSET
+<#
+    .DESCRIPTION
+        Creates a switch of the type External and uses embedded teaming.
+#>
+Configuration Example
 {
     param
     (
diff --git a/source/Examples/Resources/VMSwitch/4-Internal.ps1 b/source/Examples/Resources/VMSwitch/4-Internal.ps1
@@ -1,4 +1,8 @@
-configuration Sample_VMSwitch_Internal
+<#
+    .DESCRIPTION
+        Creates a switch of the type Internal.
+#>
+configuration Example
 {
     param
     (
diff --git a/source/Examples/Resources/Vhd/1-NewVHD.ps1 b/source/Examples/Resources/Vhd/1-NewVHD.ps1
@@ -1,4 +1,8 @@
-configuration Sample_VHD_NewVhd
+<#
+    .DESCRIPTION
+        Description not yet written.
+#>
+configuration Example
 {
     param
     (
diff --git a/source/Examples/Resources/Vhd/2-AdditionalPropertyVHD.ps1 b/source/Examples/Resources/Vhd/2-AdditionalPropertyVHD.ps1
@@ -1,4 +1,8 @@
-configuration Sample_Vhd_AdditionalPropertyVHD
+<#
+    .DESCRIPTION
+        Description not yet written.
+#>
+configuration Example
 {
     param
     (
diff --git a/source/Examples/Resources/Vhd/3-DiffVHD.ps1 b/source/Examples/Resources/Vhd/3-DiffVHD.ps1
@@ -1,4 +1,8 @@
-configuration Sample_Vhd_DiffVhd
+<#
+    .DESCRIPTION
+        Description not yet written.
+#>
+configuration Example
 {
     param
     (
diff --git a/source/Examples/Resources/Vhd/4-FixedVHD.ps1 b/source/Examples/Resources/Vhd/4-FixedVHD.ps1
@@ -1,4 +1,8 @@
-configuration Sample_Vhd_FixedVhd
+<#
+    .DESCRIPTION
+        Description not yet written.
+#>
+configuration Example
 {
     param
     (
diff --git a/source/Examples/Resources/Vhd/5-MissingPropertyVhd.ps1 b/source/Examples/Resources/Vhd/5-MissingPropertyVhd.ps1
@@ -1,4 +1,8 @@
-configuration Sample_VHD_MissingPropertyVHD
+<#
+    .DESCRIPTION
+        Description not yet written.
+#>
+configuration Example
 {
     param
     (
@@ -25,7 +29,7 @@ configuration Sample_VHD_MissingPropertyVHD
 
     Node localhost
     {
-        VHD WrongVHD
+        Vhd WrongVHD
         {
             Ensure     = $Ensure
             Name       = $Name
diff --git a/source/Examples/Resources/VhdFile/1-ChangeAttribute.ps1 b/source/Examples/Resources/VhdFile/1-ChangeAttribute.ps1
@@ -1,11 +1,15 @@
-Configuration Sample_Vhd_ChangeAttribute
+<#
+    .DESCRIPTION
+        Not yet written.
+#>
+Configuration Example
 {
     param
     (
-        [Parameter(Mandatory = $true, Position = 0)]
+        [Parameter()]
         $vhdPath = 'C:\temp\disk.vhdx',
 
-        [Parameter(Mandatory = $true)]
+        [Parameter()]
         $relativeDestinationPath = 'Temp',
 
         [Parameter()]
@@ -23,6 +27,5 @@ Configuration Sample_Vhd_ChangeAttribute
             DestinationPath = $relativeDestinationPath
             Attributes      = $attribute
         }
-
     }
 }
diff --git a/source/Examples/Resources/VhdFile/2-CopyFileOrFolder.ps1 b/source/Examples/Resources/VhdFile/2-CopyFileOrFolder.ps1
@@ -1,4 +1,8 @@
-Configuration Sample_Vhd_CopyFileOrFolder
+<#
+    .DESCRIPTION
+        Not yet written.
+#>
+Configuration Example
 {
     param
     (
diff --git a/source/Examples/Resources/VhdFile/3-RemoveFileOrFolderFromVhd.ps1 b/source/Examples/Resources/VhdFile/3-RemoveFileOrFolderFromVhd.ps1
@@ -1,4 +1,8 @@
-Configuration Sample_Vhd_RemoveFileOrFolderFromVHD
+<#
+    .DESCRIPTION
+        Not yet written.
+#>
+Configuration Example
 {
     param
     (
diff --git a/source/Examples/Sample_EndToEndHyperV_RunningVM.ps1 b/source/Examples/Sample_EndToEndHyperV_RunningVM.ps1
@@ -1,5 +1,8 @@
-# End to end sample for x-Hyper-v
-Configuration Sample_EndToEndHyperV_RunningVM
+<#
+    .DESCRIPTION
+        End to end sample for running a VM in HyperV
+#>
+Configuration Example
 {
     param
     (
@@ -36,7 +39,7 @@ Configuration Sample_EndToEndHyperV_RunningVM
 
     # Customize VHD by copying a folders/files to the VHD before a VM can be created
     # Example below shows copying unattended.xml before a VM can be created
-    VhdFile CopyUnattendxml
+    VhdFile CopyUnattendedXml
     {
         VhdPath       = $vhdPath
         FileDirectory = DSC_FileDirectory
@@ -47,7 +50,7 @@ Configuration Sample_EndToEndHyperV_RunningVM
     }
 
     # create the testVM out of the vhd.
-    VMHyperV testvm
+    VMHyperV TestVM
     {
         Name            = "$($name)_vm"
         SwitchName      = 'Test-Switch'

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`	`class DSC_Vhd : OMI_BaseResource`
`3`	`3`	`{`
`4`	`4`	`[Key, Description("The desired VHD file name.")] String Name;`
`5`		`- [Key, Description("he desired Path where the VHD will be created.")] String Path;`
	`5`	`+ [Key, Description("The desired Path where the VHD will be created.")] String Path;`
`6`	`6`	`[Write, Description("Parent VHD file path, for differencing disk.")] String ParentPath;`
`7`	`7`	`[Write, Description("Maximum size of VHD to be created.")] Uint64 MaximumSizeBytes;`
`8`	`8`	[Write, Description("Virtual disk format. The default value is `Vhd`."), ValueMap{"Vhd","Vhdx"}, Values{"Vhd","Vhdx"}] String Generation;
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,8 @@`
`1`		`-configuration Sample_VMHardDiskDrive_VMWithExtraDisk`
	`1`	`+<#`
	`2`	`+ .DESCRIPTION`
	`3`	`+ VM with an extra disk.`
	`4`	`+#>`
	`5`	`+configuration Example`
`2`	`6`	`{`
`3`	`7`	`param`
`4`	`8`	`(`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,8 @@`
`1`		`-Configuration Sample_VMHost_Paths`
	`1`	`+<#`
	`2`	`+ .DESCRIPTION`
	`3`	`+ Set paths för the Hyper-V host.`
	`4`	`+#>`
	`5`	`+Configuration Example`
`2`	`6`	`{`
`3`	`7`	`param`
`4`	`8`	`(`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,8 @@`
`1`		`-configuration Sample_VMHyperV_Simple`
	`1`	`+<#`
	`2`	`+ .DESCRIPTION`
	`3`	`+ Create a new VM.`
	`4`	`+#>`
	`5`	`+configuration Example`
`2`	`6`	`{`
`3`	`7`	`param`
`4`	`8`	`(`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,8 @@`
`1`		`-configuration Sample_VMHyperV_SimpleWithDvdDrive`
	`1`	`+<#`
	`2`	`+ .DESCRIPTION`
	`3`	`+ Create a VM with DVD drive attached to it.`
	`4`	`+#>`
	`5`	`+configuration Example`
`2`	`6`	`{`
`3`	`7`	`param`
`4`	`8`	`(`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,8 @@`
`1`		`-configuration Sample_VMHyperV_Complete`
	`1`	`+<#`
	`2`	`+ .DESCRIPTION`
	`3`	`+ Complete example.`
	`4`	`+#>`
	`5`	`+configuration Example`
`2`	`6`	`{`
`3`	`7`	`param`
`4`	`8`	`(`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,8 @@`
`1`		`-configuration Sample_VMHyperV_DynamicMemory`
	`1`	`+<#`
	`2`	`+ .DESCRIPTION`
	`3`	`+ VM using dynamic memory.`
	`4`	`+#>`
	`5`	`+configuration Example`
`2`	`6`	`{`
`3`	`7`	`param`
`4`	`8`	`(`