Add flowchart to explains the difference of bootstrap_project and configure_project
#3470
Conversation
b22533b
to
2b0e4b9
Compare
Signed-off-by: Nok Lam Chan <[email protected]>
2b0e4b9
to
c8eb23b
Compare
Signed-off-by: Nok Lam Chan <[email protected]>
| for the underlying **`KedroContext`**; if specified, this will update (and therefore take precedence over) parameters retrieved from the project configuration | ||
|
|
||
| ## `bootstrap_project` and `configure_project` | ||
| ```{image} ../meta/images/kedro-session-creation.png |
There was a problem hiding this comment.
Is there a reason for using this style of image rather than the ! []() markdown notation? Reason I ask is that it doesn't render on GitHub and I think it would help our readers to have visibility on the graphic here if possible (and you can add alt tags if you want them, so no need to use the rst image syntax -- AFAICT?).
There was a problem hiding this comment.
very good question! I don't have a good idea, it appears to me @astrojuanlu did something to all mermaid diagram with this new style. I also found it annoying it won't render in VSCode.
There was a problem hiding this comment.
Block-level images aren't really needed https://myst-parser.readthedocs.io/en/latest/syntax/images_and_figures.html#block-level-images I kept them for consistency, they can be turned into inline images
Signed-off-by: Nok Lam Chan <[email protected]>
Signed-off-by: Nok Lam Chan <[email protected]>
…ro-org/kedro into noklam/doc-bootstrap-project Signed-off-by: Nok Lam Chan <[email protected]>
Signed-off-by: Jo Stichbury <[email protected]>
Description
Add docs and flowchart to explain the difference of boostrap_project and configure_project
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-byline 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.mdfile