📖 Raising event doc page created #3450
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
k8s-ci-robot
added
the
cncf-cla: yes
k8s-ci-robot
added
the
size/L
Sajiyah-Salat
changed the title
|
Looks like perfect to merge, But why its failing WDYT? |
| ``` | ||
|
|
||
| ### Allowing usage of EventRecorder on the Controller | ||
| To raise an event, you must have access to `record.EventRecorder` in the Controller. Therefore, firstly let's update the controller implementation: |
There was a problem hiding this comment.
Nit: space between title and text.
| Recorder record.EventRecorder | ||
| } | ||
| ### Passing the EventRecorder to the Controller | ||
| Events are published from a Controller using an [EventRecorder]`type CorrelatorOptions struct`, |
| ## How to be able to raise Events? | ||
|
|
||
| Following are the steps with examples to help you raise events in your controller's reconciliations. | ||
| Events are published from a Controller using an [EventRecorder]`type CorrelatorOptions struct`, |
There was a problem hiding this comment.
Should I add this or any other link
camilamacedo86
approved these changes
Jun 13, 2023
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: camilamacedo86, Sajiyah-Salat 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 |
k8s-ci-robot
added
the
approved
|
sorry for issues I will make changes as soon as possible |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description: Add the documentation to help out users know how to implement and raise events.
NOTE: we had this document in v1 docs but it is outdated and we are shaping it accordingly.
This is #3375 original pr but during squashing commits I messed up the original file and this is backup.