Changes as per PR comments

dsccommunity · Sep 24, 2021 · cbf6975 · cbf6975
1 parent a333831
commit cbf6975
Show file tree

Hide file tree

Showing 17 changed files with 51 additions and 17 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -8,7 +8,7 @@
     "powershell.codeFormatting.whitespaceAroundOperator": true,
     "powershell.codeFormatting.whitespaceAfterSeparator": true,
     "powershell.codeFormatting.ignoreOneLineBlock": false,
-    "powershell.codeFormatting.pipelineIndentationStyle": "IncreaseIndentationAfterEveryPipeline",
+    "powershell.codeFormatting.pipelineIndentationStyle": "IncreaseIndentationForFirstPipeline",
     "powershell.codeFormatting.preset": "Custom",
     "files.trimTrailingWhitespace": true,
     "files.insertFinalNewline": true,

diff --git a/README.md b/README.md
@@ -16,7 +16,7 @@ The supported version of this module is available as
 
 > Note: New features are no longer being added to the **PSDscResource`** module.
 > If you require new features, please migrate to **xPSDesiredStateConfiguration**
-> and request the features against that module.
+> and request the features against this module.
 
 This module is automatically tested using PowerShell 5.1 on servers running
 Windows 2012 R2 and Windows 2016, and is expected to work on other operating

diff --git a/source/DSCResources/DSC_xPackageResource/en-US/DSC_xPackageResource.schema.mfl b/source/DSCResources/DSC_xPackageResource/en-US/DSC_xPackageResource.schema.mfl
@@ -1,5 +1,4 @@
-[Description("The xMsiPackage resource is used to manage MSI files.") : Amended,AMENDMENT, LOCALE("MS_409")]
-[Description("The xMsiPackage resource is used to manage MSI files.") : Amended,AMENDMENT, LOCALE("MS_409")]
+[Description("The xPackage resource is used to install or uninstall a package on the host.") : Amended,AMENDMENT, LOCALE("MS_409")]
 class DSC_xPackageResource : OMI_BaseResource
 {
   [Key, Description("The name of the package to be added or removed.") : Amended] string Name;

diff --git a/source/Examples/Resources/xDscWebService/1-xDscWebService_Preferred_Config.ps1 b/source/Examples/Resources/xDscWebService/1-xDscWebService_Preferred_Config.ps1
@@ -84,7 +84,7 @@ Configuration xDscWebService_Preferred_Config
         $ApplicationPoolName
     )
 
-    Import-DSCResource -ModuleName xPSDesiredStateConfiguration
+    Import-DscResource -ModuleName xPSDesiredStateConfiguration
     Import-DscResource -ModuleName NetworkingDsc -ModuleVersion 7.4.0.0
     Import-DscResource -ModuleName xWebAdministration -ModuleVersion 3.0.0.0
 

diff --git a/.../Examples/Resources/xDscWebService/2-xDscWebService_RegistrationUseSQLProvider_Config.ps1 b/.../Examples/Resources/xDscWebService/2-xDscWebService_RegistrationUseSQLProvider_Config.ps1
@@ -74,7 +74,7 @@ Configuration xDscWebService_RegistrationUseSQLProvider_Config
         $Port = 8080
     )
 
-    Import-DSCResource -ModuleName xPSDesiredStateConfiguration
+    Import-DscResource -ModuleName xPSDesiredStateConfiguration
     Import-DscResource -ModuleName NetworkingDsc -ModuleVersion 7.4.0.0
     # To explicitly import the resource WindowsFeature and File.
     Import-DscResource -ModuleName PSDesiredStateConfiguration

diff --git a/...xamples/Resources/xDscWebService/3-xDscWebService_RegistrationWin2k12and2k12R2_Config.ps1 b/...xamples/Resources/xDscWebService/3-xDscWebService_RegistrationWin2k12and2k12R2_Config.ps1
@@ -69,7 +69,7 @@ Configuration xDscWebService_RegistrationWin2k12and2k12R2_Config
         $Port = 8080
     )
 
-    Import-DSCResource -ModuleName xPSDesiredStateConfiguration
+    Import-DscResource -ModuleName xPSDesiredStateConfiguration
     Import-DscResource -ModuleName NetworkingDsc -ModuleVersion 7.4.0.0
     # To explicitly import the resource WindowsFeature and File.
     Import-DscResource -ModuleName PSDesiredStateConfiguration

diff --git a/source/Examples/Resources/xDscWebService/4-xDscWebService_Registration_Config.ps1 b/source/Examples/Resources/xDscWebService/4-xDscWebService_Registration_Config.ps1
@@ -74,7 +74,7 @@ Configuration xDscWebService_Registration_Config
         $Port = 8080
     )
 
-    Import-DSCResource -ModuleName xPSDesiredStateConfiguration
+    Import-DscResource -ModuleName xPSDesiredStateConfiguration
     Import-DscResource -ModuleName NetworkingDsc -ModuleVersion 7.4.0.0
 
     Node localhost

diff --git a/...esources/xDscWebService/5-xDscWebService_RegistrationWithSecurityBestPractices_Config.ps1 b/...esources/xDscWebService/5-xDscWebService_RegistrationWithSecurityBestPractices_Config.ps1
@@ -78,7 +78,7 @@ Configuration xDscWebService_RegistrationWithSecurityBestPractices_Config
         $Port = 8080
     )
 
-    Import-DSCResource -ModuleName xPSDesiredStateConfiguration
+    Import-DscResource -ModuleName xPSDesiredStateConfiguration
     Import-DscResource -ModuleName NetworkingDsc -ModuleVersion 7.4.0.0
     # To explicitly import the resource WindowsFeature and File.
     Import-DscResource -ModuleName PSDesiredStateConfiguration

diff --git a/source/Examples/Resources/xDscWebService/6-xDscWebService_Removal_Config.ps1 b/source/Examples/Resources/xDscWebService/6-xDscWebService_Removal_Config.ps1
@@ -21,7 +21,7 @@
 #>
 configuration xDscWebService_Removal_Config
 {
-    Import-DSCResource -ModuleName xPSDesiredStateConfiguration
+    Import-DscResource -ModuleName xPSDesiredStateConfiguration
 
     Node localhost
     {

diff --git a/source/Examples/Resources/xUser/1-xUser_CreateUser_Config.ps1 b/source/Examples/Resources/xUser/1-xUser_CreateUser_Config.ps1
@@ -40,7 +40,7 @@ Configuration xUser_CreateUser_Config
         $Credential
     )
 
-    Import-DSCResource -ModuleName xPSDesiredStateConfiguration
+    Import-DscResource -ModuleName xPSDesiredStateConfiguration
 
     Node localhost
     {

diff --git a/source/Examples/Resources/xUser/2-xUser_CreateUserDetailed_Config.ps1 b/source/Examples/Resources/xUser/2-xUser_CreateUserDetailed_Config.ps1
@@ -99,7 +99,7 @@ Configuration xUser_CreateUserDetailed_Config
         $Disabled
     )
 
-    Import-DSCResource -ModuleName xPSDesiredStateConfiguration
+    Import-DscResource -ModuleName xPSDesiredStateConfiguration
 
     Node localhost
     {

diff --git a/source/Examples/Resources/xUser/3-xUser_RemoveUser_Config.ps1 b/source/Examples/Resources/xUser/3-xUser_RemoveUser_Config.ps1
@@ -39,7 +39,7 @@ Configuration xUser_RemoveUser_Config
         $UserName
     )
 
-    Import-DSCResource -ModuleName xPSDesiredStateConfiguration
+    Import-DscResource -ModuleName xPSDesiredStateConfiguration
 
     Node localhost
     {

diff --git a/source/Examples/Resources/xWindowsProcess/1-xWindowsProcess_StartProcess_Config.ps1 b/source/Examples/Resources/xWindowsProcess/1-xWindowsProcess_StartProcess_Config.ps1
@@ -50,7 +50,7 @@ Configuration xWindowsProcess_StartProcess_Config
         $Argument
     )
 
-    Import-DSCResource -ModuleName xPSDesiredStateConfiguration
+    Import-DscResource -ModuleName xPSDesiredStateConfiguration
 
     Node localhost
     {

diff --git a/source/Examples/Resources/xWindowsProcess/2-xWindowsProcess_StartProcessUnderUser_Config.ps1 b/source/Examples/Resources/xWindowsProcess/2-xWindowsProcess_StartProcessUnderUser_Config.ps1
@@ -63,7 +63,7 @@ Configuration xWindowsProcess_StartProcessUnderUser_Config
         $Credential
     )
 
-    Import-DSCResource -ModuleName xPSDesiredStateConfiguration
+    Import-DscResource -ModuleName xPSDesiredStateConfiguration
 
     Node localhost
     {

diff --git a/source/Examples/Resources/xWindowsProcess/3-xWindowsProcess_StopProcess_Config.ps1 b/source/Examples/Resources/xWindowsProcess/3-xWindowsProcess_StopProcess_Config.ps1
@@ -55,7 +55,7 @@ Configuration xWindowsProcess_StopProcess_Config
         $Argument
     )
 
-    Import-DSCResource -ModuleName xPSDesiredStateConfiguration
+    Import-DscResource -ModuleName xPSDesiredStateConfiguration
 
     Node localhost
     {

diff --git a/source/Examples/Resources/xWindowsProcess/4-xWindowsProcess_StopProcessUnderUser_Config.ps1 b/source/Examples/Resources/xWindowsProcess/4-xWindowsProcess_StopProcessUnderUser_Config.ps1
@@ -68,7 +68,7 @@ Configuration xWindowsProcess_StopProcessUnderUser_Config
         $Credential
     )
 
-    Import-DSCResource -ModuleName xPSDesiredStateConfiguration
+    Import-DscResource -ModuleName xPSDesiredStateConfiguration
 
     Node localhost
     {

diff --git a/source/WikiSource/Home.md b/source/WikiSource/Home.md
@@ -0,0 +1,35 @@
+# Welcome to the xPSDesiredStateConfiguration wiki
+
+<sup>*xPSDesiredStateConfiguration v#.#.#*</sup>
+
+Here you will find all the information you need to make use of the xPSDesiredStateConfiguration
+DSC resources, including details of the resources that are available, current
+capabilities and known issues, and information to help plan a DSC based
+implementation of xPSDesiredStateConfiguration.
+
+Please leave comments, feature requests, and bug reports in then
+[issues section](https://github.com/dsccommunity/xPSDesiredStateConfiguration/issues) for this module.
+
+## Getting started
+
+To get started download xPSDesiredStateConfiguration from the [PowerShell Gallery](http://www.powershellgallery.com/packages/xPSDesiredStateConfiguration/)
+and then unzip it to one of your PowerShell modules folders
+(such as $env:ProgramFiles\WindowsPowerShell\Modules).
+
+To install from the PowerShell gallery using PowerShellGet (in PowerShell 5.0)
+run the following command:
+
+```powershell
+Find-Module -Name xPSDesiredStateConfiguration -Repository PSGallery | Install-Module
+```
+
+To confirm installation, run the below command and ensure you see the xPSDesiredStateConfiguration
+DSC resources available:
+
+```powershell
+Get-DscResource -Module xPSDesiredStateConfiguration
+```
+
+## Change Log
+
+A full list of changes in each version can be found in the [change log](https://github.com/dsccommunity/xPSDesiredStateConfiguration/blob/main/CHANGELOG.md).