-
Notifications
You must be signed in to change notification settings - Fork 903
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
Conversation
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.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>
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.
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!
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.
Thanks @noklam!
Co-authored-by: Jo Stichbury <jo_stichbury@mckinsey.com> Signed-off-by: Nok Lam Chan <nok.lam.chan@quantumblack.com>
I have update the image to a white background. |
….com:kedro-org/kedro into noklam/document-the-kedro-run-lifecycle-1718
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 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:
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)
Retitle the page Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
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>
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
RELEASE.md
file