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

Jump to bottom

Add rule documentation #157

Closed
BernieWhite opened this issue May 28, 2019 · 0 comments · Fixed by #159
Closed

Add rule documentation #157

BernieWhite opened this issue May 28, 2019 · 0 comments · Fixed by #159
Assignees
@BernieWhite
Labels
enhancement New feature or request
Milestone
v0.6.0

Comments

@BernieWhite
Copy link
Member

BernieWhite commented May 28, 2019 •
edited
Loading

Currently rules have a way to define an inline description and a hint message to provide feedback to users on rules.

In both cases these options provide a limited experience for rule authors as well as rule consumers.

Also localisation #18 of rule information is hard to address.

Markdown is already used for PSRule module documentation (including many open source modules), and has wide support. This wide support also reaches into web platforms allowing authoring markdown in one place then dual deploy to modules and web. #147

Native support for shipping and reading markdown files as rule documentation will help solve some of these challenges.

Help should ideally be automatically detected for modules since it is more likely published modules has had help created for them.
@BernieWhite BernieWhite added the enhancement New feature or request label May 28, 2019
@BernieWhite BernieWhite self-assigned this May 28, 2019
@BernieWhite BernieWhite added this to the v0.6.0 milestone May 28, 2019
BernieWhite added a commit that referenced this issue May 30, 2019
@BernieWhite
Add Get-PSRuleHelp and online link #19 #147 #157
1c471c1
@BernieWhite BernieWhite mentioned this issue May 30, 2019
Merged
7 tasks
BernieWhite added a commit that referenced this issue Jun 2, 2019
@BernieWhite
Add markdown help #157 #18 #148 #147 (#159)
6844497 
- Added rule documentation, which allows additional rule information to be stored in markdown files. #157
- Rule documentation also adds culture support. #18
- Added annotations, which are non-indexed metadata stored in rule documentation. #148
- Annotations can contain a link to online version of the documentation. #147
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@BernieWhite BernieWhite

Labels
enhancement New feature or request
Projects
None yet
Milestone
v0.6.0
Development

Successfully merging a pull request may close this issue.

Add markdown help #157 #18 #148 #147 microsoft/PSRule
1 participant
@BernieWhite