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

Add log enricher documentation #498

Merged
merged 1 commit into from
Jun 23, 2021

Conversation

saschagrunert
Copy link
Member

What type of PR is this?

/kind documentation

What this PR does / why we need it:

This patch adds log enricher documentation to the installation and usage
guide. It also reformats the headers to align with the new content.

Which issue(s) this PR fixes:

None

Does this PR have test?

None

Special notes for your reviewer:

None

Does this PR introduce a user-facing change?

Added log enricher documentation to installation-usage.md.

@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jun 23, 2021
@k8s-ci-robot k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jun 23, 2021
This patch adds log enricher documentation to the installation and usage
guide. It also reformats the headers to align with the new content.

Signed-off-by: Sascha Grunert <sgrunert@redhat.com>
@codecov-commenter
Copy link

Codecov Report

Merging #498 (b8ea519) into master (f454845) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #498   +/-   ##
=======================================
  Coverage   38.25%   38.25%           
=======================================
  Files          23       23           
  Lines        1200     1200           
=======================================
  Hits          459      459           
  Misses        726      726           
  Partials       15       15           

@saschagrunert
Copy link
Member Author

/test pull-security-profiles-operator-test-e2e

@k8s-ci-robot
Copy link
Contributor

@saschagrunert: The following test failed, say /retest to rerun all failed tests:

Test name Commit Details Rerun command
pull-security-profiles-operator-test-e2e b8ea519 link /test pull-security-profiles-operator-test-e2e

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

Copy link
Contributor

@jhrozek jhrozek left a comment

Choose a reason for hiding this comment

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

/lgtm
the documentation reads well to me.

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 23, 2021
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jhrozek, saschagrunert

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@jhrozek
Copy link
Contributor

jhrozek commented Jun 23, 2021

btw feel free to merge despite the test failing, there's no reason a patch for readme should be blocked by a test :-) (unless you want to debug the test...)

@saschagrunert saschagrunert merged commit 980a29e into kubernetes-sigs:master Jun 23, 2021
@saschagrunert saschagrunert deleted the enricher-docs branch June 23, 2021 14:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants