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.

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

docs: fix links to OPA docs #6480

Merged
merged 2 commits into from
Apr 12, 2024
Merged

docs: fix links to OPA docs #6480

merged 2 commits into from
Apr 12, 2024

Conversation

nikpivkin
Copy link
Contributor

Description

Checklist

  • I've read the guidelines for contributing to this repository.
  • I've followed the conventions in the PR title.
  • I've added tests that prove my fix is effective or that my feature works.
  • I've updated the documentation with the relevant information (if needed).
  • I've added usage information (if the PR introduces new options)
  • I've included a "before" and "after" example to the description (if the PR is a user interface change).

@nikpivkin nikpivkin marked this pull request as ready for review April 10, 2024 13:28
@nikpivkin nikpivkin requested a review from simar7 as a code owner April 10, 2024 13:28
@@ -103,7 +103,7 @@ Any package prefixes such as `main` and `user` are allowed.
### Metadata
Metadata helps enrich Trivy's scan results with useful information.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank for this. I know it's unrelated to your change, but this sentence popped out to me. it makes metadata seem like an optional addition and also fails to explain the purpose. so while we're here could you please fix it to:

The policy must contain a [Rego Metadata](https://www.openpolicyagent.org/docs/latest/policy-language/#metadata) section. Trivy uses standard rego metadata to define the new policy and general information about it.

I used policy in accordance with the rest of the doc, when we rename to check we can do it at once.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done 0757a4f

@nikpivkin nikpivkin requested a review from knqyf263 as a code owner April 12, 2024 14:40
@nikpivkin
Copy link
Contributor Author

I also fixed the link to ORAS CLI, so as not to open a separate PR for such a small fix.

@simar7 simar7 added this pull request to the merge queue Apr 12, 2024
Merged via the queue into main with commit 183eaaf Apr 12, 2024
11 checks passed
@simar7 simar7 deleted the opa-links branch April 12, 2024 20:23
fl0pp5 pushed a commit to altlinux/trivy that referenced this pull request May 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants