Skip to content

Removed the Go path link from the ./eventing/event-delivery.md#3321

Merged
knative-prow-robot merged 3 commits into
knative:mainfrom
Yashks1994:update-event-delivery
Mar 17, 2021
Merged

Removed the Go path link from the ./eventing/event-delivery.md#3321
knative-prow-robot merged 3 commits into
knative:mainfrom
Yashks1994:update-event-delivery

Conversation

@Yashks1994
Copy link
Copy Markdown
Contributor

Fixes #3309 - Remove links to Go code

Proposed Changes

  • Removed the Go path link for Delivery Spec
  • Removed the Go path link for Destination

@google-cla google-cla Bot added the cla: yes Indicates the PR's author has signed the CLA. label Mar 7, 2021
@knative-prow-robot knative-prow-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Mar 7, 2021
@knative-prow-robot
Copy link
Copy Markdown
Contributor

Hi @Yashks1994. Thanks for your PR.

I'm waiting for a knative member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

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.

@knative-prow-robot knative-prow-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Mar 7, 2021
Base automatically changed from master to main March 8, 2021 17:41
Comment thread docs/eventing/event-delivery.md Outdated
## Common Delivery Parameters

The `delivery` value must be a [Delivery Spec](https://pkg.go.dev/knative.dev/eventing/pkg/apis/duck/v1?tab=doc#DeliverySpec)
The `delivery` value must be a Delivery Spec.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
The `delivery` value must be a Delivery Spec.
The `delivery` value must be a Delivery Spec, which is a partial schema that is embedded in resources like `Broker`, `Trigger` and `Subscription`.
```yaml
# DeadLetterSink is the sink receiving event that could not be sent to
# a destination.
deadLetterSink:
ref:
apiVersion: v1
kind: Service
name: my-service
uri: /my-path
# Retry is the minimum number of retries the sender should attempt when
# sending an event before moving it to the dead letter sink.
retry: 5
// BackoffPolicy is the retry backoff policy (linear, exponential).
backoffPolicy: exponential
# BackoffDelay is the delay before retrying.
# More information on Duration format:
# - https://www.iso.org/iso-8601-date-and-time-format.html
# - https://en.wikipedia.org/wiki/ISO_8601
#
# For linear policy, backoff delay is backoffDelay*<numberOfRetries>.
# For exponential policy, backoff delay is backoffDelay*2^<numberOfRetries>.
backoffDelay: PT2S```

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done

In case of failure, the event is dropped and an error is logged into the system.

The `deadLetterSink` value must be a [Destination](https://pkg.go.dev/knative.dev/pkg/apis/duck/v1#Destination).
The `deadLetterSink` value must be a Destination.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Can you update the example below (line 87) by replacing <Destination> with the below YAML?

# DeadLetterSink is the sink receiving event that could not be sent to
# a destination.
deadLetterSink:
  ref:
    apiVersion: v1
    kind: Service
    name: my-service
  uri: /my-path

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Removed the existing yaml with the new one.

@knative-prow-robot knative-prow-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Mar 11, 2021
Copy link
Copy Markdown
Member

@pierDipi pierDipi left a comment

Choose a reason for hiding this comment

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

/lgtm

@knative-prow-robot knative-prow-robot added the lgtm Indicates that a PR is ready to be merged. label Mar 15, 2021
@Yashks1994
Copy link
Copy Markdown
Contributor Author

/assign @grantr

@abrennan89
Copy link
Copy Markdown
Contributor

/approve

@abrennan89 abrennan89 added this to the v0.22.0 milestone Mar 17, 2021
@knative-prow-robot
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: abrennan89, pierDipi

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

The pull request process is described here

Details 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla: yes Indicates the PR's author has signed the CLA. lgtm Indicates that a PR is ready to be merged. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Remove links to Go code

5 participants