From 92b56005f5983240588e284c7981500f206c5d7d Mon Sep 17 00:00:00 2001 From: Daniel Scott-Raynsford Date: Sat, 4 Jul 2020 18:53:17 +1200 Subject: [PATCH] Automate Wiki Publish - Issue #241 --- CHANGELOG.md | 2 ++ build.yaml | 7 ++++--- source/WikiSource/Home.md | 35 +++++++++++++++++++++++++++++++++++ 3 files changed, 41 insertions(+), 3 deletions(-) create mode 100644 source/WikiSource/Home.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 102690d3..31ddd090 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -16,6 +16,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Removed integration test that tests when a disk is not in the system as it is not a useful test, does not work correctly and is covered by unit tests - Fixes [Issue #240](https://github.com/dsccommunity/StorageDsc/issues/240). +- StorageDsc + - Automatically publish documentation to GitHub Wiki - Fixes [Issue #241](https://github.com/dsccommunity/StorageDsc/issues/241). ## [5.0.0] - 2020-05-05 diff --git a/build.yaml b/build.yaml index 86139e9d..dc085061 100644 --- a/build.yaml +++ b/build.yaml @@ -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..5dc8342c --- /dev/null +++ b/source/WikiSource/Home.md @@ -0,0 +1,35 @@ +# Welcome to the StorageDsc wiki + +*StorageDsc v#.#.#* + +Here you will find all the information you need to make use of the StorageDsc +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 StorageDsc. + +Please leave comments, feature requests, and bug reports in then +[issues section](https://github.com/dsccommunity/StorageDsc/issues) for this module. + +## Getting started + +To get started download StorageDsc from the [PowerShell Gallery](http://www.powershellgallery.com/packages/StorageDsc/) +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 StorageDsc -Repository PSGallery | Install-Module +``` + +To confirm installation, run the below command and ensure you see the StorageDsc +DSC resources available: + +```powershell +Get-DscResource -Module StorageDsc +``` + +## Change Log + +A full list of changes in each version can be found in the [change log](https://github.com/dsccommunity/StorageDsc/blob/master/CHANGELOG.md).