Fix examples for Wiki (#202)

dsccommunity · Jun 12, 2022 · b0397fb · b0397fb
1 parent 6d1e087
commit b0397fb
Show file tree

Hide file tree

Showing 31 changed files with 153 additions and 37 deletions.
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/...ample_VMHardDiskDrive_VMWithExtraDisk.ps1 → ...ces/VMHardDiskDrive/1-VMWithExtraDisk.ps1 b/...ample_VMHardDiskDrive_VMWithExtraDisk.ps1 → ...ces/VMHardDiskDrive/1-VMWithExtraDisk.ps1
@@ -1,4 +1,8 @@
-configuration Sample_VMHardDiskDrive_VMWithExtraDisk
+<#
+    .DESCRIPTION
+        VM with an extra disk.
+#>
+configuration Example
 {
     param
     (

diff --git a/...MHardDiskDrive_VMWith4AdditionalDisks.ps1 → ...ardDiskDrive/2-VMWith4AdditionalDisks.ps1 b/...MHardDiskDrive_VMWith4AdditionalDisks.ps1 → ...ardDiskDrive/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/Sample_VMHost_Paths.ps1 → source/Examples/Resources/VMHost/1-Paths.ps1 b/source/Examples/Sample_VMHost_Paths.ps1 → 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/Sample_VMHyperV_Simple.ps1 → .../Examples/Resources/VMHyperV/1-Simple.ps1 b/source/Examples/Sample_VMHyperV_Simple.ps1 → .../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/...es/Sample_VMHyperV_SimpleWithDVDDrive.ps1 → ...sources/VMHyperV/2-SimpleWithDVDDrive.ps1 b/...es/Sample_VMHyperV_SimpleWithDVDDrive.ps1 → ...sources/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/...HyperV_SimpleWithNestedVirtualization.ps1 → ...perV/3-SimpleWithNestedVirtualization.ps1 b/...HyperV_SimpleWithNestedVirtualization.ps1 → ...perV/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/Sample_VMHyperV_Complete.ps1 → ...xamples/Resources/VMHyperV/4-Complete.ps1 b/source/Examples/Sample_VMHyperV_Complete.ps1 → ...xamples/Resources/VMHyperV/4-Complete.ps1
@@ -1,4 +1,8 @@
-configuration Sample_VMHyperV_Complete
+<#
+    .DESCRIPTION
+        Complete example.
+#>
+configuration Example
 {
     param
     (

diff --git a/...xamples/Sample_VMHyperV_DynamicMemory.ps1 → ...es/Resources/VMHyperV/5-DynamicMemory.ps1 b/...xamples/Sample_VMHyperV_DynamicMemory.ps1 → ...es/Resources/VMHyperV/5-DynamicMemory.ps1
@@ -1,4 +1,8 @@
-configuration Sample_VMHyperV_DynamicMemory
+<#
+    .DESCRIPTION
+        VM using dynamic memory.
+#>
+configuration Example
 {
     param
     (

diff --git a/...Examples/Sample_VMHyperV_MultipleNICs.ps1 → ...les/Resources/VMHyperV/6-MultipleNICs.ps1 b/...Examples/Sample_VMHyperV_MultipleNICs.ps1 → ...les/Resources/VMHyperV/6-MultipleNICs.ps1
@@ -1,4 +1,8 @@
-Configuration Sample_VMHyperV_MultipleNICs
+<#
+    .DESCRIPTION
+        Description not yet written.
+#>
+Configuration Example
 {
     param
     (

diff --git a/.../Sample_VMNetworkAdapter_ManagementOS.ps1 → ...urces/VMNetworkAdapter/1-ManagementOS.ps1 b/.../Sample_VMNetworkAdapter_ManagementOS.ps1 → ...urces/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/...VMNetworkAdapter_MultipleManagementOS.ps1 → ...NetworkAdapter/2-MultipleManagementOS.ps1 b/...VMNetworkAdapter_MultipleManagementOS.ps1 → ...NetworkAdapter/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/...es/Sample_VMNetworkAdapter_MultipleVM.ps1 → ...sources/VMNetworkAdapter/3-MultipleVM.ps1 b/...es/Sample_VMNetworkAdapter_MultipleVM.ps1 → ...sources/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/...VMNetworkAdapter_MultipleVMMACAddress.ps1 → ...NetworkAdapter/4-MultipleVMMACAddress.ps1 b/...VMNetworkAdapter_MultipleVMMACAddress.ps1 → ...NetworkAdapter/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/...etworkAdapter_VMStaticNetworkSettings.ps1 → ...workAdapter/5-VMStaticNetworkSettings.ps1 b/...etworkAdapter_VMStaticNetworkSettings.ps1 → ...workAdapter/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/...Sample_VMNetworkAdapter_VMVlanTagging.ps1 → ...rces/VMNetworkAdapter/6-VMVlanTagging.ps1 b/...Sample_VMNetworkAdapter_VMVlanTagging.ps1 → ...rces/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/...ample_VMScsiController_AddControllers.ps1 → ...ample_VMScsiController_AddControllers.ps1 b/...ample_VMScsiController_AddControllers.ps1 → ...ample_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/Sample_VMSwitch_External.ps1 → ...xamples/Resources/VMSwitch/1-External.ps1 b/source/Examples/Sample_VMSwitch_External.ps1 → ...xamples/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/...es/Sample_VMSwitch_ExternalSET_LBMode.ps1 → ...sources/VMSwitch/2-ExternalSET_LBMode.ps1 b/...es/Sample_VMSwitch_ExternalSET_LBMode.ps1 → ...sources/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/.../Examples/Sample_VMSwitch_ExternalSET.ps1 → ...ples/Resources/VMSwitch/3-ExternalSET.ps1 b/.../Examples/Sample_VMSwitch_ExternalSET.ps1 → ...ples/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/Sample_VMSwitch_Internal.ps1 → ...xamples/Resources/VMSwitch/4-Internal.ps1 b/source/Examples/Sample_VMSwitch_Internal.ps1 → ...xamples/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/Sample_Vhd_NewVHD.ps1 → source/Examples/Resources/Vhd/1-NewVHD.ps1 b/source/Examples/Sample_Vhd_NewVHD.ps1 → 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/...ples/Sample_Vhd_AdditionalPropertyVHD.ps1 → ...Resources/Vhd/2-AdditionalPropertyVHD.ps1 b/...ples/Sample_Vhd_AdditionalPropertyVHD.ps1 → ...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/Sample_Vhd_DiffVHD.ps1 → source/Examples/Resources/Vhd/3-DiffVHD.ps1 b/source/Examples/Sample_Vhd_DiffVHD.ps1 → 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/Sample_Vhd_FixedVHD.ps1 → source/Examples/Resources/Vhd/4-FixedVHD.ps1 b/source/Examples/Sample_Vhd_FixedVHD.ps1 → 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/...xamples/Sample_Vhd_MissingPropertyVHD.ps1 → ...es/Resources/Vhd/5-MissingPropertyVhd.ps1 b/...xamples/Sample_Vhd_MissingPropertyVHD.ps1 → ...es/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/...e/Examples/Sample_Vhd_ChangeAttribute.ps1 → ...s/Resources/VhdFile/1-ChangeAttribute.ps1 b/...e/Examples/Sample_Vhd_ChangeAttribute.ps1 → ...s/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/.../Examples/Sample_Vhd_CopyFileOrFolder.ps1 → .../Resources/VhdFile/2-CopyFileOrFolder.ps1 b/.../Examples/Sample_Vhd_CopyFileOrFolder.ps1 → .../Resources/VhdFile/2-CopyFileOrFolder.ps1
@@ -1,4 +1,8 @@
-Configuration Sample_Vhd_CopyFileOrFolder
+<#
+    .DESCRIPTION
+        Not yet written.
+#>
+Configuration Example
 {
     param
     (

diff --git a/.../Sample_Vhd_RemoveFileOrFolderFromVHD.ps1 → ...s/VhdFile/3-RemoveFileOrFolderFromVhd.ps1 b/.../Sample_Vhd_RemoveFileOrFolderFromVHD.ps1 → ...s/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'