Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automate Wiki Publish - Issue #241 #242

Merged
merged 1 commit into from
Jul 16, 2020
Merged

Automate Wiki Publish - Issue #241 #242

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
7 changes: 4 additions & 3 deletions build.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 #
Expand Down
35 changes: 35 additions & 0 deletions source/WikiSource/Home.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Welcome to the StorageDsc wiki

<sup>*StorageDsc v#.#.#*</sup>

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).