-
Notifications
You must be signed in to change notification settings - Fork 915
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
[Ready] Docs changes to remove pandas-iris
and update kedro new
flow in onboarding docs
#3317
Conversation
Signed-off-by: Jo Stichbury <[email protected]>
Signed-off-by: Jo Stichbury <[email protected]>
Signed-off-by: Jo Stichbury <[email protected]>
Signed-off-by: Jo Stichbury <[email protected]>
Some notes on what we need to do to complete this PR:
|
Signed-off-by: Jo Stichbury <[email protected]>
Signed-off-by: Jo Stichbury <[email protected]>
Signed-off-by: Jo Stichbury <[email protected]>
…edro into fix-starters-content
Signed-off-by: Jo Stichbury <[email protected]>
Signed-off-by: Jo Stichbury <[email protected]>
…edro into fix-starters-content
Signed-off-by: Jo Stichbury <[email protected]>
Signed-off-by: Jo Stichbury <[email protected]>
…edro into fix-starters-content
Signed-off-by: Jo Stichbury <[email protected]>
Signed-off-by: Jo Stichbury <[email protected]>
```bash | ||
kedro new --config=<path>/config.yml | ||
``` | ||
The configuration file must contain: | ||
|
||
- `output_dir` The path in which to create the project directory | ||
- `project_name` | ||
- `repo_name` | ||
- `python_package` |
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.
Add-ons are also configurable here - will double check what happens when they are omitted
Update: The process fails if they are omitted, consistent with the other attributes
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. I'll need some insight on how to include these so will await the changes on your branch for guidance.
Signed-off-by: Ahdra Merali <[email protected]>
Signed-off-by: Ahdra Merali <[email protected]>
Signed-off-by: Jo Stichbury <[email protected]>
Signed-off-by: Jo Stichbury <[email protected]>
…edro into fix-starters-content
I gave a look and looks okay! I see there are some parts yet to be written still |
Signed-off-by: Jo Stichbury <[email protected]>
Co-authored-by: Juan Luis Cano Rodríguez <[email protected]> Signed-off-by: Jo Stichbury <[email protected]>
Signed-off-by: Jo Stichbury <[email protected]>
Signed-off-by: Jo Stichbury <[email protected]>
…edro into fix-starters-content
This is ready for final review @astrojuanlu and @merelcht @amandakys The sections marked as "to do" will be covered by @AhdraMeraliQB and @SajidAlamQB in a separate PR (branched from this branch) here #3331 |
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.
Looks great! I've left some minor comments.
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.
Gave this a more thorough review. The content is fantastic - I have a few reservations about the overall structure of the starters
folder. I made some specific suggestions in the comments and opened some questions.
docs/source/starters/index.md
Outdated
@@ -0,0 +1,44 @@ | |||
# New project tools |
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.
It's weird that /starters/
is for "new project tools", /starters/starters.html
is for "starters", and /starters/new_project_tools.html
is for "configure a new project" (looking at the H1 of each page).
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.
And speaking specifically about this title, "new project tools" could be read as "tools for new projects" or "new thing called project tools", which was confusing to me at first. I bet we don't want to use the second meaning, given that the "new" tools will stop being new at some point...
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 think we should fix the naming in the upcoming PR from @AhdraMeraliQB which explicitly writes the content. I can't really guess at what to call the page right now, so that's a placeholder.
You're correct about the /starters
being an odd place for those tools but it's awkward to name the folder. Maybe "/project_creation
. Again, I'm pushing that to #3331 rather than resolving here.
I looked at the New Project Tools page and the Create a new Kedro project pages. I like the way the two pages link together, the Create a New Kedro Project page is now much clearer and flows well. On the New Project Tools page, would it be worth highlighting the On the Create a New Kedro Project. Would it worth having a section called |
Co-authored-by: Merel Theisen <[email protected]> Signed-off-by: Jo Stichbury <[email protected]>
Co-authored-by: Merel Theisen <[email protected]> Signed-off-by: Jo Stichbury <[email protected]>
Signed-off-by: Jo Stichbury <[email protected]>
Signed-off-by: Jo Stichbury <[email protected]>
…low in onboarding docs (#3317) * Revise link to notebook docs and remove unnecessary intro page Signed-off-by: Jo Stichbury <[email protected]> * Update starters content Signed-off-by: Jo Stichbury <[email protected]> * relocate starters content Signed-off-by: Jo Stichbury <[email protected]> * Added some changes for add-ons and some to do notes Signed-off-by: Jo Stichbury <[email protected]> * Some further fixes Signed-off-by: Jo Stichbury <[email protected]> * Move section about development version of Kedro Signed-off-by: Jo Stichbury <[email protected]> * Add text for new project Signed-off-by: Jo Stichbury <[email protected]> * Remove mention of pandas-iris where possible, replacing with alternative Signed-off-by: Jo Stichbury <[email protected]> * Fix linter errors Signed-off-by: Jo Stichbury <[email protected]> * Update new project docs Signed-off-by: Jo Stichbury <[email protected]> * Remove deprecated starters from architecture diagram Signed-off-by: Jo Stichbury <[email protected]> * Add warning for pandas-iris usage in generator section Signed-off-by: Jo Stichbury <[email protected]> * Further updates for instances of kedro new Signed-off-by: Jo Stichbury <[email protected]> * Remove TODO as no longer required Signed-off-by: Ahdra Merali <[email protected]> * Resolve some Vale issues and remove implication of tools + starters Signed-off-by: Jo Stichbury <[email protected]> * fixes to internal links Signed-off-by: Jo Stichbury <[email protected]> * pandas-spaceflights bad, spaceflights-pandas good Signed-off-by: Jo Stichbury <[email protected]> * fix cookiecutter docs urls Signed-off-by: Jo Stichbury <[email protected]> * Update the create a starter docs Signed-off-by: Jo Stichbury <[email protected]> * Fix link to avoid linkcheck barf Signed-off-by: Jo Stichbury <[email protected]> * Update docs/source/get_started/new_project.md Co-authored-by: Juan Luis Cano Rodríguez <[email protected]> Signed-off-by: Jo Stichbury <[email protected]> * Update following review Signed-off-by: Jo Stichbury <[email protected]> * Update content Signed-off-by: Jo Stichbury <[email protected]> * Update docs/source/nodes_and_pipelines/nodes.md Co-authored-by: Merel Theisen <[email protected]> Signed-off-by: Jo Stichbury <[email protected]> * Update docs/source/starters/starters.md Co-authored-by: Merel Theisen <[email protected]> Signed-off-by: Jo Stichbury <[email protected]> * Update FAQ Signed-off-by: Jo Stichbury <[email protected]> * Updates following review Signed-off-by: Jo Stichbury <[email protected]> --------- Signed-off-by: Jo Stichbury <[email protected]> Signed-off-by: Ahdra Merali <[email protected]> Co-authored-by: Ahdra Merali <[email protected]> Co-authored-by: Ahdra Merali <[email protected]> Co-authored-by: Juan Luis Cano Rodríguez <[email protected]> Co-authored-by: Merel Theisen <[email protected]> Signed-off-by: Jo Stichbury <[email protected]>
Description
To address #3048 by updating the new project creation flow.
Ready for first review by @amandakys.
PREVIEW CODE IS BUILT HERE
Development notes
I have updated the new project text but have also:
pandas-iris
Still to come
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