Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sample App: Notification Service: camel slack sink #5888

Merged
merged 13 commits into from
Mar 15, 2024

Conversation

Leo6Leo
Copy link
Member

@Leo6Leo Leo6Leo commented Mar 4, 2024

Fixes #5887

Proposed Changes

  • Adding the yaml file that create the Camel Pipe, connecting the Knative Broker and the slack sink
  • Adding the documentation on how to deploy notification service

@knative-prow knative-prow bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Mar 4, 2024
@knative-prow knative-prow bot requested review from pmbanugo and skonto March 4, 2024 16:13
@knative-prow knative-prow bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 4, 2024
Copy link

netlify bot commented Mar 4, 2024

Deploy Preview for knative ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit e577254
🔍 Latest deploy log https://app.netlify.com/sites/knative/deploys/65f468307bfcc800085ef4c4
😎 Deploy Preview https://deploy-preview-5888--knative.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@knative-prow knative-prow bot requested review from Cali0707 and creydr March 4, 2024 16:18
@Leo6Leo Leo6Leo requested a review from matzew March 4, 2024 16:37
@Leo6Leo
Copy link
Member Author

Leo6Leo commented Mar 12, 2024

/cc @Cali0707

@Leo6Leo Leo6Leo requested a review from pierDipi March 12, 2024 19:17
Comment on lines 16 to 18
- The Camel K CLI (`kamel`) installed on your local machine.
- Apache Camel-Kamelets Version 4.4.x or later.
- A Slack workspace with the ability to create incoming webhooks. You can follow the link here to learn more about how to set up the slack workspace.
Copy link
Member

Choose a reason for hiding this comment

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

For these, if you are going to say they are prerequisites, people will try and look up how to do them before continuing. It looks like you explain installing Camel K right below, so maybe you can remove this from prerequisites and instead just explain the installation below? I know that you are talking about needing the Camel K CLI installed as well as Camel-Kamelets, but I think you can mention those in the installation below with links to docs on how to install them, or alternatively add those links on how to install into this prerequisites section

For me, prerequisites is more of a section where you outline things you already need before continuing, not things that you will learn about in the section

Copy link
Member Author

Choose a reason for hiding this comment

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

Sounds good, and I get your point. How does the new change I made look to you? I changed the structure a bit @Cali0707

Copy link
Member

@Cali0707 Cali0707 left a comment

Choose a reason for hiding this comment

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

Nice @Leo6Leo ! I think we can even simplify this a little by removing Prerequisites and just leaving the Install prerequisites section, otherwise LGTM!

Co-authored-by: Calum Murray <cmurray@redhat.com>
@Leo6Leo Leo6Leo requested a review from Cali0707 March 13, 2024 19:50
Comment on lines 1 to 20
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
name: slack-sink-pipe
spec:
source:
ref:
kind: Broker
apiVersion: eventing.knative.dev/v1
name: book-review-broker
properties:
type: new-review-comment
sink:
ref:
kind: Kamelet
apiVersion: camel.apache.org/v1
name: slack-sink
properties:
channel: “#bookstore-owner”
webhookUrl: <Your Slack Web Hook to the channel above>
Copy link
Member

Choose a reason for hiding this comment

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

@Leo6Leo what's the purpose of this file? Don't we have this same yaml in the README?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, it is the same content as the one in the README. I just have all the code in files as well, so readers can directly download all the code and run.

Copy link
Member

Choose a reason for hiding this comment

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

Could you update the content of this one then? It looks a little out of sync with the one in the readme

Copy link
Member Author

Choose a reason for hiding this comment

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

Great catch!! Thanks @Cali0707 ! I didn't realize that they are inconsistent.

@Leo6Leo Leo6Leo requested a review from Cali0707 March 15, 2024 15:24
Copy link
Member

@Cali0707 Cali0707 left a comment

Choose a reason for hiding this comment

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

/lgtm
/approve

thanks for all your work on this @Leo6Leo !

I guess once all the pieces for the sample app are finished, we can also go over everything once to make sure it works and makes sense

@knative-prow knative-prow bot added the lgtm Indicates that a PR is ready to be merged. label Mar 15, 2024
Copy link

knative-prow bot commented Mar 15, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Cali0707, Leo6Leo

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@knative-prow knative-prow bot merged commit b9474df into knative:main Mar 15, 2024
19 checks passed
prushh pushed a commit to prushh/docs that referenced this pull request Apr 30, 2024
* Adding the yaml file that create the Camel Pipe, connecting the Knative Broker and the slack sink

* Adding the first draft of the documentation for notification service

* Update the Camel-Kamelets Version

* Update the tutorial

* Fix the review comments by rearranging the sections, fix the wordings

* Compile the web pages

* Trying to add some styling

* Fix the styling

* Fix the styling

* Test how things look with modified code block

* Return to the original. Will do the web page compiling in another PR when the content is ready

* Update code-samples/eventing/bookstore-sample-app/slack-sink/README.md

Co-authored-by: Calum Murray <cmurray@redhat.com>

* Make the yaml file consistent with the one in the README file

---------

Co-authored-by: Calum Murray <cmurray@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Sample App: Notification Service: camel slack sink
2 participants