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

Add documentation for kedro run lifecycle #3482

Merged
merged 15 commits into from
Jan 15, 2024

Conversation

noklam
Copy link
Contributor

@noklam noklam commented Jan 4, 2024

Description

Add a diagram to explain the hook execution order and rearrange the hooks spec in docs to match the execution order.

Development notes

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

noklam and others added 2 commits January 3, 2024 16:52
Signed-off-by: Nok <nok.lam.chan@quantumblack.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
@noklam noklam linked an issue Jan 11, 2024 that may be closed by this pull request
Signed-off-by: Nok Lam Chan <nok.lam.chan@quantumblack.com>
Signed-off-by: Nok Lam Chan <nok.lam.chan@quantumblack.com>
Signed-off-by: Nok Lam Chan <nok.lam.chan@quantumblack.com>
Signed-off-by: Nok Lam Chan <nok.lam.chan@quantumblack.com>
Signed-off-by: Nok Lam Chan <nok.lam.chan@quantumblack.com>
Signed-off-by: Nok Lam Chan <nok.lam.chan@quantumblack.com>
Signed-off-by: Nok Lam Chan <nok.lam.chan@quantumblack.com>
@noklam noklam marked this pull request as ready for review January 12, 2024 17:20
@noklam noklam requested review from SajidAlamQB and ankatiyar and removed request for yetudada, merelcht and astrojuanlu January 12, 2024 17:21
Copy link
Contributor

@stichbury stichbury left a comment

Choose a reason for hiding this comment

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

This looks great to me, thanks! If you check the page, the background to the image is grey -- did you intend this? I really liked the use of the Kedro colour: nice attention to detail!

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.

Thanks @noklam!

noklam and others added 2 commits January 15, 2024 12:04
Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com>
Signed-off-by: Nok Lam Chan <nok.lam.chan@quantumblack.com>
@noklam
Copy link
Contributor Author

noklam commented Jan 15, 2024

I have update the image to a white background.

@noklam noklam enabled auto-merge (squash) January 15, 2024 12:05
….com:kedro-org/kedro into noklam/document-the-kedro-run-lifecycle-1718
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.

I love having a diagram, finally! Added a couple of comments.

Other than that, in terms of structure I find this navigation structure a bit weird:

image

And also the fact that the page is titled "Hooks" but the URL is "introduction" could have SEO implications @stichbury?

(I know this problem was not introduced by this PR, but since I looked at the overall result, I wanted to flag it anyway)

docs/source/hooks/introduction.md Outdated Show resolved Hide resolved
@noklam noklam disabled auto-merge January 15, 2024 12:27
Retitle the page

Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
@stichbury
Copy link
Contributor

And also the fact that the page is titled "Hooks" but the URL is "introduction" could have SEO implications @stichbury?

I've retitled the page since I think it helps serve as a better indicator of what it's about if it includes the word "introduction" and "Hooks". Committed to this branch so nothing for you to do/check @noklam

Co-authored-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
Signed-off-by: Nok Lam Chan <nok.lam.chan@quantumblack.com>
@noklam noklam enabled auto-merge (squash) January 15, 2024 15:37
@noklam noklam merged commit 4c593ac into main Jan 15, 2024
11 checks passed
@noklam noklam deleted the noklam/document-the-kedro-run-lifecycle-1718 branch January 15, 2024 15:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document the kedro run lifecycle and hooks execution order
4 participants