Document life of a connection and event flow #233
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
daabr
approved these changes
May 2, 2024
| @@ -0,0 +1,19 @@ | |||
| # Life of a Connection | |||
There was a problem hiding this comment.
General comments:
- I think this belongs in https://docs.autokitteh.com/concepts/connection
- "Life of a" titles carry some credibility with Googlers and Xooglers, but other than that... Meh...
- A few English nits, not important right now
| - **Name**, this is used to reference the connection in code and configuration | ||
| - **Integration** that this connection is representing | ||
| - **Project** that this connection serves | ||
| 2. Most connections need to be configured. The configuration is persisted as **Connection Variables**. These are very much like environment variables, but resided in a scope of a specific connection. This is done using the _Vars_ service. The variables can be set either automatically by the integration, using the UI or manually by the user via APIs. One example of such configuration is OAuth flow, described below. |
There was a problem hiding this comment.
This is done using the Vars service.
"Service"? Maybe "section"?
|
|
||
| ## OAuth | ||
|
|
||
| Some connections require OAuth authentication in order to function. Autokitteh provides an _OAuth_ service that knows the steps of the OAuth dance. |
There was a problem hiding this comment.
- This is not the docs repo, but still... IIRC, we agreed to use "AutoKitteh" in docs?
- This is a problematic section, it's useful for me but I think it's more confusing than explanatory for the average reader, but we can fix this later when we transition this to the docs repo.
| @@ -0,0 +1,9 @@ | |||
| # Life of an Event | |||
|
|
|||
| 1. For example, an external provider sends some data to an integration. | |||
There was a problem hiding this comment.
Suggested change
| 1. For example, an external provider sends some data to an integration. | |
| 1. An external provider sends data to an integration asynchronously. |
| @@ -0,0 +1,9 @@ | |||
| # Life of an Event | |||
There was a problem hiding this comment.
This page would benefit a lot from a flow diagram below the steps. You can create one with markdown - both in GH and Docusaurus I think.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.