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 documentation template for new rules created with regal new #700

Closed
anderseknert opened this issue May 8, 2024 · 0 comments · Fixed by #715
Closed

Add documentation template for new rules created with regal new #700

anderseknert opened this issue May 8, 2024 · 0 comments · Fixed by #715
Labels
good first issue Good for newcomers tooling

Comments

@anderseknert
Copy link
Member

For built-in rules created with the regal new command, we currently add only the Rego files, and an entry in the default configuration. It would be nice if we also added the markdown file to document the rule, as this is currently done manually.
anderseknert added a commit that referenced this issue May 13, 2024
@anderseknert
Add docs as part of regal new rule command
ad1dd44 
Fixes #700

Signed-off-by: Anders Eknert <anders@styra.com>
@anderseknert anderseknert mentioned this issue May 13, 2024
Merged
anderseknert added a commit that referenced this issue May 14, 2024
@anderseknert
Add docs as part of regal new rule command (#715)
0b79d20 
Fixes #700

Signed-off-by: Anders Eknert <anders@styra.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers tooling
Projects
Regal
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add docs as part of regal new rule command StyraInc/regal
1 participant
@anderseknert