Skip to content
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

Merged
merged 8 commits into from
Nov 25, 2024
Merged

Conversation

merelcht
Copy link
Member

@merelcht merelcht commented Nov 19, 2024

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

  • Read the contributing guidelines
  • Signed off each commit with a Developer Certificate of Origin (DCO)
  • Opened this PR as a 'Draft Pull Request' if it is work-in-progress
  • Updated the documentation to reflect the code changes
  • Added a description of this change in the RELEASE.md file
  • Added tests to cover my changes
  • Checked if this change will affect Kedro-Viz, and if so, communicated that with the Viz team

@merelcht merelcht marked this pull request as ready for review November 19, 2024 17:33
@merelcht merelcht self-assigned this Nov 19, 2024
@merelcht merelcht requested review from noklam and ankatiyar and removed request for astrojuanlu and yetudada November 21, 2024 13:06
Copy link
Member

@astrojuanlu astrojuanlu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@merelcht
Copy link
Member Author

merelcht commented Nov 21, 2024

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

participant env as Environment variables
participant ipython as IPython
participant entrypoint as ipython/__init__.py <br> reload_kedro
participant hook_manager as Hook manager
Copy link
Contributor

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"]
Copy link
Contributor

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.

Copy link
Member Author

@merelcht merelcht Nov 22, 2024

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh TIL! Thanks!

@astrojuanlu
Copy link
Member

Sorry I got confused 👍🏼 Thanks!

Signed-off-by: Merel Theisen <[email protected]>
Copy link
Contributor

@ankatiyar ankatiyar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Copy link
Contributor

@ElenaKhaustova ElenaKhaustova left a 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.

docs/diagrams/installed-kedro-project.md Outdated Show resolved Hide resolved
Co-authored-by: ElenaKhaustova <[email protected]>
Signed-off-by: Merel Theisen <[email protected]>
@merelcht merelcht enabled auto-merge (squash) November 25, 2024 10:21
@merelcht merelcht merged commit dfa0b79 into main Nov 25, 2024
10 checks passed
@merelcht merelcht deleted the update-diagrams branch November 25, 2024 10:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants