search

kedro-org / kedro-starters

Templates for your Kedro projects.
Apache License 2.0
64 stars 59 forks source link

Remove tutorial references from generated README files #211

Closed AhdraMeraliQB closed 8 months ago

AhdraMeraliQB commented 8 months ago

Motivation and Context

Context: https://github.com/kedro-org/kedro/issues/3433

READMEs for projects generated with kedro new and example code make unnecessary reference to the spaceflights tutorial. This PR removes these references from the README templates, but preserves mention of if Viz and PySpark tools were selected.

How has this been tested?

Checklist

DimedS commented 8 months ago

Do you mean that these references will be incorrect if the user selects the option 'example=False'?

AhdraMeraliQB commented 8 months ago

@DimedS

Do you mean that these references will be incorrect if the user selects the option 'example=False'?

No, if the user selects no example the project will be generated from the template on the Kedro Framework repo. This is to remove the references to the docs tutorials, as the users of kedro new with example code are not all following these tutorials - including these references for them is unhelpful. Additionally, if the user is following the docs tutorial, then they already have accessed the linked pages, so any benefit of keeping them is minimal.

DimedS commented 8 months ago

@DimedS

Do you mean that these references will be incorrect if the user selects the option 'example=False'?

No, if the user selects no example the project will be generated from the template on the Kedro Framework repo. This is to remove the references to the docs tutorials, as the users of kedro new with example code are not all following these tutorials - including these references for them is unhelpful. Additionally, if the user is following the docs tutorial, then they already have accessed the linked pages, so any benefit of keeping them is minimal.

I think that if the user selects example=false in conjunction with Viz or Spark, they will also receive that message. I agree with you; now, that reference seems unnecessary.