diff --git a/CHANGELOG.md b/CHANGELOG.md index 9a905a9b..5395348d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +### Changed + +- ComputerManagementDsc + - Automatically publish documentation to GitHub Wiki - Fixes [Issue #342](https://github.com/dsccommunity/ComputerManagementDsc/issues/342). + ## [8.3.0] - 2020-06-30 ### Changed diff --git a/build.yaml b/build.yaml index 86139e9d..e362173d 100644 --- a/build.yaml +++ b/build.yaml @@ -32,7 +32,7 @@ BuildWorkflow: - Clean - Build_Module_ModuleBuilder - Build_NestedModules_ModuleBuilder - - Create_changelog_release_output + - Create_Changelog_Release_Output - Generate_Conceptual_Help - Generate_Wiki_Content @@ -45,11 +45,12 @@ BuildWorkflow: test: - Pester_Tests_Stop_On_Fail - - Pester_if_Code_Coverage_Under_Threshold + - Pester_If_Code_Coverage_Under_Threshold publish: - - Publish_release_to_GitHub - - publish_module_to_gallery + - Publish_Release_to_GitHub + - Publish_Module_to_gallery + - Publish_GitHub_Wiki_Content #################################################### # PESTER Configuration # diff --git a/source/WikiSource/Home.md b/source/WikiSource/Home.md new file mode 100644 index 00000000..d9443f3e --- /dev/null +++ b/source/WikiSource/Home.md @@ -0,0 +1,35 @@ +# Welcome to the ComputerManagementDsc wiki + +*ComputerManagementDsc v#.#.#* + +Here you will find all the information you need to make use of the ComputerManagementDsc +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 ComputerManagementDsc. + +Please leave comments, feature requests, and bug reports in then +[issues section](https://github.com/dsccommunity/ComputerManagementDsc/issues) for this module. + +## Getting started + +To get started download ComputerManagementDsc from the [PowerShell Gallery](http://www.powershellgallery.com/packages/ComputerManagementDsc/) +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 ComputerManagementDsc -Repository PSGallery | Install-Module +``` + +To confirm installation, run the below command and ensure you see the ComputerManagementDsc +DSC resources available: + +```powershell +Get-DscResource -Module ComputerManagementDsc +``` + +## Change Log + +A full list of changes in each version can be found in the [change log](https://github.com/dsccommunity/ComputerManagementDsc/blob/master/CHANGELOG.md).