first concepts page #198
first concepts page #198
Conversation
docs/concepts.md
Outdated
|
|
||
| To route events TriggerMesh makes use of the Knative eventing primitives (e.g Brokers, Channels, Triggers). | ||
|
|
||
| Each component of a Bridge can be defined using an API object available through the TriggerMesh platform or through Knative. |
There was a problem hiding this comment.
Do we usually communicate that the "TriggerMesh Platform" and "Knative" are two separate components, or that "TriggerMesh Platform" encompasses Knative, and everything else it depends on?
This is not a request for change, but I've seen both so it might be a good question to ask ourselves before merging.
There was a problem hiding this comment.
I think the TriggerMesh Platform encompasses Knative, because we extend Knative Eventing and Serving, but we should acknowledge where those primitives came from. That said, we don't want to send our users off to Knative documentation to learn things, so having redundant documentation where it makes sense is worthwhile.
There was a problem hiding this comment.
That is true. My comment was more on the highlighted sentence, "an API object available through TriggerMesh or Knative", which I was afraid may make them sound like two separate things.
docs/concepts.md
Outdated
| ## Source | ||
|  | ||
|
|
||
| TriggerMesh allows you to integrate applications (on-premises or cloud services) by defining event sources and targets which are seen as the start and the end of a so-called Bridge. While events flow through the Bridge they can undergo splitting, filtering and transformation. Transformation of events can be done declaratively or through a function. |
There was a problem hiding this comment.
Playing the role of a reader who's unfamiliar with TriggerMesh:
OK Transformations can be done declaratively or through a function. But the text also mentions "Splitting" and "Filtering". Can I do these either declaratively or via a function too?
I think it's a fair question to answer since the last sentence sounds over-focused on one particular aspect and onits the others completely.
docs/concepts.md
Outdated
|
|
||
| To route events TriggerMesh makes use of the Knative eventing primitives (e.g Brokers, Channels, Triggers). | ||
|
|
||
| Each component of a Bridge can be defined using an API object available through the TriggerMesh platform or through Knative. |
There was a problem hiding this comment.
Suggestion: we don't mention that the Bridges' topology can be rearranged, so newcomers might believe that what's depicted in the diagram is the only possible one.
Not sure where to add that, but to me it feels like a short mention of this could be beneficial to this page.
There was a problem hiding this comment.
I agree with this sentiment, I'll add some words that much simpler (or complex) topologies are supported
Co-authored-by: Antoine Cotten <hello@acotten.com>
Co-authored-by: Antoine Cotten <hello@acotten.com>
Co-authored-by: Antoine Cotten <hello@acotten.com>
Signed-off-by: Matt Ray <github@mattray.dev>
and Functions Signed-off-by: Matt Ray <github@mattray.dev>
Signed-off-by: Matt Ray <github@mattray.dev>
Signed-off-by: Matt Ray <github@mattray.dev>
|
@antoineco I overwrote a few of your edits but they're captured where applicable. I think we should revisit the Concepts later and put in more context for Knative concepts and terminology within TriggerMesh #208 |
|
i am fine merging this, because we need to do a few passes to get it right anyway |
|
I can't approve it because it is mine |
Everyone is welcome to chime in here.
This is just a start of what the
conceptspage could be. I am not set on anything specific, but we just need one.I am not sold on my diagram either.