From 882a9f979a28626d75e860ff05fcd70ff45effdd Mon Sep 17 00:00:00 2001 From: Daniel Scott-Raynsford Date: Mon, 6 Jul 2020 08:07:35 +1200 Subject: [PATCH] Automate Wiki Publish - Issue #41 (#42) * Automate Wiki Publish - Issue #41 * Fix Wiki Home --- CHANGELOG.md | 5 +++++ build.yaml | 7 ++++--- source/WikiSource/Home.md | 35 +++++++++++++++++++++++++++++++++++ 3 files changed, 44 insertions(+), 3 deletions(-) create mode 100644 source/WikiSource/Home.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 9994cc0f..61bc126a 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 + +- FSRMDsc + - Automatically publish documentation to GitHub Wiki - Fixes [Issue #41](https://github.com/dsccommunity/FSRMDsc/issues/41). + ## [2.5.0] - 2020-06-20 ### Changed diff --git a/build.yaml b/build.yaml index 3c625dc4..a8398c40 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 00000000..883facd7 --- /dev/null +++ b/source/WikiSource/Home.md @@ -0,0 +1,35 @@ +# Welcome to the FSRMDsc wiki + +*FSRMDsc v#.#.#* + +Here you will find all the information you need to make use of the FSRMDsc +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 FSRMDsc. + +Please leave comments, feature requests, and bug reports in then +[issues section](https://github.com/dsccommunity/FSRMDsc/issues) for this module. + +## Getting started + +To get started download FSRMDsc from the [PowerShell Gallery](http://www.powershellgallery.com/packages/FSRMDsc/) +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 FSRMDsc -Repository PSGallery | Install-Module +``` + +To confirm installation, run the below command and ensure you see the FSRMDsc +DSC resources available: + +```powershell +Get-DscResource -Module FSRMDsc +``` + +## Change Log + +A full list of changes in each version can be found in the [change log](https://github.com/dsccommunity/FSRMDsc/blob/master/CHANGELOG.md).