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

doc: add comments for each field in the SecurityViolationEvent proto definition #325

Merged
merged 1 commit into from
Jun 8, 2023

Conversation

mohamed-gougam
Copy link
Contributor

Proposed changes

Add documentation about each of the fields in the SecurityViolationEvent message.

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING document
  • I have run make install-tools and have attached any dependency changes to this pull request
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • If applicable, I have checked that any relevant tests pass after adding my changes
  • If applicable, I have updated any relevant documentation (README.md)
  • If applicable, I have tested my cross-platform changes on Ubuntu 22, Redhat 8, SUSE 15 and FreeBSD 13

@netlify
Copy link

netlify bot commented May 31, 2023

Deploy Preview for agent-public-docs canceled.

Name Link
🔨 Latest commit 911c5ee
🔍 Latest deploy log https://app.netlify.com/sites/agent-public-docs/deploys/6479eb141ac08e0008a616cb

@github-actions github-actions bot added chore Pull requests for routine tasks dependencies documentation Improvements or additions to documentation labels May 31, 2023
docs/proto/events.md Outdated Show resolved Hide resolved
docs/proto/events.md Outdated Show resolved Hide resolved
docs/proto/events.md Outdated Show resolved Hide resolved
docs/proto/events.md Outdated Show resolved Hide resolved
docs/proto/events.md Outdated Show resolved Hide resolved
docs/proto/events.md Outdated Show resolved Hide resolved
docs/proto/events.md Outdated Show resolved Hide resolved
docs/proto/events.md Outdated Show resolved Hide resolved
@Dean-Coakley Dean-Coakley changed the title doc: add comments for each field in the ScecurityViolationEvent proto definition doc: add comments for each field in the SecurityViolationEvent proto definition Jun 1, 2023
Copy link
Contributor

@Dean-Coakley Dean-Coakley left a comment

Choose a reason for hiding this comment

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

This change seems to be missing: #325 (comment)

@sanathkumarbs
Copy link
Contributor

LGTM, thank you!

docs/proto/events.md Outdated Show resolved Hide resolved
docs/proto/events.md Outdated Show resolved Hide resolved
@mohamed-gougam
Copy link
Contributor Author

This change seems to be missing: #325 (comment)

Thanks for the catch

@Dean-Coakley Dean-Coakley merged commit f8f8079 into main Jun 8, 2023
27 checks passed
@Dean-Coakley Dean-Coakley deleted the nap-monitoring-add-proto-doc branch June 8, 2023 09:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Pull requests for routine tasks dependencies documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants