-
Notifications
You must be signed in to change notification settings - Fork 906
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 documentation to reflect the new kedro new
add-ons flow
#3048
Comments
There are a couple placeholders in the files as well - make sure to do a search and replace the |
@stichbury can give a more informed opinion in a few days, but maybe if we were to start writing these docs, shall we put them under https://docs.kedro.org/en/stable/kedro_project_setup/? For example |
I don't think something as significant should go into |
Good point, I hadn't realized that was listed under "Advanced". But that's where the starters are explained, so I thought it would be the natural place. Feel free to suggest otherwise. |
Yeah I think https://docs.kedro.org/en/stable/kedro_project_setup/starters.html needs to be split into two:
The add-ons work goes with the first item, except where it is even more basic on-boarding content that describes how to make a first project etc. Update: This branch has the starter (pun intended) of this split and should be used as the basis for the additions for add-ons content. |
Sounds perfect to me 👍🏽 |
This needs engineering input, so tagging/assigning the engineers who have done most of the add-ons work so far to help out with this @noklam @SajidAlamQB @AhdraMeraliQB @lrcouto @DimedS. |
I have now created a PR which has marked where changes are necessary to address the add-ons flow changes. Please can I pass this to one or more of @noklam @SajidAlamQB @AhdraMeraliQB @lrcouto @DimedS (as noted by @merelcht) to do a pass over the docs. Look for comments notes in the following:
|
Closed by #3331 |
Apologies for the delayed response. New docs section looks really great 👍 . |
Description
Make sure any references to
kedro new
are updated in accordance with the new changes. Additionally a section should be added detailing this new flow, what it means to users, and how to use it (in CLI and via config file).These docs should mention all add-ons added in the tickets:
kedro new
CLI command #2850pyspark
to add-ons options #3073kedro-viz
to add-ons options #3074The text was updated successfully, but these errors were encountered: