Support and general doc updates (#12)

* Support and general doc updates

* Add question issue template
This commit is contained in:
Bernie White 2021-01-07 12:50:42 +10:00 коммит произвёл GitHub
Родитель c3140a0813
Коммит 017246bb3b
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
4 изменённых файлов: 30 добавлений и 15 удалений

11
.github/ISSUE_TEMPLATE/question.md поставляемый Normal file
Просмотреть файл

@ -0,0 +1,11 @@
---
name: Question
about: If you have a question, please check out Discussions
labels: 'question'
---
We use Issues as an issue tracker; for help, discussion, and support questions, please use Discussions.
Thanks! 😁.
- https://github.com/microsoft/PSRule.Rules.MSFT.OSS/discussions

Просмотреть файл

@ -58,7 +58,6 @@ Before improving rule recommendations familiarize yourself with writing [rule ma
Rule documentation requires the following annotations: Rule documentation requires the following annotations:
- `severity`
- `category` - `category`
- `online version` - `online version`

Просмотреть файл

@ -10,10 +10,8 @@ This module is intended to be used by Microsoft repositories, and also serves as
This project uses GitHub Issues to track bugs and feature requests. This project uses GitHub Issues to track bugs and feature requests.
Please search the existing issues before filing new issues to avoid duplicates. Please search the existing issues before filing new issues to avoid duplicates.
- For new issues, file your bug or feature request as a new [Issue]. - For new issues, file your bug or feature request as a new [issue].
- For help and questions about using this project, we have a Gitter room which you can join below. - For help, discussion, and support questions about using this project, join or start a [discussion].
[![Join the chat][chat-badge]][chat]
If you have any problems with the [PSRule][engine] engine, please check the project GitHub [issues](https://github.com/Microsoft/PSRule/issues) page instead. If you have any problems with the [PSRule][engine] engine, please check the project GitHub [issues](https://github.com/Microsoft/PSRule/issues) page instead.
@ -23,8 +21,9 @@ Support for this project/ product is limited to the resources listed above.
### Using with GitHub Actions ### Using with GitHub Actions
1. See [Creating a workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file). 1. See [Creating a workflow file][create-workflow].
2. Reference `Microsoft/ps-rule` with `modules: 'PSRule.Rules.MSFT.OSS'` 2. Reference `Microsoft/ps-rule` with `modules: 'PSRule.Rules.MSFT.OSS'`
3. Optionally, set option `prerelease: true` to use a pre-release version.
For example: For example:
@ -51,8 +50,16 @@ jobs:
uses: Microsoft/ps-rule@main uses: Microsoft/ps-rule@main
with: with:
modules: 'PSRule.Rules.MSFT.OSS' modules: 'PSRule.Rules.MSFT.OSS'
prerelease: true
``` ```
## Manual install
This project is designed to be run through a continuous integration (CI) pipeline using GitHub Actions.
Additionally, this module can be manually installed from the [PowerShell Gallery][module].
For manual installation see [instructions][install].
## Changes and versioning ## Changes and versioning
Modules in this repository will use the [semantic versioning](http://semver.org/) model to declare breaking changes from v1.0.0. Modules in this repository will use the [semantic versioning](http://semver.org/) model to declare breaking changes from v1.0.0.
@ -83,9 +90,9 @@ or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any addi
This project is [licensed under the MIT License](LICENSE). This project is [licensed under the MIT License](LICENSE).
[issue]: https://github.com/Microsoft/PSRule.Rules.MSFT.OSS/issues [issue]: https://github.com/Microsoft/PSRule.Rules.MSFT.OSS/issues
[install]: docs/scenarios/install-instructions.md [discussion]: https://github.com/microsoft/PSRule.Rules.MSFT.OSS/discussions
[install]: docs/install-instructions.md
[ci-badge]: https://dev.azure.com/bewhite/PSRule.Rules.MSFT.OSS/_apis/build/status/PSRule.Rules.MSFT.OSS-CI?branchName=main [ci-badge]: https://dev.azure.com/bewhite/PSRule.Rules.MSFT.OSS/_apis/build/status/PSRule.Rules.MSFT.OSS-CI?branchName=main
[module]: https://www.powershellgallery.com/packages/PSRule.Rules.MSFT.OSS [module]: https://www.powershellgallery.com/packages/PSRule.Rules.MSFT.OSS
[engine]: https://github.com/Microsoft/PSRule [engine]: https://github.com/Microsoft/PSRule
[chat]: https://gitter.im/PSRule/PSRule.Rules.MSFT.OSS?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge [create-workflow]: https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file
[chat-badge]: https://img.shields.io/static/v1.svg?label=chat&message=on%20gitter&color=informational&logo=gitter

Просмотреть файл

@ -4,15 +4,13 @@
This project uses GitHub Issues to track bugs and feature requests. This project uses GitHub Issues to track bugs and feature requests.
Please search the existing issues before filing new issues to avoid duplicates. Please search the existing issues before filing new issues to avoid duplicates.
For new issues, file your bug or feature request as a new Issue.
For help and questions about using this project, we have a Gitter room which you can join below. - For new issues, file your bug or feature request as a new [issue].
- For help, discussion, and support questions about using this project, join or start a [discussion].
[![Join the chat][chat-badge]][chat]
## Microsoft Support Policy ## Microsoft Support Policy
Support for this project/ product is limited to the resources listed above. Support for this project/ product is limited to the resources listed above.
[chat]: https://gitter.im/PSRule/PSRule.Rules.MSFT.OSS?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge [issue]: https://github.com/microsoft/PSRule.Rules.MSFT.OSS/issues
[chat-badge]: https://img.shields.io/static/v1.svg?label=chat&message=on%20gitter&color=informational&logo=gitter [discussion]: https://github.com/microsoft/PSRule.Rules.MSFT.OSS/discussions