-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
[CT-2114] In-repo documentation (readmes): architecture/sequence diagram of core execution flow #6969
Comments
@jtcohen6 As part of backlog grooming, we aren't going to point this issue as there is no acceptance criteria and are not sure what the work to be done is. Outstanding questions
|
@stu-k Good questions, thanks for asking them!
This is not intended for the average end user of dbt. The target audience is:
A README in this repository
@dbt-labs/core-execution !
I'd leave that for the Core-Execution team to determine. It might inform implementation decisions about which tool to use, and how to keep it up-to-date. As I said in the issue description, I don't think this is something we should be auto-generating from code; we could look to define it using code that lives in this repo, but I'd also be happy with a Lucid diagram. |
To make the point more strongly — IMO these are medium/high-priority exit criteria for Phase 2 of API-ification:
|
We're going to call this a spike with the assumption that the output is some sort of diagram that depicts the |
I'm envisioning a diagram that includes:
Is this a "flow diagram" or a "sequence diagram"? I didn't even realize that these are different things, but plenty of people have thought about this in more depth than I have.
I don't think we should aim to auto-generate this. It should be one level higher than specific methods / codepaths. Rather, this should instruct & inform on the patterns we're seeking to actualize in our execution APIs.
Potential inspiration (internal Notion docs / diagrams from 2021!):
Out of scope for this: flow/sequence diagram that breaks down parsing. This is also important, but for the sake of core's execution flow, parsing can be understood as a single step with clear inputs & outputs.
The text was updated successfully, but these errors were encountered: