Skip to content

Commit

Permalink
Links at their proper place
Browse files Browse the repository at this point in the history
  • Loading branch information
Sajiyah-Salat committed May 15, 2023
1 parent d678684 commit 9d76137
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions docs/book/src/reference/creating-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ Event(object runtime.Object, eventtype, reason, message string)
```

- `object` is the object this event is about.
- `eventtype` is this event type, and is either *Normal* or *Warning*.
- `reason` is the reason this event is generated. It should be short and unique with `UpperCamelCase` format. The value could appear in *switch* statements by automation.
- `message` is intended to be consumed by humans.
More [info](https://github.com/kubernetes/api/blob/6c11c9e4685cc62e4ddc8d4aaa824c46150c9148/core/v1/types.go#L6019-L6024):
- `eventtype` is this event type, and is either *Normal* or *Warning*. [More info][Event-Example]
- `reason` is the reason this event is generated. It should be short and unique with `UpperCamelCase` format. The value could appear in *switch* statements by automation. [More info][[Reason-Example]]
- `message` is intended to be consumed by humans. [More info][Message-Example]



<aside class="note">
Expand Down Expand Up @@ -71,3 +71,6 @@ And then, run `$ make manifests` to update the rules under `config/rbac/rule.yam
[Events]: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#events
[Event-Example]: https://github.com/kubernetes/api/blob/6c11c9e4685cc62e4ddc8d4aaa824c46150c9148/core/v1/types.go#L6019-L6024
[Reason-Example]: https://github.com/kubernetes/api/blob/6c11c9e4685cc62e4ddc8d4aaa824c46150c9148/core/v1/types.go#L6048
[Message-Example]: https://github.com/kubernetes/api/blob/6c11c9e4685cc62e4ddc8d4aaa824c46150c9148/core/v1/types.go#L6053

0 comments on commit 9d76137

Please sign in to comment.