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(report): fix reporting doc format #7671

Merged
merged 1 commit into from
Oct 8, 2024
Merged

Conversation

pbaumard
Copy link
Contributor

@pbaumard pbaumard commented Oct 8, 2024

Description

The list format is broken in https://aquasecurity.github.io/trivy/dev/docs/configuration/reporting/#sarif since an empty line is required before the list.

The markdown parser used for Trivy documentation is stricter than the one used by GitHub.

The list punctuation is also now more consistent in the document.

Related PRs

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).

The list format is broken in https://aquasecurity.github.io/trivy/dev/docs/configuration/reporting/#sarif
An empty line is required before the list.

The markdown parser used for Trivy documentation is stricter than the one used by Github.

The list punctuation is also now more consistent in the document.
@pbaumard pbaumard requested a review from knqyf263 as a code owner October 8, 2024 08:38
@knqyf263 knqyf263 added this pull request to the merge queue Oct 8, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Oct 8, 2024
@knqyf263 knqyf263 added this pull request to the merge queue Oct 8, 2024
Merged via the queue into aquasecurity:main with commit 55b5a7e Oct 8, 2024
7 checks passed
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.

2 participants