diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000000..9c751b96f8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,23 @@ +--- +name: Bug report +about: Report errors or unexpected behaviour +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behaviour. + +**Expected behaviour** +A clear and concise description of what you expected to happen. + +**Error output** +Capture any error messages and or verbose messages with `-Verbose`. + +**Module in use and version (please complete the following information):** + - Module: [e.g. PSRule] + - Version [e.g. 0.1.0] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000000..764af6306f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,16 @@ +--- +name: Feature request +about: Suggest an idea +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/CHANGELOG.md b/CHANGELOG.md index 97127e40ce..27419c252b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,2 @@ -# Change log ## Unreleased diff --git a/README.md b/README.md index f0ab46ddcf..8ef7799b00 100644 --- a/README.md +++ b/README.md @@ -2,26 +2,23 @@ A PowerShell module with commands to validate objects on the pipeline. -| AppVeyor (Windows) | Codecov (Windows) | -| --- | --- | -| [![av-image][]][av-site] | [![cc-image][]][cc-site] | - -[av-image]: https://ci.appveyor.com/api/projects/status/pl7tu7ktue388n7s -[av-site]: https://ci.appveyor.com/project/BernieWhite/PSRule -[cc-image]: https://codecov.io/gh/BernieWhite/PSRule/branch/master/graph/badge.svg -[cc-site]: https://codecov.io/gh/BernieWhite/PSRule +![ci-badge] ## Disclaimer -This project is to be considered a **proof-of-concept** and **not a supported Microsoft product**. +This project is to be considered a **proof-of-concept** and **not a supported product**. + +If you have any problems please check our GitHub [issues](https://github.com/BernieWhite/PSRule/issues) page. If you do not see your problem captured, please file a new issue and follow the provided template. ## Modules -The following modules are included in this repository. +## Getting the modules + +You can download and install these PowerShell modules from the PowerShell Gallery. -| Module | Description | Latest version | -| ------ | ----------- | -------------- | -| PSRule | A PowerShell rules engine. | Unreleased | +| Module | Description | Downloads / instructions | +| ------ | ----------- | ------------------------ | +| PSRule | A PowerShell rules engine | Unreleased | ## Getting started @@ -64,4 +61,6 @@ Modules in this repository will use the [semantic versioning](http://semver.org/ This project is [licensed under the MIT License](LICENSE). -[psg-psrule]: https://www.powershellgallery.com/packages/PSRule \ No newline at end of file +[install]: docs/scenarios/install-instructions.md +[ci-badge]: https://bewhite.visualstudio.com/PSRule/_apis/build/status/PSRule-CI?branchName=master +[psg-psrule]: https://www.powershellgallery.com/packages/PSRule diff --git a/docs/commands/PSRule/en-US/Invoke-RuleEngine.md b/docs/commands/PSRule/en-US/Invoke-RuleEngine.md index 92b9aa9db2..92567adc54 100644 --- a/docs/commands/PSRule/en-US/Invoke-RuleEngine.md +++ b/docs/commands/PSRule/en-US/Invoke-RuleEngine.md @@ -1,7 +1,7 @@ --- external help file: PSRule-help.xml Module Name: PSRule -online version: +online version: https://github.com/BernieWhite/PSRule/blob/master/docs/commands/PSRule/en-US/Invoke-RuleEngine.md schema: 2.0.0 --- @@ -13,7 +13,7 @@ Evaluate pipeline objects against matching rules. ## SYNTAX -``` +```text Invoke-RuleEngine [-Path] [[-ConfigurationData] ] [-InputObject] [[-Status] ] [] ``` @@ -30,12 +30,13 @@ Evaluate pipeline objects against matching rules. PS C:\> @{ Name = 'Item 1' } | Invoke-RuleEngine . ``` -{{ Add example description here }} +Evaluate a simple hashtable on the pipeline against rules loaded from the current working path. ## PARAMETERS ### -ConfigurationData -{{Fill ConfigurationData Description}} + +Additional configuration data that can be referenced from rules. ConfigurationData can be a hashtable or a valid file path to a `.psd1` file. ```yaml Type: Object diff --git a/docs/keywords/PSRule/en-US/about_PSRule_Keywords.md b/docs/keywords/PSRule/en-US/about_PSRule_Keywords.md index 4b55fb9e9c..a631eec79c 100644 --- a/docs/keywords/PSRule/en-US/about_PSRule_Keywords.md +++ b/docs/keywords/PSRule/en-US/about_PSRule_Keywords.md @@ -279,7 +279,7 @@ An online version of this document is available at https://github.com/BernieWhit ## SEE ALSO -- [Invoke-PSDocument] +- [Invoke-RuleEngine] ## KEYWORDS @@ -292,4 +292,4 @@ An online version of this document is available at https://github.com/BernieWhit - When - TypeOf -[Invoke-RuleEngine]: https://github.com/BernieWhite/PSRule/docs/commands/PSRule/en-US/Invoke-RuleEngine.md \ No newline at end of file +[Invoke-RuleEngine]: https://github.com/BernieWhite/PSRule/blob/master/docs/commands/PSRule/en-US/Invoke-RuleEngine.md \ No newline at end of file