-
Notifications
You must be signed in to change notification settings - Fork 916
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
Update mermaid entrypoint diagrams with current state #4339
Conversation
Signed-off-by: Merel Theisen <[email protected]>
Signed-off-by: Merel Theisen <[email protected]>
Signed-off-by: Merel Theisen <[email protected]>
Signed-off-by: Merel Theisen <[email protected]>
Signed-off-by: Merel Theisen <[email protected]>
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.
We need to re-render them right? https://github.com/kedro-org/kedro/wiki/Render-Mermaid-diagrams
Do we? These are not inside the docs. Last time I also just added them like this. If you open the file you'll see the rendered diagram: https://github.com/kedro-org/kedro/blob/602bc26b98ca03994ce7a85b85ef3a874cc233e5/docs/diagrams/installed-kedro-project.md |
docs/diagrams/kedro-ipython.md
Outdated
participant env as Environment variables | ||
participant ipython as IPython | ||
participant entrypoint as ipython/__init__.py <br> reload_kedro | ||
participant hook_manager as Hook manager |
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.
Seems like hook manager is not connected to anything in this diagram and can be removed?
participant click as "Click" | ||
participant kedro as $ kedro | ||
participant entrypoint as pyproject.toml <br> kedro = "kedro.framework.cli:main" | ||
participant init_plugins as Kedro Plugins <br> [project.entry-points."kedro.init"] |
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.
Is this a valid entrypoint? I was trying to find info on it but I couldn't.
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.
I took me a while to figure this out as well. It's part of the entrypoint groups:
ENTRY_POINT_GROUPS = {
"global": "kedro.global_commands",
"project": "kedro.project_commands",
"init": "kedro.init",
"line_magic": "kedro.line_magic",
"hooks": "kedro.hooks",
"cli_hooks": "kedro.cli_hooks",
"starters": "kedro.starters",
}
It's used to initialise plugins: https://github.com/kedro-org/kedro/blob/main/kedro/framework/cli/cli.py#L121 which is called when kedro.framework.cli:main
is used as entrypoint.
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.
Oh TIL! Thanks!
Sorry I got confused 👍🏼 Thanks! |
Signed-off-by: Merel Theisen <[email protected]>
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!
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.
Thank you, @merelcht!
Left one neat comment.
Co-authored-by: ElenaKhaustova <[email protected]> Signed-off-by: Merel Theisen <[email protected]>
Description
Follow up on #4013
Changed all diagrams in
docs/diagrams
to be up to date with the current flows.Developer Certificate of Origin
We need all contributions to comply with the Developer Certificate of Origin (DCO). All commits must be signed off by including a
Signed-off-by
line in the commit message. See our wiki for guidance.If your PR is blocked due to unsigned commits, then you must follow the instructions under "Rebase the branch" on the GitHub Checks page for your PR. This will retroactively add the sign-off to all unsigned commits and allow the DCO check to pass.
Checklist
RELEASE.md
file