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 a link to the source code in the documentation for any given linter rule #1115

Closed
anderseknert opened this issue Sep 18, 2024 · 0 comments · Fixed by #1144
Closed

Add a link to the source code in the documentation for any given linter rule #1115

anderseknert opened this issue Sep 18, 2024 · 0 comments · Fixed by #1144
Labels
documentation Improvements or additions to documentation

Comments

@anderseknert
Copy link
Member

Since Regal users are familiar with Rego, it would be a nice touch if we linked to the source code for any given rule in its documentation. This would help answer "how do they do that?", be a source of insipiration for writing custom rules, and perhaps shorten the path to contributing new built-in rules.
@anderseknert anderseknert added the documentation Improvements or additions to documentation label Sep 18, 2024
anderseknert added a commit that referenced this issue Sep 26, 2024
@anderseknert
Link to source code in rule docs
53b375a 
Fixes #1115

Signed-off-by: Anders Eknert <[email protected]>
anderseknert added a commit that referenced this issue Sep 26, 2024
@anderseknert
Link to source code in rule docs
5d21b47 
Fixes #1115

Signed-off-by: Anders Eknert <[email protected]>
@anderseknert anderseknert mentioned this issue Sep 26, 2024
Merged
anderseknert added a commit that referenced this issue Sep 26, 2024
@anderseknert
Link to source code in rule docs (#1144)
75db465 
Fixes #1115

Signed-off-by: Anders Eknert <[email protected]>
srenatus pushed a commit to srenatus/regal that referenced this issue Oct 1, 2024
@anderseknert @srenatus
Link to source code in rule docs (StyraInc#1144)
a3b3f47 
Fixes StyraInc#1115

Signed-off-by: Anders Eknert <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Link to source code in rule docs StyraInc/regal
1 participant
@anderseknert