diff --git a/CHANGELOG.md b/CHANGELOG.md index 88046e4..c4f3d0b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -30,6 +30,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 by changing `CopyDirectories` to `CopyPaths` - Fixes [Issue #79](https://github.com/dsccommunity/WSManDsc/issues/79). - Pin `Pester` module to 4.10.1 because Pester 5.0 is missing code coverage - Fixes [Issue #78](https://github.com/dsccommunity/WSManDsc/issues/78). +- WSManDsc + - Automatically publish documentation to GitHub Wiki - Fixes [Issue #82](https://github.com/dsccommunity/WSManDsc/issues/82). ## [3.1.1] - 2020-01-31 diff --git a/build.yaml b/build.yaml index 218cfff..4caf15f 100644 --- a/build.yaml +++ b/build.yaml @@ -44,11 +44,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 0000000..10c2588 --- /dev/null +++ b/source/WikiSource/Home.md @@ -0,0 +1,35 @@ +# Welcome to the WSManDsc wiki + +*WSManDsc v#.#.#* + +Here you will find all the information you need to make use of the WSManDsc +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 WSManDsc. + +Please leave comments, feature requests, and bug reports in then +[issues section](https://github.com/dsccommunity/WSManDsc/issues) for this module. + +## Getting started + +To get started download WSManDsc from the [PowerShell Gallery](http://www.powershellgallery.com/packages/WSManDsc/) +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 WSManDsc -Repository PSGallery | Install-Module +``` + +To confirm installation, run the below command and ensure you see the WSManDsc +DSC resources available: + +```powershell +Get-DscResource -Module WSManDsc +``` + +## Change Log + +A full list of changes in each version can be found in the [change log](https://github.com/dsccommunity/WSManDsc/blob/master/CHANGELOG.md).