-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Conversation
✅ Deploy Preview for knative ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
/cc @Cali0707 |
- 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. |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
code-samples/eventing/bookstore-sample-app/slack-sink/README.md
Outdated
Show resolved
Hide resolved
code-samples/eventing/bookstore-sample-app/slack-sink/README.md
Outdated
Show resolved
Hide resolved
code-samples/eventing/bookstore-sample-app/slack-sink/README.md
Outdated
Show resolved
Hide resolved
…when the content is ready
There was a problem hiding this 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!
code-samples/eventing/bookstore-sample-app/slack-sink/README.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Calum Murray <cmurray@redhat.com>
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> |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
There was a problem hiding this 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
[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 |
* 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>
Fixes #5887
Proposed Changes