Update kedro new
hint and docs to clarify how to provide a project tools selection to --tools
#3735
Milestone
kedro new
hint and docs to clarify how to provide a project tools selection to --tools
#3735
Description
There is a discrepancy in how we specify the project tools selection through the CLI (shorthand names) VS through the interactive flow (a numbered selection). However, when we suggest using the CLI flag
--tools
after the interactive flow, there is no acknowledgement of this discrepancy, which could cause potential confusion.The hint currently reads:
To skip the interactive flow you can run kedro new with
kedro new --name=<your-project-name> --tools=<your-project-tools> --example=<yes/no>
Instead,
--tools=<your-project-tools>
should provide information on the format to use, perhaps something like--tools=<lint/test/log/data/docs/pyspark/viz>
? CC @iamelijahko @stephkaiser for opinionsThis page in the docs will also need updating: https://docs.kedro.org/en/latest/get_started/new_project.html#project-tools
Context
When you run
kedro new
you'll seeAnd tools need to be chosen through the number. But if you do
kedro new --tools=...
the tools need to be chosen through the short name.Note
This will be a combined design & engineering task
The text was updated successfully, but these errors were encountered: