fix: Fixed Github Sensor example and minor doc correction (#2373)

Signed-off-by: Ramin Akhbari <[email protected]>
argoproj · Jan 17, 2023 · e2e6de2 · e2e6de2
1 parent 09acbd1
commit e2e6de2
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -67,7 +67,7 @@ Participation in the Argo Events project is governed by
 the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
 
 [Contributions](https://github.com/argoproj/argo-events/issues) are more than welcome, if you are interested take a look
-at our [Contributing Guidelines](./CONTRIBUTING.md).
+at our [Contributing Guidelines](./docs/CONTRIBUTING.md).
 
 ## License
 

diff --git a/examples/sensors/github.yaml b/examples/sensors/github.yaml
@@ -11,9 +11,9 @@ spec:
       eventName: example
       filters:
         data:
-          # Name of the event that triggered the delivery: [pull_request, push, yadayadayada]
+          # Type of Github event that triggered the delivery: [pull_request, push, issues, label, ...]
           # https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads
-          - path: header.X-Github-Event
+          - path: headers.X-Github-Event
             type: string
             value:
               - pull_request