Skip to content

Commit 6a582c9

Browse files
author
Kingdon Barrett
committed
fix bad links - Providers doc refer to 'events.md'
Another commit to go with: * fluxcd/source-controller#1200 Signed-off-by: Kingdon Barrett <kingdon@weave.works>
1 parent e760ef2 commit 6a582c9

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

docs/spec/v1beta2/providers.md

+19-19
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ The supported providers for [Git commit status updates](#git-commit-status-updat
144144
When `.spec.type` is set to `generic`, the controller will send an HTTP POST
145145
request to the provided [Address](#address).
146146

147-
The body of the request is a [JSON `Event` object](events.md#event-structure),
147+
The body of the request is a [JSON `Event` object](event.md#event-structure),
148148
for example:
149149

150150
```json
@@ -191,7 +191,7 @@ referenced Secret](#http-headers-example).
191191
##### Generic webhook with HMAC
192192
193193
When `.spec.type` is set to `generic-hmac`, the controller will send an HTTP
194-
POST request to the provided [Address](#address) for an [Event](events.md#event-structure),
194+
POST request to the provided [Address](#address) for an [Event](event.md#event-structure),
195195
while including an `X-Signature` HTTP header carrying the HMAC of the request
196196
body. The inclusion of the header allows the receiver to verify the
197197
authenticity and integrity of the request.
@@ -210,7 +210,7 @@ HMAC of the request body, encoded as a hexadecimal string.
210210
211211
while `<hash>` is the hex-encoded HMAC value.
212212
213-
The body of the request is a [JSON `Event` object](events.md#event-structure),
213+
The body of the request is a [JSON `Event` object](event.md#event-structure),
214214
as described in the [Generic webhook](#generic-webhook) section.
215215
216216
###### HMAC verification example
@@ -283,7 +283,7 @@ func handleRequest(w http.ResponseWriter, r *http.Request) {
283283
##### Slack
284284

285285
When `.spec.type` is set to `slack`, the controller will send a message for an
286-
[Event](events.md#event-structure) to the provided Slack API [Address](#address).
286+
[Event](event.md#event-structure) to the provided Slack API [Address](#address).
287287

288288
The Event will be formatted into a Slack message using an [Attachment](https://api.slack.com/reference/messaging/attachments),
289289
with the metadata attached as fields, and the involved object as author.
@@ -367,7 +367,7 @@ stringData:
367367
##### Microsoft Teams
368368

369369
When `.spec.type` is set to `msteams`, the controller will send a payload for
370-
an [Event](events.md#event-structure) to the provided Microsoft Teams [Address](#address).
370+
an [Event](event.md#event-structure) to the provided Microsoft Teams [Address](#address).
371371

372372
The Event will be formatted into a Microsoft Teams
373373
[connector message](https://learn.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/connectors-using#example-of-connector-message),
@@ -409,7 +409,7 @@ stringData:
409409
##### DataDog
410410

411411
When `.spec.type` is set to `datadog`, the controller will send a payload for
412-
an [Event](events.md#event-structure) to the provided DataDog API [Address](#address).
412+
an [Event](event.md#event-structure) to the provided DataDog API [Address](#address).
413413

414414
The Event will be formatted into a [DataDog Event](https://docs.datadoghq.com/api/latest/events/#post-an-event) and sent to the
415415
API endpoint of the provided DataDog [Address](#address).
@@ -465,7 +465,7 @@ spec:
465465
##### Discord
466466

467467
When `.spec.type` is set to `discord`, the controller will send a payload for
468-
an [Event](events.md#event-structure) to the provided Discord [Address](#address).
468+
an [Event](event.md#event-structure) to the provided Discord [Address](#address).
469469

470470
The Event will be formatted into a [Slack message](#slack) and send to the
471471
`/slack` endpoint of the provided Discord [Address](#address).
@@ -506,7 +506,7 @@ stringData:
506506
##### Sentry
507507
508508
When `.spec.type` is set to `sentry`, the controller will send a payload for
509-
an [Event](events.md#event-structure) to the provided Sentry [Address](#address).
509+
an [Event](event.md#event-structure) to the provided Sentry [Address](#address).
510510

511511
Depending on the `severity` of the Event, the controller will capture a [Sentry
512512
Event](https://develop.sentry.dev/sdk/event-payloads/)for `error`, or [Sentry
@@ -556,7 +556,7 @@ stringData:
556556
##### Telegram
557557

558558
When `.spec.type` is set to `telegram`, the controller will send a payload for
559-
an [Event](events.md#event-structure) to the provided Telegram [Address](#address).
559+
an [Event](event.md#event-structure) to the provided Telegram [Address](#address).
560560

561561
The Event will be formatted into a message string, with the metadata attached
562562
as a list of key-value pairs.
@@ -593,7 +593,7 @@ spec:
593593
##### Matrix
594594

595595
When `.spec.type` is set to `matrix`, the controller will send a payload for
596-
an [Event](events.md#event-structure) to the provided Matrix [Address](#address).
596+
an [Event](event.md#event-structure) to the provided Matrix [Address](#address).
597597

598598
The Event will be formatted into a message string, with the metadata attached
599599
as a list of key-value pairs, and send as a [`m.room.message` text event](https://spec.matrix.org/v1.3/client-server-api/#mroommessage)
@@ -628,7 +628,7 @@ spec:
628628
##### Lark
629629

630630
When `.spec.type` is set to `lark`, the controller will send a payload for
631-
an [Event](events.md#event-structure) to the provided Lark [Address](#address).
631+
an [Event](event.md#event-structure) to the provided Lark [Address](#address).
632632

633633
The Event will be formatted into a [Lark Message card](https://open.larksuite.com/document/ukTMukTMukTM/uczM3QjL3MzN04yNzcDN),
634634
with the metadata written to the message string.
@@ -665,7 +665,7 @@ stringData:
665665
##### Rocket
666666

667667
When `.spec.type` is set to `rocket`, the controller will send a payload for
668-
an [Event](events.md#event-structure) to the provided Rocket [Address](#address).
668+
an [Event](event.md#event-structure) to the provided Rocket [Address](#address).
669669

670670
The Event will be formatted into a [Slack message](#slack) and send as a
671671
payload the provided Rocket [Address](#address).
@@ -695,7 +695,7 @@ spec:
695695
##### Google Chat
696696

697697
When `.spec.type` is set to `googlechat`, the controller will send a payload for
698-
an [Event](events.md#event-structure) to the provided Google Chat [Address](#address).
698+
an [Event](event.md#event-structure) to the provided Google Chat [Address](#address).
699699

700700
The Event will be formatted into a [Google Chat card message](https://developers.google.com/chat/api/reference/rest/v1/cards-v1),
701701
with the metadata added as a list of [key-value pairs](https://developers.google.com/chat/api/reference/rest/v1/cards-v1#keyvalue)
@@ -733,7 +733,7 @@ stringData:
733733
##### Google Pub/Sub
734734

735735
When `.spec.type` is set to `googlepubsub`, the controller will publish the payload of
736-
an [Event](events.md#event-structure) on the Google Pub/Sub Topic ID provided in the
736+
an [Event](event.md#event-structure) on the Google Pub/Sub Topic ID provided in the
737737
[Channel](#channel) field, which must exist in the GCP Project ID provided in the
738738
[Address](#address) field.
739739

@@ -792,7 +792,7 @@ stringData:
792792
##### Opsgenie
793793

794794
When `.spec.type` is set to `opsgenie`, the controller will send a payload for
795-
an [Event](events.md#event-structure) to the provided Opsgenie [Address](#address).
795+
an [Event](event.md#event-structure) to the provided Opsgenie [Address](#address).
796796

797797
The Event will be formatted into a [Opsgenie alert](https://docs.opsgenie.com/docs/alert-api#section-create-alert-request),
798798
with the metadata added to the [`details` field](https://docs.opsgenie.com/docs/alert-api#create-alert)
@@ -833,7 +833,7 @@ stringData:
833833
##### PagerDuty
834834

835835
When `.spec.type` is set to `pagerduty`, the controller will send a payload for
836-
an [Event](events.md#event-structure) to the provided PagerDuty [Address](#address).
836+
an [Event](event.md#event-structure) to the provided PagerDuty [Address](#address).
837837

838838
The Event will be formatted into an [Event API v2](https://developer.pagerduty.com/api-reference/368ae3d938c9e-send-an-event-to-pager-duty) payload,
839839
triggering or resolving an incident depending on the event's `Severity`.
@@ -891,7 +891,7 @@ spec:
891891
##### Prometheus Alertmanager
892892

893893
When `.spec.type` is set to `alertmanager`, the controller will send a payload for
894-
an [Event](events.md#event-structure) to the provided Prometheus Alertmanager
894+
an [Event](event.md#event-structure) to the provided Prometheus Alertmanager
895895
[Address](#address).
896896

897897
The Event will be formatted into a `firing` [Prometheus Alertmanager
@@ -946,7 +946,7 @@ stringData:
946946
##### Webex
947947

948948
When `.spec.type` is set to `webex`, the controller will send a payload for
949-
an [Event](events.md#event-structure) to the provided Webex [Address](#address).
949+
an [Event](event.md#event-structure) to the provided Webex [Address](#address).
950950

951951
The Event will be formatted into a message string, with the metadata attached
952952
as a list of key-value pairs, and send as a [Webex message](https://developer.webex.com/docs/api/v1/messages/create-a-message).
@@ -1195,7 +1195,7 @@ for the selected repository. The `repository_dispatch` events can be used to tri
11951195
The request includes the `event_type` and `client_payload` fields:
11961196

11971197
- `event_type` is generated from the involved object in the format `{Kind}/{Name}.{Namespace}`.
1198-
- `client_payload` contains the [Flux event](events.md).
1198+
- `client_payload` contains the [Flux event](event.md).
11991199

12001200
### Setting up the GitHub dispatch provider
12011201

0 commit comments

Comments
 (0)